org.jdiameter.api
Interface Avp

All Superinterfaces:

java.io.Serializable, Wrapper

public interface Avp
extends Wrapper, java.io.Serializable

The Avp class implements a Diameter AVP. This class allows applications to build and read arbitrary Diameter AVP objects. Wrapper interface allows adapt message to any driver vendor specific interface Serializable interface allows use this class in SLEE Event objects

Version:

1.5.1 Final

Field Summary

static int	ACC_MULTI_SESSION_ID The Accouting-Multi-Session-Id avp code
static int	ACC_RECORD_NUMBER The Accouting-Record-Number avp code
static int	ACC_RECORD_TYPE The Accouting-Record-Type avp code
static int	ACC_SESSION_ID The Accouting-Session-Id avp code
static int	ACC_SUB_SESSION_ID The Accouting-Sub-Session-Id avp code
static int	ACCOUNTING_REALTIME_REQUIRED The Accounting-Realtime-required avp code
static int	ACCT_APPLICATION_ID The Accounting-Application-Id avp code
static int	ACCT_INTERIM_INTERVAL The Acct-Interim-Interval avp code
static int	AUTH_APPLICATION_ID The Authentication-Application-Id avp code
static int	AUTH_GRACE_PERIOD The Auth-Grace-Period avp code
static int	AUTH_REQUEST_TYPE The Auth-Request-Type avp code
static int	AUTH_SESSION_STATE The Auth-Session-State avp code
static int	AUTHORIZATION_LIFETIME The Authorization-Lifetime avp code
static int	CLASS The Class avp code
static int	DESTINATION_HOST The Destination-Host avp code
static int	DESTINATION_REALM The Destination-Realm avp code
static int	DISCONNECT_CAUSE The Disconnect cause avp code
static int	E2E_SEQUENCE_AVP The E2E-Sequence-Avp avp code
static int	ERROR_MESSAGE The Error-Message avp code
static int	ERROR_REPORTING_HOST The Error-reporting-host avp code
static int	EVENT_TIMESTAMP The Event-Timestamp avp code
static int	EXPERIMENTAL_RESULT Experemental-Result avp code
static int	EXPERIMENTAL_RESULT_CODE The Experimental-Result-Code avp code
static int	FAILED_AVP The File-Avp avp code
static int	FIRMWARE_REVISION The FirmWare-Revision avp code
static int	HOST_IP_ADDRESS The Host-IP-Address avp code
static int	INBAND_SECURITY_ID The Inband-Security-Id avp code
static int	MULTI_ROUND_TIMEOUT The Muti-Round-Timeout avp code
static int	ORIGIN_HOST The Origin-Host avp code
static int	ORIGIN_REALM The Origin-Realm avp code
static int	ORIGIN_STATE_ID The Origin-State-Id avp code
static int	PRODUCT_NAME The Product-Name avp code
static int	PROXY_HOST The Proxy-Host avp code
static int	PROXY_INFO The Proxy-Info avp code
static int	PROXY_STATE The Proxy-State avp code
static int	RE_AUTH_REQUEST_TYPE The Re-Authentication-Request-type avp code
static int	REDIRECT_HOST The Rediect-Host avp code
static int	REDIRECT_HOST_USAGE The Redirect-Host-Usage avp code
static int	REDIRECT_MAX_CACHE_TIME The Redirect-Max-Cache-Time avp code
static int	RESULT_CODE The Result-Code avp code
static int	ROUTE_RECORD The Route-Record avp code
static int	SESSION_BINDING The Session-Binding avp code
static int	SESSION_ID The Session-Id avp code
static int	SESSION_SERVER_FAILOVER The Session-Server-Failover avp code
static int	SESSION_TIMEOUT The Session-Timeout avp code
static int	SUPPORTED_VENDOR_ID The Supported-Vendor-Id avp code
static int	TERMINATION_CAUSE The Termination-Cause avp code
static int	USER_NAME The User-Name avp code
static int	VENDOR_ID The Vendor-Id avp code
static int	VENDOR_SPECIFIC_APPLICATION_ID The Vendor-Specific-Application-Id avp code

Method Summary

java.net.InetAddress	getAddress()
int	getCode()
java.lang.String	getDiameterIdentity()
URI	getDiameterURI()
float	getFloat32()
double	getFloat64()
AvpSet	getGrouped()
int	getInteger32()
long	getInteger64()
java.lang.String	getOctetString()
byte[]	getRaw()
java.util.Date	getTime()
long	getUnsigned32()
long	getUnsigned64()
java.lang.String	getUTF8String()
long	getVendorId()
boolean	isEncrypted()
boolean	isMandatory()
boolean	isVendorId()

Methods inherited from interface org.jdiameter.api.Wrapper

isWrapperFor, unwrap

Field Detail

ACCOUNTING_REALTIME_REQUIRED

static final int ACCOUNTING_REALTIME_REQUIRED

The Accounting-Realtime-required avp code

See Also:

Constant Field Values

AUTH_REQUEST_TYPE

static final int AUTH_REQUEST_TYPE

The Auth-Request-Type avp code

See Also:

Constant Field Values

AUTHORIZATION_LIFETIME

static final int AUTHORIZATION_LIFETIME

The Authorization-Lifetime avp code

See Also:

Constant Field Values

AUTH_GRACE_PERIOD

static final int AUTH_GRACE_PERIOD

The Auth-Grace-Period avp code

See Also:

Constant Field Values

AUTH_SESSION_STATE

static final int AUTH_SESSION_STATE

The Auth-Session-State avp code

See Also:

Constant Field Values

CLASS

static final int CLASS

The Class avp code

See Also:

Constant Field Values

E2E_SEQUENCE_AVP

static final int E2E_SEQUENCE_AVP

The E2E-Sequence-Avp avp code

See Also:

Constant Field Values

ERROR_REPORTING_HOST

static final int ERROR_REPORTING_HOST

The Error-reporting-host avp code

See Also:

Constant Field Values

EVENT_TIMESTAMP

static final int EVENT_TIMESTAMP

The Event-Timestamp avp code

See Also:

Constant Field Values

FAILED_AVP

static final int FAILED_AVP

The File-Avp avp code

See Also:

Constant Field Values

ACCT_INTERIM_INTERVAL

static final int ACCT_INTERIM_INTERVAL

The Acct-Interim-Interval avp code

See Also:

Constant Field Values

USER_NAME

static final int USER_NAME

The User-Name avp code

See Also:

Constant Field Values

RESULT_CODE

static final int RESULT_CODE

The Result-Code avp code

See Also:

Constant Field Values

EXPERIMENTAL_RESULT

static final int EXPERIMENTAL_RESULT

Experemental-Result avp code

See Also:

Constant Field Values

EXPERIMENTAL_RESULT_CODE

static final int EXPERIMENTAL_RESULT_CODE

The Experimental-Result-Code avp code

See Also:

Constant Field Values

TERMINATION_CAUSE

static final int TERMINATION_CAUSE

The Termination-Cause avp code

See Also:

Constant Field Values

FIRMWARE_REVISION

static final int FIRMWARE_REVISION

The FirmWare-Revision avp code

See Also:

Constant Field Values

HOST_IP_ADDRESS

static final int HOST_IP_ADDRESS

The Host-IP-Address avp code

See Also:

Constant Field Values

MULTI_ROUND_TIMEOUT

static final int MULTI_ROUND_TIMEOUT

The Muti-Round-Timeout avp code

See Also:

Constant Field Values

ORIGIN_HOST

static final int ORIGIN_HOST

The Origin-Host avp code

See Also:

Constant Field Values

ORIGIN_REALM

static final int ORIGIN_REALM

The Origin-Realm avp code

See Also:

Constant Field Values

ORIGIN_STATE_ID

static final int ORIGIN_STATE_ID

The Origin-State-Id avp code

See Also:

Constant Field Values

REDIRECT_HOST

static final int REDIRECT_HOST

The Rediect-Host avp code

See Also:

Constant Field Values

REDIRECT_HOST_USAGE

static final int REDIRECT_HOST_USAGE

The Redirect-Host-Usage avp code

See Also:

Constant Field Values

REDIRECT_MAX_CACHE_TIME

static final int REDIRECT_MAX_CACHE_TIME

The Redirect-Max-Cache-Time avp code

See Also:

Constant Field Values

PRODUCT_NAME

static final int PRODUCT_NAME

The Product-Name avp code

See Also:

Constant Field Values

SESSION_ID

static final int SESSION_ID

The Session-Id avp code

See Also:

Constant Field Values

SESSION_TIMEOUT

static final int SESSION_TIMEOUT

The Session-Timeout avp code

See Also:

Constant Field Values

SESSION_BINDING

static final int SESSION_BINDING

The Session-Binding avp code

See Also:

Constant Field Values

SESSION_SERVER_FAILOVER

static final int SESSION_SERVER_FAILOVER

The Session-Server-Failover avp code

See Also:

Constant Field Values

DESTINATION_HOST

static final int DESTINATION_HOST

The Destination-Host avp code

See Also:

Constant Field Values

DESTINATION_REALM

static final int DESTINATION_REALM

The Destination-Realm avp code

See Also:

Constant Field Values

ROUTE_RECORD

static final int ROUTE_RECORD

The Route-Record avp code

See Also:

Constant Field Values

PROXY_INFO

static final int PROXY_INFO

The Proxy-Info avp code

See Also:

Constant Field Values

PROXY_HOST

static final int PROXY_HOST

The Proxy-Host avp code

See Also:

Constant Field Values

PROXY_STATE

static final int PROXY_STATE

The Proxy-State avp code

See Also:

Constant Field Values

AUTH_APPLICATION_ID

static final int AUTH_APPLICATION_ID

The Authentication-Application-Id avp code

See Also:

Constant Field Values

ACCT_APPLICATION_ID

static final int ACCT_APPLICATION_ID

The Accounting-Application-Id avp code

See Also:

Constant Field Values

INBAND_SECURITY_ID

static final int INBAND_SECURITY_ID

The Inband-Security-Id avp code

See Also:

Constant Field Values

VENDOR_ID

static final int VENDOR_ID

The Vendor-Id avp code

See Also:

Constant Field Values

SUPPORTED_VENDOR_ID

static final int SUPPORTED_VENDOR_ID

The Supported-Vendor-Id avp code

See Also:

Constant Field Values

VENDOR_SPECIFIC_APPLICATION_ID

static final int VENDOR_SPECIFIC_APPLICATION_ID

The Vendor-Specific-Application-Id avp code

See Also:

Constant Field Values

RE_AUTH_REQUEST_TYPE

static final int RE_AUTH_REQUEST_TYPE

The Re-Authentication-Request-type avp code

See Also:

Constant Field Values

ACC_RECORD_TYPE

static final int ACC_RECORD_TYPE

The Accouting-Record-Type avp code

See Also:

Constant Field Values

ACC_RECORD_NUMBER

static final int ACC_RECORD_NUMBER

The Accouting-Record-Number avp code

See Also:

Constant Field Values

ACC_SESSION_ID

static final int ACC_SESSION_ID

The Accouting-Session-Id avp code

See Also:

Constant Field Values

ACC_SUB_SESSION_ID

static final int ACC_SUB_SESSION_ID

The Accouting-Sub-Session-Id avp code

See Also:

Constant Field Values

ACC_MULTI_SESSION_ID

static final int ACC_MULTI_SESSION_ID

The Accouting-Multi-Session-Id avp code

See Also:

Constant Field Values

DISCONNECT_CAUSE

static final int DISCONNECT_CAUSE

The Disconnect cause avp code

See Also:

Constant Field Values

ERROR_MESSAGE

static final int ERROR_MESSAGE

The Error-Message avp code

See Also:

Constant Field Values

Method Detail

getCode

int getCode()

Returns:

the AVP code.

isVendorId

boolean isVendorId()

Returns:

true if Vendor-id is present in Avp header

isMandatory

boolean isMandatory()

Returns:

true if flag M is set 1

isEncrypted

boolean isEncrypted()

Returns:

true if flag E is set 1

getVendorId

long getVendorId()

Returns:

Vendor-Id if it present (-1 if it not avalible)

getRaw

byte[] getRaw()
              throws AvpDataException

Returns:

data as byte array (Raw format)

Throws:

AvpDataException - if data has incorrect format

getOctetString

java.lang.String getOctetString()
                                throws AvpDataException

Returns:

data as an String (Use AS-ASCI code page)

Throws:

AvpDataException - if data has incorrect format

getInteger32

int getInteger32()
                 throws AvpDataException

Returns:

data as an integer

Throws:

AvpDataException - if data has incorrect format

getInteger64

long getInteger64()
                  throws AvpDataException

Returns:

data as an unsigned long

Throws:

AvpDataException - if data has incorrect format

getUnsigned32

long getUnsigned32()
                   throws AvpDataException

Returns:

data as an unsigned integer

Throws:

AvpDataException - if data has incorrect format

getUnsigned64

long getUnsigned64()
                   throws AvpDataException

Returns:

data as an long

Throws:

AvpDataException - if data has incorrect format

getFloat32

float getFloat32()
                 throws AvpDataException

Returns:

data as an float

Throws:

AvpDataException - if data has incorrect format

getFloat64

double getFloat64()
                  throws AvpDataException

Returns:

data as an double

Throws:

AvpDataException - if data has incorrect format

getAddress

java.net.InetAddress getAddress()
                                throws AvpDataException

Returns:

data as an Diameter Address (Inet4Address or Inet6Address)

Throws:

AvpDataException - if data has incorrect format

getTime

java.util.Date getTime()
                       throws AvpDataException

Returns:

data as an Diameter Time (millisecond is truncated)

Throws:

AvpDataException - if data has incorrect format

getUTF8String

java.lang.String getUTF8String()
                               throws AvpDataException

Returns:

data as an String (Use UTF-8 code page)

Throws:

AvpDataException - if data has incorrect format

getDiameterIdentity

java.lang.String getDiameterIdentity()
                                     throws AvpDataException

Returns:

data as an String (Use AS-ASCI code page)

Throws:

AvpDataException - if data has incorrect format

getDiameterURI

URI getDiameterURI()
                   throws AvpDataException

Returns:

data as an Diamter URI

Throws:

AvpDataException - if data has incorrect format

getGrouped

AvpSet getGrouped()
                  throws AvpDataException

Returns:

data as an AVP group.

Throws:

AvpDataException - if data has incorrect format