Skip navigation links

com.bea.wcp.diameter
Class Attribute

java.lang.Object
com.bea.wcp.diameter.Attribute

public final class Attribute

extends java.lang.Object

Diameter attribute information.

Field Summary

static Attribute	ACCOUNTING_REALTIME_REQUIRED
static Attribute	ACCOUNTING_RECORD_NUMBER
static Attribute	ACCOUNTING_RECORD_TYPE
static Attribute	ACCOUNTING_SESSION_ID
static Attribute	ACCOUNTING_SUB_SESSION_ID
static Attribute	ACCT_APPLICATION_ID
static Attribute	ACCT_INTERIM_INTERVAL
static Attribute	ACCT_MULTI_SESSION_ID
static Attribute	AUTH_APPLICATION_ID
static Attribute	AUTH_GRACE_PERIOD
static Attribute	AUTH_REQUEST_TYPE
static Attribute	AUTH_SESSION_STATE
static Attribute	AUTHORIZATION_LIFETIME
static Attribute	CLASS
static int	CODE_ACCOUNTING_RECORD_NUMBER
static int	CODE_ACCOUNTING_RECORD_TYPE
static int	CODE_ACCT_APPLICATION_ID
static int	CODE_ACCT_INTERIM_INTERVAL
static int	CODE_AUTH_APPLICATION_ID
static int	CODE_DESTINATION_HOST
static int	CODE_DESTINATION_REALM
static int	CODE_EXPERIMENTAL_RESULT
static int	CODE_EXPERIMENTAL_RESULT_CODE
static int	CODE_FIRMWARE_REVISION
static int	CODE_HOST_IP_ADDRESS
static int	CODE_INBAND_SECURITY_ID
static int	CODE_ORIGIN_HOST
static int	CODE_ORIGIN_REALM
static int	CODE_PRODUCT_NAME
static int	CODE_PROXY_INFO
static int	CODE_RESULT_CODE
static int	CODE_ROUTE_RECORD
static int	CODE_SESSION_ID
static int	CODE_SUPPORTED_VENDOR_ID
static int	CODE_USER_NAME
static int	CODE_VENDOR_ID
static int	CODE_VENDOR_SPECIFIC_APPLICATION_ID
static Attribute	DESTINATION_HOST
static Attribute	DESTINATION_REALM
static Attribute	DISCONNECT_CAUSE
static Attribute	E2E_SEQUENCE
static Attribute	ERROR_MESSAGE
static Attribute	ERROR_REPORTING_HOST
static Attribute	EVENT_TIMESTAMP
static Attribute	EXPERIMENTAL_RESULT
static Attribute	EXPERIMENTAL_RESULT_CODE
static Attribute	FAILED_AVP
static Attribute	FIRMWARE_REVISION
static int	FLAG_END_TO_END_ENCRYPTION
static int	FLAG_MANDATORY
static int	FLAG_NONE
static int	FLAG_VENDOR_SPECIFIC
static Attribute	HOST_IP_ADDRESS
static Attribute	INBAND_SECURITY_ID
static Attribute	MULTI_ROUND_TIME_OUT
static Attribute	ORIGIN_HOST
static Attribute	ORIGIN_REALM
static Attribute	ORIGIN_STATE_ID
static Attribute	PRODUCT_NAME
static Attribute	PROXY_HOST
static Attribute	PROXY_INFO
static Attribute	PROXY_STATE
static Attribute	RE_AUTH_REQUEST_TYPE
static Attribute	REDIRECT_HOST
static Attribute	REDIRECT_HOST_USAGE
static Attribute	REDIRECT_MAX_CACHE_TIME
static Attribute	RESULT_CODE
static Attribute	ROUTE_RECORD
static Attribute	SESSION_BINDING
static Attribute	SESSION_ID
static Attribute	SESSION_SERVER_FAILOVER
static Attribute	SESSION_TIMEOUT
static Attribute	SUPPORTED_VENDOR_ID
static Attribute	TERMINATION_CAUSE
static Attribute	USER_NAME
static Attribute	VENDOR_ID
static Attribute	VENDOR_SPECIFIC_APPLICATION_ID

Constructor Summary

Attribute(int code, int vendorId, int flags)
Creates a new "anonymous" Attribute decoded from a Diameter message.

Method Summary

XmlBuffer	appendXml(XmlBuffer xb)
static Attribute	define(int code, java.lang.String name) Defines a new Diameter base protocol attribute with default flags (FLAGS_MANDATORY) and data type of "Integer32".
static Attribute	define(int code, java.lang.String name, int vendorId, int flags, Type type) Defines a new Diameter attribute.
static Attribute	define(int code, java.lang.String name, int vendorId, Type type) Defines a new Diameter attribute with default flags (FLAG_MANDATORY).
static Attribute	define(int code, java.lang.String name, Type type) Defines a new Diameter base protocol attribute with default flags (FLAG_MANDATORY).
boolean	equals(java.lang.Object obj) Compares this Attribute to another for equality.
static Attribute	getByCode(int code) Returns the base protocol Attribute for the specified attribute code.
static Attribute	getByCode(int code, int vendorId) Returns the attribute for the specified attribute code and vendor id.
static Attribute	getByName(java.lang.String name) Returns the Attribute for the specified attribute name.
int	getCode() Returns the attribute AVP code.
int	getFlags() Returns the AVP header flags for the attribute.
java.lang.String	getName() Returns the attribute name, or null if unspecified.
static java.util.Set<java.lang.Integer>	getSupportedVendorIds()
Type	getType() Returns the attribute data type.
int	getVendorId() Returns the attribute vendor id, or 0 for Diameter base protocol.
int	hashCode()
boolean	isEndToEndEncryption() Returns true if this attribute supports end-to-end encryption.
boolean	isGrouped() Returns true if this is an attribute for a grouped AVP.
boolean	isMandatory() Returns true if this is a mandatory attribute.
boolean	isUnknown() Returns true if this attribute is unknown (unregistered).
boolean	isVendorSpecific() Returns true if this is a vendor specified attribute.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FLAG_NONE

public static final int FLAG_NONE

See Also:

Constant Field Values

FLAG_VENDOR_SPECIFIC

public static final int FLAG_VENDOR_SPECIFIC

See Also:

Constant Field Values

FLAG_MANDATORY

public static final int FLAG_MANDATORY

See Also:

Constant Field Values

FLAG_END_TO_END_ENCRYPTION

public static final int FLAG_END_TO_END_ENCRYPTION

See Also:

Constant Field Values

CODE_ACCT_APPLICATION_ID

public static final int CODE_ACCT_APPLICATION_ID

See Also:

Constant Field Values

CODE_AUTH_APPLICATION_ID

public static final int CODE_AUTH_APPLICATION_ID

See Also:

Constant Field Values

CODE_DESTINATION_HOST

public static final int CODE_DESTINATION_HOST

See Also:

Constant Field Values

CODE_DESTINATION_REALM

public static final int CODE_DESTINATION_REALM

See Also:

Constant Field Values

CODE_EXPERIMENTAL_RESULT

public static final int CODE_EXPERIMENTAL_RESULT

See Also:

Constant Field Values

CODE_EXPERIMENTAL_RESULT_CODE

public static final int CODE_EXPERIMENTAL_RESULT_CODE

See Also:

Constant Field Values

CODE_FIRMWARE_REVISION

public static final int CODE_FIRMWARE_REVISION

See Also:

Constant Field Values

CODE_HOST_IP_ADDRESS

public static final int CODE_HOST_IP_ADDRESS

See Also:

Constant Field Values

CODE_INBAND_SECURITY_ID

public static final int CODE_INBAND_SECURITY_ID

See Also:

Constant Field Values

CODE_ORIGIN_HOST

public static final int CODE_ORIGIN_HOST

See Also:

Constant Field Values

CODE_ORIGIN_REALM

public static final int CODE_ORIGIN_REALM

See Also:

Constant Field Values

CODE_PRODUCT_NAME

public static final int CODE_PRODUCT_NAME

See Also:

Constant Field Values

CODE_PROXY_INFO

public static final int CODE_PROXY_INFO

See Also:

Constant Field Values

CODE_RESULT_CODE

public static final int CODE_RESULT_CODE

See Also:

Constant Field Values

CODE_ROUTE_RECORD

public static final int CODE_ROUTE_RECORD

See Also:

Constant Field Values

CODE_SESSION_ID

public static final int CODE_SESSION_ID

See Also:

Constant Field Values

CODE_SUPPORTED_VENDOR_ID

public static final int CODE_SUPPORTED_VENDOR_ID

See Also:

Constant Field Values

CODE_VENDOR_ID

public static final int CODE_VENDOR_ID

See Also:

Constant Field Values

CODE_VENDOR_SPECIFIC_APPLICATION_ID

public static final int CODE_VENDOR_SPECIFIC_APPLICATION_ID

See Also:

Constant Field Values

CODE_ACCOUNTING_RECORD_TYPE

public static final int CODE_ACCOUNTING_RECORD_TYPE

See Also:

Constant Field Values

CODE_ACCOUNTING_RECORD_NUMBER

public static final int CODE_ACCOUNTING_RECORD_NUMBER

See Also:

Constant Field Values

CODE_USER_NAME

public static final int CODE_USER_NAME

See Also:

Constant Field Values

CODE_ACCT_INTERIM_INTERVAL

public static final int CODE_ACCT_INTERIM_INTERVAL

See Also:

Constant Field Values

ACCT_INTERIM_INTERVAL

public static final Attribute ACCT_INTERIM_INTERVAL

ACCOUNTING_REALTIME_REQUIRED

public static final Attribute ACCOUNTING_REALTIME_REQUIRED

ACCT_MULTI_SESSION_ID

public static final Attribute ACCT_MULTI_SESSION_ID

ACCOUNTING_RECORD_NUMBER

public static final Attribute ACCOUNTING_RECORD_NUMBER

ACCOUNTING_RECORD_TYPE

public static final Attribute ACCOUNTING_RECORD_TYPE

ACCOUNTING_SESSION_ID

public static final Attribute ACCOUNTING_SESSION_ID

ACCOUNTING_SUB_SESSION_ID

public static final Attribute ACCOUNTING_SUB_SESSION_ID

ACCT_APPLICATION_ID

public static final Attribute ACCT_APPLICATION_ID

AUTH_APPLICATION_ID

public static final Attribute AUTH_APPLICATION_ID

AUTH_REQUEST_TYPE

public static final Attribute AUTH_REQUEST_TYPE

AUTHORIZATION_LIFETIME

public static final Attribute AUTHORIZATION_LIFETIME

AUTH_GRACE_PERIOD

public static final Attribute AUTH_GRACE_PERIOD

AUTH_SESSION_STATE

public static final Attribute AUTH_SESSION_STATE

RE_AUTH_REQUEST_TYPE

public static final Attribute RE_AUTH_REQUEST_TYPE

CLASS

public static final Attribute CLASS

DESTINATION_HOST

public static final Attribute DESTINATION_HOST

DESTINATION_REALM

public static final Attribute DESTINATION_REALM

DISCONNECT_CAUSE

public static final Attribute DISCONNECT_CAUSE

E2E_SEQUENCE

public static final Attribute E2E_SEQUENCE

ERROR_MESSAGE

public static final Attribute ERROR_MESSAGE

ERROR_REPORTING_HOST

public static final Attribute ERROR_REPORTING_HOST

EVENT_TIMESTAMP

public static final Attribute EVENT_TIMESTAMP

EXPERIMENTAL_RESULT

public static final Attribute EXPERIMENTAL_RESULT

EXPERIMENTAL_RESULT_CODE

public static final Attribute EXPERIMENTAL_RESULT_CODE

FAILED_AVP

public static final Attribute FAILED_AVP

FIRMWARE_REVISION

public static final Attribute FIRMWARE_REVISION

HOST_IP_ADDRESS

public static final Attribute HOST_IP_ADDRESS

INBAND_SECURITY_ID

public static final Attribute INBAND_SECURITY_ID

MULTI_ROUND_TIME_OUT

public static final Attribute MULTI_ROUND_TIME_OUT

ORIGIN_HOST

public static final Attribute ORIGIN_HOST

ORIGIN_REALM

public static final Attribute ORIGIN_REALM

ORIGIN_STATE_ID

public static final Attribute ORIGIN_STATE_ID

PRODUCT_NAME

public static final Attribute PRODUCT_NAME

PROXY_HOST

public static final Attribute PROXY_HOST

PROXY_INFO

public static final Attribute PROXY_INFO

PROXY_STATE

public static final Attribute PROXY_STATE

REDIRECT_HOST

public static final Attribute REDIRECT_HOST

REDIRECT_HOST_USAGE

public static final Attribute REDIRECT_HOST_USAGE

REDIRECT_MAX_CACHE_TIME

public static final Attribute REDIRECT_MAX_CACHE_TIME

RESULT_CODE

public static final Attribute RESULT_CODE

ROUTE_RECORD

public static final Attribute ROUTE_RECORD

SESSION_ID

