|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.charging.util.SubscriptionId
public class SubscriptionId
SubscriptionId is a lightweight representation of the Grouped [Subscription-Id] Avp. It identifies an end user's subscription.
The [Subscription-Id] Avp is defined in RFC 4006 - Diameter Credit-Control Application.
Constructor Summary | |
---|---|
SubscriptionId()
Constructs an empty SubscriptionId object representing the [Subscription-Id] Avp. |
|
SubscriptionId(java.util.List<Avp> avps)
Constructs a SubscriptionId object representing the Grouped [Subscription-Id] Avp. |
Method Summary | |
---|---|
java.lang.String |
getSubscriptionIdData()
Gets the value corresponding to the payload of the {Subscription-Id-Data} Avp. |
java.lang.Integer |
getSubscriptionIdType()
Gets the value corresponding to the payload of the {Subscription-Id-Type} Avp. |
void |
setSubscriptionIdData(java.lang.String subscriptionIdData)
Sets the value corresponding to the payload of the {Subscription-Id-Data} Avp. |
void |
setSubscriptionIdType(java.lang.Integer subscriptionIdType)
Sets the value corresponding to the payload of the {Subscription-Id-Type} Avp. |
Avp |
toAvp()
Transforms a SubscriptionId object into a Grouped [Subscription-Id] Avp. |
void |
validate()
Validates the members of the SubscriptionId object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SubscriptionId()
public SubscriptionId(java.util.List<Avp> avps) throws AvpTransformationException
The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of SubscriptionId, the member will be populated with the Avp value during construction. If an Avp code is unknown, the value will be silently discarded.
avps
- a list of Avps that can appear in the Grouped
[Subscription-Id] Avp.
AvpTransformationException
- if the Avp value is in an unexpected format.Method Detail |
---|
public java.lang.String getSubscriptionIdData()
public void setSubscriptionIdData(java.lang.String subscriptionIdData)
subscriptionIdData
- the value corresponding to the payload of the {Subscription-Id-Data} Avp.public java.lang.Integer getSubscriptionIdType()
public void setSubscriptionIdType(java.lang.Integer subscriptionIdType)
subscriptionIdType
- the value corresponding to the payload of the {Subscription-Id-Type} Avp.public void validate() throws ChargingValidationException
ChargingValidationException
- if a member of SubscriptionId is in an unexpected format.public Avp toAvp() throws AvpTransformationException
All non-null members of SubscriptionId will be transformed into Avps nested inside of the [Subscription-Id] Avp.
AvpTransformationException
- if a member of SubscriptionId is in an
unexpected format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |