public interface SubscriptionId extends GroupedAvp
8.46. Subscription-Id AVP The Subscription-Id AVP (AVP Code 443) is used to identify the end user's subscription and is of type Grouped. The Subscription-Id AVP includes a Subscription-Id-Data AVP that holds the identifier and a Subscription-Id-Type AVP that defines the identifier type. It is defined as follows (per the grouped-avp-def of RFC 3588 [DIAMBASE]): Subscription-Id ::= < AVP Header: 443 > { Subscription-Id-Type } { Subscription-Id-Data }Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
java.lang.String |
getSubscriptionIdData()
Returns the value of the Subscription-Id-Data AVP, of type UTF8String.
|
SubscriptionIdType |
getSubscriptionIdType()
Returns the value of the Subscription-Id-Type AVP, of type Enumerated.
|
boolean |
hasSubscriptionIdData()
Returns true if the Subscription-Id-Data AVP is present in the Subscription-Id AVP.
|
boolean |
hasSubscriptionIdType()
Returns true if the Subscription-Id-Type AVP is present in the Subscription-Id AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Subscription-Id AVP.
|
void |
removeSubscriptionIdData()
Removes the Subscription-Id-Data AVP from the Subscription-Id AVP.
|
void |
removeSubscriptionIdType()
Removes the Subscription-Id-Type AVP from the Subscription-Id AVP.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setSubscriptionIdData(java.lang.String subscriptionIdData)
Sets the value of the Subscription-Id-Data AVP, of type UTF8String.
|
void |
setSubscriptionIdType(SubscriptionIdType subscriptionIdType)
Sets the value of the Subscription-Id-Type AVP, of type Enumerated.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasSubscriptionIdType()
SubscriptionIdType getSubscriptionIdType()
void setSubscriptionIdType(SubscriptionIdType subscriptionIdType)
java.lang.NullPointerException
- if subscriptionIdType
is null
.void removeSubscriptionIdType()
boolean hasSubscriptionIdData()
java.lang.String getSubscriptionIdData()
void setSubscriptionIdData(java.lang.String subscriptionIdData)
java.lang.NullPointerException
- if subscriptionIdData
is null
.void removeSubscriptionIdData()
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()