public static final Attribute SESSION_ID

SESSION_TIMEOUT

public static final Attribute SESSION_TIMEOUT

SESSION_BINDING

public static final Attribute SESSION_BINDING

SESSION_SERVER_FAILOVER

public static final Attribute SESSION_SERVER_FAILOVER

SUPPORTED_VENDOR_ID

public static final Attribute SUPPORTED_VENDOR_ID

TERMINATION_CAUSE

public static final Attribute TERMINATION_CAUSE

USER_NAME

public static final Attribute USER_NAME

VENDOR_ID

public static final Attribute VENDOR_ID

VENDOR_SPECIFIC_APPLICATION_ID

public static final Attribute VENDOR_SPECIFIC_APPLICATION_ID

Constructor Detail

Attribute

public Attribute(int code,
                 int vendorId,
                 int flags)

Creates a new "anonymous" Attribute decoded from a Diameter message. This attribute will be of type "Data" and will not be added to the registry of known attributes.

Parameters:

code - the attribute code

vendorId - the attribute vendor id

flags - the attribute flags

Method Detail

define

public static Attribute define(int code,
                               java.lang.String name,
                               int vendorId,
                               int flags,
                               Type type)

Defines a new Diameter attribute. If the Attribute is already defined then returns the previous definition. Otherwise, returns a newly defined Attribute object.

Parameters:

code - the attribute code

name - the attribute name

vendorId - the attribute vendor id, or 0 for Diameter base

flags - the attribute flags

type - the attribute data type

Throws:

java.lang.IllegalStateException - if the attribute is already defined but with properties that are inconsistent with the specified arguments

define

public static Attribute define(int code,
                               java.lang.String name,
                               int vendorId,
                               Type type)

Defines a new Diameter attribute with default flags (FLAG_MANDATORY).

Parameters:

code - the attribute code

name - the attribute name

vendorId - the attribute vendor id, or 0 for Diameter base

type - the attribute data type

Throws:

java.lang.IllegalStateException - if the attribute is already defined

define

public static Attribute define(int code,
                               java.lang.String name,
                               Type type)

Defines a new Diameter base protocol attribute with default flags (FLAG_MANDATORY).

Parameters:

code - the attribute code

name - the attribute name

type - the attribute data type

Throws:

java.lang.IllegalStateException - if the attribute is already defined

define

public static Attribute define(int code,
                               java.lang.String name)

Defines a new Diameter base protocol attribute with default flags (FLAGS_MANDATORY) and data type of "Integer32".

Parameters:

code - the attribute code

name - the attribute name

getByName

public static Attribute getByName(java.lang.String name)

Returns the Attribute for the specified attribute name. The attribute must have been previously defined.

Parameters:

name - the attribute name

Returns:

the registered Attribute, or null if none

getByCode

public static Attribute getByCode(int code)

Returns the base protocol Attribute for the specified attribute code. The attribute must have been previously defined.

Parameters:

code - the attribute code

Returns:

the registered Attribute, or null if none

getByCode

public static Attribute getByCode(int code,
                                  int vendorId)

Returns the attribute for the specified attribute code and vendor id. The attribute must have been previously defined.

Parameters:

code - the attribute code

vendorId - the attribute vendor id

Returns:

the registered Attribute, or null if none

getCode

public int getCode()

Returns the attribute AVP code.

getName

public java.lang.String getName()

Returns the attribute name, or null if unspecified.

getFlags

public int getFlags()

Returns the AVP header flags for the attribute.

getVendorId

public int getVendorId()

Returns the attribute vendor id, or 0 for Diameter base protocol.

getType

public Type getType()

Returns the attribute data type.

isGrouped

public boolean isGrouped()

Returns true if this is an attribute for a grouped AVP.

isMandatory

public boolean isMandatory()

Returns true if this is a mandatory attribute.

isVendorSpecific

public boolean isVendorSpecific()

Returns true if this is a vendor specified attribute.

isEndToEndEncryption

public boolean isEndToEndEncryption()

Returns true if this attribute supports end-to-end encryption.

isUnknown

public boolean isUnknown()

Returns true if this attribute is unknown (unregistered).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Compares this Attribute to another for equality. Two Attributes are considered equal if they have the same attribute code and vendor id.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSupportedVendorIds

public static java.util.Set<java.lang.Integer> getSupportedVendorIds()

appendXml

public XmlBuffer appendXml(XmlBuffer xb)

Skip navigation links