|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.packet.AvpDefinition
public class AvpDefinition
The AvpDefinition
contains information about a specific AVP, including the name
of the attribute, the IANA defined AVP code associated with the attribute and the AVP Data
Format associated with the attribute. It also contains an AvpValueUtil
object
that contains the value of this attribute and that knows how to read and write this data type.
Finally, it contains an AvpValidatorUtil
object that knows how to validate this data type.
Field Summary | |
---|---|
static int |
AVP_TYPE_ADDRESS
|
static int |
AVP_TYPE_DIAM_IDENT
|
static int |
AVP_TYPE_DIAM_URI
|
static int |
AVP_TYPE_ENUMERATED
|
static int |
AVP_TYPE_GROUPED
|
static int |
AVP_TYPE_INTEGER32
|
static int |
AVP_TYPE_INTEGER64
|
static int |
AVP_TYPE_IP_FILTER_RULE
|
static int |
AVP_TYPE_OCTET_STRING
|
static int |
AVP_TYPE_QOS_FILTER_RULE
|
static int |
AVP_TYPE_TIME
|
static int |
AVP_TYPE_UNSIGNED32
|
static int |
AVP_TYPE_UNSIGNED64
|
static int |
AVP_TYPE_UTF8_STRING
|
Constructor Summary | |
---|---|
AvpDefinition(int avpCode,
java.lang.String avpName,
int avpType,
AvpValueUtil avpValueUtil,
AvpValidatorUtil avpValidatorUtil,
AvpABNF avpABNF,
boolean vBit,
boolean mBit,
boolean pBit)
Creates an AVP definition that explains the format of the AVP. |
|
AvpDefinition(int avpCode,
java.lang.String avpName,
int avpType,
AvpValueUtil avpValueUtil,
AvpValidatorUtil avpValidatorUtil,
boolean vBit,
boolean mBit,
boolean pBit)
Creates an AVP definition that explains the format of the AVP. |
Method Summary | |
---|---|
AvpABNF |
getAvpABNF()
Returns the instance of AvpABNF that defines the format of this grouped Avp . |
int |
getAvpCode()
Returns the AVP Code. |
java.lang.String |
getAvpName()
Returns the AVP name |
int |
getAvpType()
Returns the AVP Data Format |
AvpValidatorUtil |
getAvpValidatorUtil()
Returns the instance of AvpValidatorUtil that knows how to validate an AVP of this type. |
AvpValueUtil |
getAvpValueUtil()
Returns an instance of a specific AvpValueUtil class that knows how to read
the value of the AVP. |
boolean |
isMandatoryFlag()
Queries whether the Mandatory bit is required for this AVP definition. |
boolean |
isPBit()
Queries whether the P bit is set for this AVP definition |
boolean |
isVBit()
Queries whether the Vendor-Specific bit is required for this AVP definition |
void |
setAvpValidatorUtil(AvpValidatorUtil avpValidatorUtil)
Sets the instance of AvpValidatorUtil |
void |
setMandatoryFlag(boolean mandatoryFlag)
Determines whether the Mandatory bit is required for this AVP definition. |
void |
setPBit(boolean bit)
Sets the P bit for this AVP definition. |
void |
setVBit(boolean bit)
Sets the Vendor-Specific bit on this AVP definition |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int AVP_TYPE_OCTET_STRING
public static final int AVP_TYPE_INTEGER32
public static final int AVP_TYPE_INTEGER64
public static final int AVP_TYPE_UNSIGNED32
public static final int AVP_TYPE_UNSIGNED64
public static final int AVP_TYPE_GROUPED
public static final int AVP_TYPE_ADDRESS
public static final int AVP_TYPE_TIME
public static final int AVP_TYPE_UTF8_STRING
public static final int AVP_TYPE_DIAM_IDENT
public static final int AVP_TYPE_DIAM_URI
public static final int AVP_TYPE_ENUMERATED
public static final int AVP_TYPE_IP_FILTER_RULE
public static final int AVP_TYPE_QOS_FILTER_RULE
Constructor Detail |
---|
public AvpDefinition(int avpCode, java.lang.String avpName, int avpType, AvpValueUtil avpValueUtil, AvpValidatorUtil avpValidatorUtil, boolean vBit, boolean mBit, boolean pBit)
avpCode
- The IANA defined code for this Diameter Attribute.avpName
- The Attribute NameavpType
- The AVP Data FormatavpValueUtil
- The utility class that knows how to read and write an attribute of this data formatavpValidatorUtil
- The utility class that knows how to validate an attribute of this data formatvBit
- If true, this AVP is a vendor specific AVPmBit
- If true, this AVP is mandatory and must be understood by both peers exchanging this messagepBit
- This bit should always be zero. It is an obsolete security bit.public AvpDefinition(int avpCode, java.lang.String avpName, int avpType, AvpValueUtil avpValueUtil, AvpValidatorUtil avpValidatorUtil, AvpABNF avpABNF, boolean vBit, boolean mBit, boolean pBit)
avpCode
- The IANA defined code for this Diameter Attribute.avpName
- The Attribute NameavpType
- The AVP Data FormatavpValueUtil
- The utility class that knows how to read and write an attribute of this data formatavpValidatorUtil
- The utility class that knows how to validate an attribute of this data formatavpABNF
- The ABNF of a grouped AVP that defines the rules of occurence of the group's AVPs.vBit
- If true, this AVP is a vendor specific AVPmBit
- If true, this AVP is mandatory and must be understood by both peers exchanging this messagepBit
- This bit should always be zero. It is an obsolete security bit.Method Detail |
---|
public AvpValueUtil getAvpValueUtil()
AvpValueUtil
class that knows how to read
the value of the AVP. The instance returned has been created using the default constructor.
public int getAvpCode()
public java.lang.String getAvpName()
public int getAvpType()
public AvpValidatorUtil getAvpValidatorUtil()
AvpValidatorUtil
that knows how to validate an AVP of this type.
public void setAvpValidatorUtil(AvpValidatorUtil avpValidatorUtil)
AvpValidatorUtil
avpValidatorUtil
- The instance of avpValidatorUtil that knows how to validate an AVP of this type.public boolean isMandatoryFlag()
public void setMandatoryFlag(boolean mandatoryFlag)
mandatoryFlag
- true if support for this AVP is required, otherwise false.public boolean isPBit()
public void setPBit(boolean bit)
bit
- true if this AVP definition requires encryption for end-to-end security, otherwise false.public boolean isVBit()
public void setVBit(boolean bit)
bit
- true if this is a Vendor-Specific AVP, otherwise false.public AvpABNF getAvpABNF()
AvpABNF
that defines the format of this grouped Avp
.
Avp
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |