com.ibm.diameter.charging.util
Class PSInformation

java.lang.Object
  extended by com.ibm.diameter.charging.util.PSInformation

public class PSInformation
extends java.lang.Object

PSInformation is a lightweight representation of the Grouped [PS-Information] Avp. It is used to record accounting and charging information that is specific to the Packet Switched (PS) service.

The [PS-Information] Avp is defined by the 3GPP in ETSI TS 132 299 V6.9.0 (2006-12) - Diameter charging applications.


Constructor Summary
PSInformation()
          Constructs an empty PSInformation object representing the [PS-Information] Avp.
PSInformation(java.util.List<Avp> avps)
          Constructs a PSInformation object representing the Grouped [PS-Information] Avp.
 
Method Summary
 java.lang.String getCalledStationId()
          Gets the value corresponding to the payload of the [Called-Station-Id] Avp.
 java.lang.String getCgAddress()
          Gets the value corresponding to the payload of the [CG-Address] Avp.
 java.lang.String getChargingRuleBaseName()
          Gets the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.
 java.lang.String getGgsnAddress()
          Gets the value corresponding to the payload of the [GGSN-Address] Avp.
 java.lang.String getPdpAddress()
          Gets the value corresponding to the payload of the [PDP-Address] Avp.
 java.lang.Integer getPdpContextType()
          Gets the value corresponding to the payload of the [PDP-Context-Type] Avp.
 PSFurnishChargingInformation getPsFurnishChargingInformation()
          Gets the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.
 java.lang.String getSgsnAddress()
          Gets the value corresponding to the payload of the [SGSN-Address] Avp.
 byte[] getTgppCamelChargingInfo()
          Gets the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.
 java.lang.String getTgppChargingCharacteristics()
          Gets the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.
 java.lang.Integer getTgppChargingId()
          Gets the value corresponding to the payload of the [3GPP-Charging-Id] Avp.
 java.lang.String getTgppGgsnMccMnc()
          Gets the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.
 java.lang.String getTgppGprsNegotiatedQosProfile()
          Gets the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.
 java.lang.String getTgppImsiMccMnc()
          Gets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.
 byte[] getTgppMsTimezone()
          Gets the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.
 java.lang.String getTgppNsapi()
          Gets the value corresponding to the payload of the [3GPP-Nsapi] Avp.
 java.lang.Integer getTgppPdpType()
          Gets the value corresponding to the payload of the [3GPP-PDP-Type] Avp.
 byte[] getTgppRatType()
          Gets the value corresponding to the payload of the [3GPP-RAT-Type] Avp.
 java.lang.String getTgppSelectionMode()
          Gets the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.
 byte[] getTgppSessionStopIndicator()
          Gets the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.
 java.lang.String getTgppSgsnMccMnc()
          Gets the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.
 byte[] getTgppUserLocationInfo()
          Gets the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.
 void setCalledStationId(java.lang.String calledStationId)
          Sets the value corresponding to the payload of the [Called-Station-Id] Avp.
 void setCgAddress(java.lang.String cgAddress)
          Sets the value corresponding to the payload of the [CG-Address] Avp.
 void setChargingRuleBaseName(java.lang.String chargingRuleBaseName)
          Sets the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.
 void setGgsnAddress(java.lang.String ggsnAddress)
          Sets the value corresponding to the payload of the [GGSN-Address] Avp.
 void setPdpAddress(java.lang.String pdpAddress)
          Sets the value corresponding to the payload of the [PDP-Address] Avp.
 void setPdpContextType(java.lang.Integer pdpContextType)
          Sets the value corresponding to the payload of the [PDP-Context-Type] Avp.
 void setPsFurnishChargingInformation(PSFurnishChargingInformation psFurnishChargingInformation)
          Sets the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.
 void setSgsnAddress(java.lang.String sgsnAddress)
          Sets the value corresponding to the payload of the [SGSN-Address] Avp.
 void setTgppCamelChargingInfo(byte[] tgppCamelChargingInfo)
          Sets the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.
 void setTgppChargingCharacteristics(java.lang.String tgppChargingCharacteristics)
          Sets the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.
 void setTgppChargingId(java.lang.Integer tgppChargingId)
          Sets the value corresponding to the payload of the [3GPP-Charging-Id] Avp.
 void setTgppGgsnMccMnc(java.lang.String tgppGgsnMccMnc)
          Sets the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.
 void setTgppGprsNegotiatedQosProfile(java.lang.String tgppGprsNegotiatedQosProfile)
          Sets the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.
 void setTgppImsiMccMnc(java.lang.String tgppImsiMccMnc)
          Sets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.
 void setTgppMsTimezone(byte[] tgppMsTimezone)
          Sets the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.
 void setTgppNsapi(java.lang.String tgppNsapi)
          Sets the value corresponding to the payload of the [3GPP-Nsapi] Avp.
 void setTgppPdpType(java.lang.Integer tgppPdpType)
          Sets the value corresponding to the payload of the [3GPP-PDP-Type] Avp.
 void setTgppRatType(byte[] tgppRatType)
          Sets the value corresponding to the payload of the [3GPP-RAT-Type] Avp.
 void setTgppSelectionMode(java.lang.String tgppSelectionMode)
          Sets the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.
 void setTgppSessionStopIndicator(byte[] tgppSessionStopIndicator)
          Sets the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.
 void setTgppSgsnMccMnc(java.lang.String tgppSgsnMccMnc)
          Sets the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.
 void setTgppUserLocationInfo(byte[] tgppUserLocationInfo)
          Sets the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.
 Avp toAvp()
          Transforms a PSInformation object into a Grouped [PS-Information] Avp.
 void validate()
          Validates the members of the PSInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSInformation

