|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.diameter.charging.util.RoReAuthInfo
public class RoReAuthInfo
RoReAuthInfo is a lightweight representation of the Re-Auth-Request (RAR) command. The OCS sends an RAR to the credit-control client to initiate the Reauthorization process. After requesting more quota from a Top-up server, the credit-client issues another Credit-Control-Update to continue the session.
The Ro RAR 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 | |
---|---|
RoReAuthInfo()
Constructs an empty ReAuthRequest object representing the RAR command. |
|
RoReAuthInfo(java.util.List<Avp> avps)
Constructs a ReAuthRequest object representing the RAR Command. |
Method Summary | |
---|---|
java.lang.Integer |
getAuthApplicationId()
Gets the value corresponding to the payload of the {Auth-Application-Id} Avp. |
java.lang.String |
getDestinationRealm()
Gets the value corresponding to the payload of the {Destination-Realm} Avp. |
GSUPoolReference |
getGSUPoolReference()
Gets the value corresponding to the payload of the [G-S-U-Pool-Reference] Avp. |
java.lang.String |
getOriginHost()
Gets the value corresponding to the payload of the {Origin-Host} Avp. |
java.lang.String |
getOriginRealm()
Gets the value corresponding to the payload of the {Origin-Realm} Avp. |
java.lang.Integer |
getOriginStateId()
Gets the value corresponding to the payload of the [Origin-State-Id] Avp. |
java.lang.Integer |
getRatingGroup()
Gets the value corresponding to the payload of the [Rating-Group] Avp. |
java.lang.Integer |
getReAuthRequestType()
Gets the value corresponding to the payload of the {Re-Auth-Request-Type} Avp. |
java.lang.Integer |
getServiceIdentifier()
Gets the value corresponding to the payload of the [Service-Identifier] Avp. |
java.lang.String |
getSessionId()
Gets the value corresponding to the payload of the {Session-Id} Avp. |
java.lang.String |
getUserName()
Gets the value corresponding to the payload of the {CC-Request-Number} Avp. |
void |
setAuthApplicationId(java.lang.Integer authApplicationId)
Sets the value corresponding to the payload of the {Auth-Application-Id} Avp. |
void |
setDestinationRealm(java.lang.String destinationRealm)
Sets the value corresponding to the payload of the {Destination-Realm} Avp. |
void |
setGSUPoolReference(GSUPoolReference poolReference)
Sets the value corresponding to the payload of the [G-S-U-Pool-Reference] Avp. |
void |
setOriginHost(java.lang.String originHost)
Sets the value corresponding to the payload of the {Origin-Host} Avp. |
void |
setOriginRealm(java.lang.String originRealm)
Sets the value corresponding to the payload of the {Origin-Realm} Avp. |
void |
setOriginStateId(java.lang.Integer originStateId)
Sets the value corresponding to the payload of the [Origin-State-Id] Avp. |
void |
setRatingGroup(java.lang.Integer ratingGroup)
Sets the value corresponding to the payload of the [Rating-Group] Avp. |
void |
setReAuthRequestType(java.lang.Integer reAuthRequestType)
Sets the value corresponding to the payload of the {Re-Auth-Request-Type} Avp. |
void |
setServiceIdentifier(java.lang.Integer serviceIdentifier)
Sets the value corresponding to the payload of the [Service-Identifier] Avp. |
void |
setSessionId(java.lang.String sessionId)
Sets the value corresponding to the payload of the {Session-Id} 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 RoReAuthInfo object into a Vector of Avps that forms the body of the RAR Diameter Packet. |
void |
validate()
Validates the members of the RoReAuthInfo object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RoReAuthInfo()
public RoReAuthInfo(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 ReAuthRequest, 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 getAuthApplicationId()
public void setAuthApplicationId(java.lang.Integer authApplicationId)
authApplicationId
- the value corresponding to the payload of the {Auth-Application-Id} 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 GSUPoolReference getGSUPoolReference()
public void setGSUPoolReference(GSUPoolReference poolReference)
poolReference
- the value corresponding to the payload of the [G-S-U-Pool-Reference] Avp.public java.lang.String getOriginHost()
public void setOriginHost(java.lang.String originHost)
originHost
- the value corresponding to the payload of the {Origin-Host} Avp.public java.lang.String getOriginRealm()
public void setOriginRealm(java.lang.String originRealm)
originRealm
- the value corresponding to the payload of the {Origin-Realm} 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.Integer getRatingGroup()
public void setRatingGroup(java.lang.Integer ratingGroup)
ratingGroup
- the value corresponding to the payload of the [Rating-Group] Avp.public java.lang.Integer getReAuthRequestType()
public void setReAuthRequestType(java.lang.Integer reAuthRequestType)
reAuthRequestType
- the value corresponding to the payload of the {Re-Auth-Request-Type} Avp.public java.lang.Integer getServiceIdentifier()
public void setServiceIdentifier(java.lang.Integer serviceIdentifier)
serviceIdentifier
- the value corresponding to the payload of the [Service-Identifier] 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 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 RoReAuthInfo is in an unexpected format.public java.util.Vector toAvps() throws AvpTransformationException
All non-null members of RoReAuthInfo will be created as Avps in the Vector.
AvpTransformationException
- if a member of RoReAuthInfo is in an
unexpected format.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |