public interface VendorSpecificApplicationId extends GroupedAvp
6.11. Vendor-Specific-Application-Id AVP The Vendor-Specific-Application-Id AVP (AVP Code 260) is of type Grouped and is used to advertise support of a vendor-specific Diameter application. Exactly one instance of either Auth- Application-Id or Acct-Application-Id AVP MUST be present. The Application Id carried by either Auth-Application-Id or Acct- Application-Id AVP MUST comply with vendor-specific Application Id assignment described in Section 11.3. It MUST also match the Application Id present in the Diameter header except when used in a CER or CEA message. The Vendor-Id AVP is an informational AVP pertaining to the vendor who may have authorship of the vendor-specific Diameter application. It MUST NOT be used as a means of defining a completely separate vendor-specific Application Id space. The Vendor-Specific-Application-Id AVP SHOULD be placed as close to the Diameter header as possible. AVP Format <Vendor-Specific-Application-Id> ::= < AVP Header: 260 > 1* [ Vendor-Id ] [ Auth-Application-Id ] [ Acct-Application-Id ] A Vendor-Specific-Application-Id AVP MUST contain exactly one of either Auth-Application-Id or Acct-Application-Id. If a Vendor- Specific-Application-Id is received without one of these two AVPs, then the recipient SHOULD issue an answer with a Result-Code set to DIAMETER_MISSING_AVP. The answer SHOULD also include a Failed-AVP, which MUST contain an example of an Auth-Application-Id AVP and an Acct-Application-Id AVP. If a Vendor-Specific-Application-Id is received that contains both Auth-Application-Id and Acct-Application-Id, then the recipient MUST issue an answer with Result-Code set to DIAMETER_AVP_OCCURS_TOO_MANY_TIMES. The answer MUST also include a Failed-AVP, which MUST contain the received Auth-Application-Id AVP and Acct-Application-Id AVP.Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
long |
getAcctApplicationId()
Returns the value of the Acct-Application-Id AVP, of type Unsigned32.
|
long |
getAuthApplicationId()
Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long[] |
getVendorIds()
Returns the set of Vendor-Id AVPs.
|
boolean |
hasAcctApplicationId()
Returns true if the Acct-Application-Id AVP is present in the Vendor-Specific-Application-Id AVP.
|
boolean |
hasAuthApplicationId()
Returns true if the Auth-Application-Id AVP is present in the Vendor-Specific-Application-Id AVP.
|
void |
removeAcctApplicationId()
Removes the Acct-Application-Id AVP from the Vendor-Specific-Application-Id AVP.
|
void |
removeAuthApplicationId()
Removes the Auth-Application-Id AVP from the Vendor-Specific-Application-Id AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Vendor-Specific-Application-Id AVP.
|
void |
removeVendorIds()
Removes all Vendor-Id AVPs from the Vendor-Specific-Application-Id AVP.
|
void |
setAcctApplicationId(long acctApplicationId)
Sets the value of the Acct-Application-Id AVP, of type Unsigned32.
|
void |
setAuthApplicationId(long authApplicationId)
Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setVendorId(long vendorId)
Sets a single Vendor-Id AVP in the Vendor-Specific-Application-Id AVP, of type Unsigned32.
|
void |
setVendorIds(long[] vendorIds)
Sets the set of Vendor-Id AVPs, with all the values in the given array.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
long[] getVendorIds()
void setVendorId(long vendorId)
void setVendorIds(long[] vendorIds)
java.lang.NullPointerException
- if vendorIds
is null
.void removeVendorIds()
boolean hasAuthApplicationId()
long getAuthApplicationId()
hasAuthApplicationId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Auth-Application-Id AVP has not been set.void setAuthApplicationId(long authApplicationId)
void removeAuthApplicationId()
boolean hasAcctApplicationId()
long getAcctApplicationId()
hasAcctApplicationId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Acct-Application-Id AVP has not been set.void setAcctApplicationId(long acctApplicationId)
void removeAcctApplicationId()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class
(i.e. an AVP for which get/set methods already appear in this class)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()