public PSInformation()
Constructs an empty PSInformation object representing the [PS-Information] Avp.


PSInformation

public PSInformation(java.util.List<Avp> avps)
              throws AvpTransformationException
Constructs a PSInformation object representing the Grouped [PS-Information] Avp.

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of PSInformation, the member will be populated with the Avp value during construction. If an Avp code is unknown, the value will be silently discarded.

Parameters:
avps - a list of Avps that can appear in the Grouped [PS-Information] Avp.
Throws:
AvpTransformationException - if the Avp value is in an unexpected format.
Method Detail

getCalledStationId

public java.lang.String getCalledStationId()
Gets the value corresponding to the payload of the [Called-Station-Id] Avp.

Returns:
the value corresponding to the payload of the [Called-Station-Id] Avp.

getCgAddress

public java.lang.String getCgAddress()
Gets the value corresponding to the payload of the [CG-Address] Avp.

Returns:
the value corresponding to the payload of the [CG-Address] Avp.

getChargingRuleBaseName

public java.lang.String getChargingRuleBaseName()
Gets the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.

Returns:
the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.

getGgsnAddress

public java.lang.String getGgsnAddress()
Gets the value corresponding to the payload of the [GGSN-Address] Avp.

Returns:
the value corresponding to the payload of the [GGSN-Address] Avp.

getPdpAddress

public java.lang.String getPdpAddress()
Gets the value corresponding to the payload of the [PDP-Address] Avp.

Returns:
the value corresponding to the payload of the [PDP-Address] Avp.

getPdpContextType

public java.lang.Integer getPdpContextType()
Gets the value corresponding to the payload of the [PDP-Context-Type] Avp.

Returns:
the value corresponding to the payload of the [PDP-Context-Type] Avp.

getPsFurnishChargingInformation

public PSFurnishChargingInformation getPsFurnishChargingInformation()
Gets the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.

Returns:
the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.

getSgsnAddress

public java.lang.String getSgsnAddress()
Gets the value corresponding to the payload of the [SGSN-Address] Avp.

Returns:
the value corresponding to the payload of the [SGSN-Address] Avp.

getTgppCamelChargingInfo

public byte[] getTgppCamelChargingInfo()
Gets the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.

getTgppChargingCharacteristics

public java.lang.String getTgppChargingCharacteristics()
Gets the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.

getTgppChargingId

public java.lang.Integer getTgppChargingId()
Gets the value corresponding to the payload of the [3GPP-Charging-Id] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Charging-Id] Avp.

getTgppGgsnMccMnc

public java.lang.String getTgppGgsnMccMnc()
Gets the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.

Returns:
the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.

getTgppGprsNegotiatedQosProfile

public java.lang.String getTgppGprsNegotiatedQosProfile()
Gets the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.

Returns:
the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.

getTgppImsiMccMnc

public java.lang.String getTgppImsiMccMnc()
Gets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.

Returns:
the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.

getTgppMsTimezone

public byte[] getTgppMsTimezone()
Gets the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.

Returns:
the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.

getTgppNsapi

public java.lang.String getTgppNsapi()
Gets the value corresponding to the payload of the [3GPP-Nsapi] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Nsapi] Avp.

getTgppPdpType

public java.lang.Integer getTgppPdpType()
Gets the value corresponding to the payload of the [3GPP-PDP-Type] Avp.

Returns:
the value corresponding to the payload of the [3GPP-PDP-Type] Avp.

getTgppRatType

public byte[] getTgppRatType()
Gets the value corresponding to the payload of the [3GPP-RAT-Type] Avp.

Returns:
the value corresponding to the payload of the [3GPP-RAT-Type] Avp.

getTgppSelectionMode

public java.lang.String getTgppSelectionMode()
Gets the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.

getTgppSessionStopIndicator

public byte[] getTgppSessionStopIndicator()
Gets the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.

Returns:
the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.

getTgppSgsnMccMnc

public java.lang.String getTgppSgsnMccMnc()
Gets the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.

Returns:
the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.

getTgppUserLocationInfo

public byte[] getTgppUserLocationInfo()
Gets the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.

Returns:
the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.

setCalledStationId

public void setCalledStationId(java.lang.String calledStationId)
Sets the value corresponding to the payload of the [Called-Station-Id] Avp.

Parameters:
calledStationId - the value corresponding to the payload of the [Called-Station-Id] Avp.

setCgAddress

public void setCgAddress(java.lang.String cgAddress)
Sets the value corresponding to the payload of the [CG-Address] Avp.

Parameters:
cgAddress - the value corresponding to the payload of the [CG-Address] Avp.

setChargingRuleBaseName

public void setChargingRuleBaseName(java.lang.String chargingRuleBaseName)
Sets the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.

Parameters:
chargingRuleBaseName - the value corresponding to the payload of the [Charging-Rule-Base-Name] Avp.

setGgsnAddress

public void setGgsnAddress(java.lang.String ggsnAddress)
Sets the value corresponding to the payload of the [GGSN-Address] Avp.

Parameters:
ggsnAddress - the value corresponding to the payload of the [GGSN-Address] Avp.

setPdpAddress

public void setPdpAddress(java.lang.String pdpAddress)
Sets the value corresponding to the payload of the [PDP-Address] Avp.

Parameters:
pdpAddress - the value corresponding to the payload of the [PDP-Address] Avp.

setPdpContextType

public void setPdpContextType(java.lang.Integer pdpContextType)
Sets the value corresponding to the payload of the [PDP-Context-Type] Avp.

Parameters:
pdpContextType - the value corresponding to the payload of the [PDP-Context-Type] Avp.

setPsFurnishChargingInformation

public void setPsFurnishChargingInformation(PSFurnishChargingInformation psFurnishChargingInformation)
Sets the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.

Parameters:
psFurnishChargingInformation - the value corresponding to the payload of the [PS-Furnish-Charging-Information] Avp.

setSgsnAddress

public void setSgsnAddress(java.lang.String sgsnAddress)
Sets the value corresponding to the payload of the [SGSN-Address] Avp.

Parameters:
sgsnAddress - the value corresponding to the payload of the [SGSN-Address] Avp.

setTgppCamelChargingInfo

public void setTgppCamelChargingInfo(byte[] tgppCamelChargingInfo)
Sets the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.

Parameters:
tgppCamelChargingInfo - the value corresponding to the payload of the [3GPP-Camel-Charging-Info] Avp.

