|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.charging.util.RoChargingInfo
public class RoChargingInfo
RoChargingInfo is a lightweight representation of the Credit-Control-Request (CCR) command. It includes all of the basic informational elements needed to manage online charging for Events or Sessions. The online client (Charging Trigger Function (CTF)) requests resource allocation and reports credit control usage information to the Online Charging System (OCS). For online charging, the Diameter Credit Control Application (DCCA)), defined in RFC 4006, is used with extensions based on the 3GPP IMS specifications. The RoChargingInfo object is provided as the sole argument to all credit control web service methods.
The Ro CCR command is defined in ETSI TS 132 299 V6.9.0 (2006-12) - Diameter charging applications, which references RFC 4006 - Diameter Credit-Control Application.
Constructor Summary | |
---|---|
RoChargingInfo()
Constructs an empty RoChargingInfo object representing the CCR command. |
|
RoChargingInfo(java.util.List<Avp> avps)
Constructs a RoChargingInfo object representing the CCR Command. |
Method Summary | |
---|---|
java.lang.Integer |
getCcRequestNumber()
Gets the value corresponding to the payload of the {CC-Request-Number} Avp. |
java.lang.String |
getDestinationHost()
Gets the value corresponding to the payload of the [Destination-Host] Avp. |
java.lang.String |
getDestinationRealm()
Gets the value corresponding to the payload of the {Destination-Realm} Avp. |
java.lang.Long |
getEventTimestamp()
Gets the value corresponding to the payload of the [Event-Timestamp] Avp. |
MultipleServicesCreditControl[] |
getMultipleServicesCreditControls()
Gets the values corresponding to the payloads of the [Multiple-Services-Credit-Control] Avps. |
java.lang.Integer |
getMultipleServicesIndicator()
Gets the value corresponding to the payload of the [Multiple-Services-Indicator] Avp. |
java.lang.Integer |
getOriginStateId()
Gets the value corresponding to the payload of the [Origin-State-Id] Avp. |
java.lang.String |
getServiceContextId()
Gets the value corresponding to the payload of the {Service-Context-Id} Avp. |
ServiceInformation |
getServiceInformation()
Gets the value corresponding to the payload of the [Service-Information] Avp. |
java.lang.String |
getSessionId()
Gets the value corresponding to the payload of the {Session-Id} Avp. |
SubscriptionId[] |
getSubscriptionIds()
Gets the values corresponding to the payloads of the [Subscription-Id] Avps. |
java.lang.Integer |
getTerminationCause()
Gets the value corresponding to the payload of the [Termination-Cause] Avp. |
UserEquipmentInfo |
getUserEquipmentInfo()
Gets the value corresponding to the payload of the [User-Equipment-Info] Avp. |
java.lang.String |
getUserName()
Gets the value corresponding to the payload of the [User-Name] Avp. |
void |
setCcRequestNumber(java.lang.Integer ccRequestNumber)
Sets the value corresponding to the payload of the {CC-Request-Number} Avp. |
void |
setDestinationHost(java.lang.String destinationHost)
Sets the value corresponding to the payload of the [Destination-Host] Avp. |
void |
setDestinationRealm(java.lang.String destinationRealm)
Sets the value corresponding to the payload of the {Destination-Realm} Avp. |
void |
setEventTimestamp(java.lang.Long eventTimestamp)
Sets the value corresponding to the payload of the [Event-Timestamp] Avp. |
void |
setMultipleServicesCreditControls(MultipleServicesCreditControl[] multipleServicesCreditControls)
Sets the value corresponding to the payloads of the [Multiple-Services-Credit-Control] Avps. |
void |
setMultipleServicesIndicator(java.lang.Integer multipleServicesIndicator)
Sets the value corresponding to the payload of the [Multiple-Services-Indicator] Avp. |
void |
setOriginStateId(java.lang.Integer originStateId)
Sets the value corresponding to the payload of the [Origin-State-Id] Avp. |
void |
setServiceContextId(java.lang.String serviceContextId)
Sets the value corresponding to the payload of the {Service-Context-Id} Avp. |
void |
setServiceInformation(ServiceInformation serviceInformation)
Sets the value corresponding to the payload of the [Service-Information] Avp. |
void |
setSessionId(java.lang.String sessionId)
Sets the value corresponding to the payload of the {Session-Id} Avp. |
void |
setSubscriptionIds(SubscriptionId[] subscriptionIds)
Sets the values corresponding to the payloads of the [Subscription-Id] Avps. |
void |
setTerminationCause(java.lang.Integer terminationCause)
Sets the value corresponding to the payload of the [Termination-Cause] Avp. |
void |
setUserEquipmentInfo(UserEquipmentInfo userEquipmentInfo)
Sets the value corresponding to the payload of the [User-Equipment-Info] Avp. |
void |
setUserName(java.lang.String userName)
Sets the value corresponding to the payload of the [User-Name] Avp. |
java.util.Vector |
toAvps()
Transforms a RoChargingInfo object into a Vector of Avps that forms the body of the CCR Diameter Packet. |
void |
validate()
Validates the members of the RoChargingInfo object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RoChargingInfo()
public RoChargingInfo(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 RoChargingInfo, 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 RAR
AvpTransformationException
- if the Avp value is in an unexpected format.Method Detail |
---|
public java.lang.Integer getCcRequestNumber()
public void setCcRequestNumber(java.lang.Integer ccRequestNumber)
ccRequestNumber
- the value corresponding to the payload of the {CC-Request-Number} Avp.public java.lang.String getDestinationHost()
public void setDestinationHost(java.lang.String destinationHost)
destinationHost
- the value corresponding to the payload of the [Destination-Host] Avp.public java.lang.String getDestinationRealm()
public void setDestinationRealm(java.lang.String destinationRealm)
destinationRealm
- the value corresponding to the payload of the {Destination-Realm} Avp.public java.lang.Long getEventTimestamp()
public void setEventTimestamp(java.lang.Long eventTimestamp)
eventTimestamp
- the value corresponding to the payload of the [Event-Timestamp] Avp.public MultipleServicesCreditControl[] getMultipleServicesCreditControls()
public void setMultipleServicesCreditControls(MultipleServicesCreditControl[] multipleServicesCreditControls)
multipleServicesCreditControl
- the values corresponding to the payloads of the [Multiple-Services-Credit-Control] Avps.public java.lang.Integer getMultipleServicesIndicator()
public void setMultipleServicesIndicator(java.lang.Integer multipleServicesIndicator)
multipleServicesIndicator
- the value corresponding to the payload of the [Multiple-Services-Indicator] Avp.public java.lang.Integer getOriginStateId()
public void setOriginStateId(java.lang.Integer originStateId)
originStateId
- the value corresponding to the payload of the [Origin-State-Id] Avp.public java.lang.String getServiceContextId()
public void setServiceContextId(java.lang.String serviceContextId)
serviceContextId
- the value corresponding to the payload of the {Service-Context-Id} Avp.public ServiceInformation getServiceInformation()
public void setServiceInformation(ServiceInformation serviceInformation)
serviceInformation
- the value corresponding to the payload of the [Service-Information] Avp.public java.lang.String getSessionId()
public void setSessionId(java.lang.String sessionId)
sessionId
- the value corresponding to the payload of the {Session-Id} Avp.public SubscriptionId[] getSubscriptionIds()
public void setSubscriptionIds(SubscriptionId[] subscriptionIds)
subscriptionId
- the values corresponding to the payloads of the [Subscription-Id] Avps.public java.lang.Integer getTerminationCause()
public void setTerminationCause(java.lang.Integer terminationCause)
terminationCause
- the value corresponding to the payload of the [Termination-Cause] Avp.public UserEquipmentInfo getUserEquipmentInfo()
public void setUserEquipmentInfo(UserEquipmentInfo userEquipmentInfo)
userEquipmentInfo
- the value corresponding to the payload of the [User-Equipment-Info] Avp.public java.lang.String getUserName()
public void setUserName(java.lang.String userName)
userName
- the value corresponding to the payload of the [User-Name] Avp.public void validate() throws ChargingValidationException
ChargingValidationException
- if a member of RoChargingInfo is in an unexpected format.public java.util.Vector toAvps() throws AvpTransformationException
All non-null members of RoChargingInfo will be created as Avps in the Vector.
AvpTransformationException
- if a member of RoChargingInfo is in an
unexpected format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |