public interface DiameterAvp
extends java.lang.Cloneable
DiameterMessageFactory
.Modifier and Type | Field and Description |
---|---|
static int |
FLAG_RULE_MAY |
static int |
FLAG_RULE_MUST |
static int |
FLAG_RULE_MUSTNOT |
Modifier and Type | Method and Description |
---|---|
byte[] |
byteArrayValue()
Return the raw contents of this AVP
|
java.lang.Object |
clone()
Creates and returns a deep copy of this AVP instance.
|
double |
doubleValue()
The value of this AVP if the Diameter type can be represented in
a Java double value (e.g., Float64, Float32)
|
float |
floatValue()
The value of this AVP if the Diameter type can be represented in
a Java float value (e.g., Float32)
|
int |
getCode()
Return the AVP code, e.g., 263 for Session-Id
|
int |
getMandatoryRule()
Return the rule for the mandatory (M) flag of this AVP.
|
java.lang.String |
getName()
Return the AVP name, e.g., "Session-Id"
|
int |
getProtectedRule()
Return the rule for the protected (P) flag of this AVP.
|
DiameterAvpType |
getType()
Return the AVP type (one of the String constants from
DiameterAvpType . |
int |
getVendorID()
Return the Vendor-ID value for proprietary (non-IETF) AVPs.
|
DiameterAvp[] |
groupedAvpValue()
Return the AVPs contained in this GroupedAvp as an array of DiameterAvp objects
if the AVP is a Grouped AVP.
|
int |
intValue()
The value of this AVP if the Diameter type can be represented in
a Java int value (e.g., Integer32)
|
long |
longValue()
The value of this AVP if the Diameter type can be represented in
a Java long value (e.g., Integer64, Unsigned32, Integer32)
|
java.lang.String |
stringValue()
The value of this AVP if the Diameter type is equivalent to a Java String
value (e.g., UTF8String)
|
static final int FLAG_RULE_MUST
static final int FLAG_RULE_MAY
static final int FLAG_RULE_MUSTNOT
int getCode()
int getVendorID()
The value should be the IANA-assigned "SMI Network Management Private Enterprise Codes" value of the organisation that defined the AVP, for example 3GPP is 10415.
A Vendor-ID value of zero means the Vendor-ID is not specified. Standard AVPs defined by IETF will have a Vendor-ID of zero.
java.lang.String getName()
DiameterAvpType getType()
DiameterAvpType
.int getMandatoryRule()
0 - MUST
1 - MAY
2 - MUSTNOT
int getProtectedRule()
0 - MUST
1 - MAY
2 - MUSTNOT
double doubleValue()
java.lang.IllegalArgumentException
- if the AVP does not contain a double equivalentfloat floatValue()
java.lang.IllegalArgumentException
- if the AVP does not contain a float equivalentint intValue()
java.lang.IllegalArgumentException
- if the AVP does not contain an int equivalentlong longValue()
java.lang.IllegalArgumentException
- if the AVP does not contain a long equivalentjava.lang.String stringValue()
java.lang.IllegalArgumentException
- if the AVP does not contain a String equivalentbyte[] byteArrayValue()
DiameterAvp[] groupedAvpValue()
java.lang.IllegalArgumentException
- if the AVP is not of Grouped typejava.lang.Object clone()