setTgppChargingCharacteristics

public void setTgppChargingCharacteristics(java.lang.String tgppChargingCharacteristics)
Sets the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.

Parameters:
tgppChargingCharacteristics - the value corresponding to the payload of the [3GPP-Charging-Characteristics] Avp.

setTgppChargingId

public void setTgppChargingId(java.lang.Integer tgppChargingId)
Sets the value corresponding to the payload of the [3GPP-Charging-Id] Avp.

Parameters:
tgppChargingId - the value corresponding to the payload of the [3GPP-Charging-Id] Avp.

setTgppGgsnMccMnc

public void setTgppGgsnMccMnc(java.lang.String tgppGgsnMccMnc)
Sets the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.

Parameters:
tgppGgsnMccMnc - the value corresponding to the payload of the [3GPP-GGSN-MCC-MNC] Avp.

setTgppGprsNegotiatedQosProfile

public void setTgppGprsNegotiatedQosProfile(java.lang.String tgppGprsNegotiatedQosProfile)
Sets the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.

Parameters:
tgppGprsNegotiatedQosProfile - the value corresponding to the payload of the [3GPP-GPRS-Negotiated-QoS-Profile] Avp.

setTgppImsiMccMnc

public void setTgppImsiMccMnc(java.lang.String tgppImsiMccMnc)
Sets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.

Parameters:
tgppImsiMccMnc - the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.

setTgppMsTimezone

public void setTgppMsTimezone(byte[] tgppMsTimezone)
Sets the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.

Parameters:
tgppMsTimezone - the value corresponding to the payload of the [3GPP-MS-Timezone] Avp.

setTgppNsapi

public void setTgppNsapi(java.lang.String tgppNsapi)
Sets the value corresponding to the payload of the [3GPP-Nsapi] Avp.

Parameters:
tgppNsapi - the value corresponding to the payload of the [3GPP-Nsapi] Avp.

setTgppPdpType

public void setTgppPdpType(java.lang.Integer tgppPdpType)
Sets the value corresponding to the payload of the [3GPP-PDP-Type] Avp.

Parameters:
tgppPdpType - the value corresponding to the payload of the [3GPP-PDP-Type] Avp.

setTgppRatType

public void setTgppRatType(byte[] tgppRatType)
Sets the value corresponding to the payload of the [3GPP-RAT-Type] Avp.

Parameters:
tgppRatType - the value corresponding to the payload of the [3GPP-RAT-Type] Avp.

setTgppSelectionMode

public void setTgppSelectionMode(java.lang.String tgppSelectionMode)
Sets the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.

Parameters:
tgppSelectionMode - the value corresponding to the payload of the [3GPP-Selection-Mode] Avp.

setTgppSessionStopIndicator

public void setTgppSessionStopIndicator(byte[] tgppSessionStopIndicator)
Sets the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.

Parameters:
tgppSessionStopIndicator - the value corresponding to the payload of the [3GPP-Session-Stop-Indicator] Avp.

setTgppSgsnMccMnc

public void setTgppSgsnMccMnc(java.lang.String tgppSgsnMccMnc)
Sets the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.

Parameters:
tgppSgsnMccMnc - the value corresponding to the payload of the [3GPP-SGSN-MCC-MNC] Avp.

setTgppUserLocationInfo

public void setTgppUserLocationInfo(byte[] tgppUserLocationInfo)
Sets the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.

Parameters:
tgppUserLocationInfo - the value corresponding to the payload of the [3GPP-User-Location-Info] Avp.

validate

public void validate()
              throws ChargingValidationException
Validates the members of the PSInformation object. The charging Web Services call this method before transforming the object into a Grouped Avp. This ensures that improperly formed Avps are not sent to the Diameter peer.

Throws:
ChargingValidationException - if a member of PSInformation is in an unexpected format.

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a PSInformation object into a Grouped [PS-Information] Avp.

All non-null members of PSInformation will be transformed into Avps nested inside of the [PS-Information] Avp.

Returns:
the [PS-Information] Avp.
Throws:
AvpTransformationException - if a member of PSInformation is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.