com.ibm.diameter.charging.util
Class MBMSInformation

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

public class MBMSInformation
extends java.lang.Object

MBMSInformation is a lightweight representation of the Grouped [MBMS-Information] Avp. It is used to record accounting and charging information that is specific to the Multimedia Broadcast and Multicast (MBMS) service.

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


Constructor Summary
MBMSInformation()
          Constructs an empty MBMSInformation object representing the [MBMS-Information] Avp.
MBMSInformation(java.util.List<Avp> avps)
          Constructs a MBMSInformation object representing the Grouped [MBMS-Information] Avp.
 
Method Summary
 java.lang.Integer getFileRepairSupported()
          Gets the value corresponding to the payload of the [File-Repair-Supported] Avp.
 java.lang.Integer getMbms2G3GIndicator()
          Gets the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.
 byte[][] getMbmsServiceAreas()
          Gets the values corresponding to the payloads of the [MBMS-Service-Area] Avps.
 java.lang.Integer getMbmsServiceType()
          Gets the value corresponding to the payload of the [MBMS-Service-Type] Avp.
 byte[] getMbmsSessionIdentity()
          Gets the value corresponding to the payload of the [MBMS-Session-Identity] Avp.
 java.lang.Integer getMbmsUserServiceType()
          Gets the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.
 java.lang.String getRai()
          Gets the value corresponding to the payload of the [RAI] Avp.
 java.lang.String getRequiredMbmsBearerCapabilities()
          Gets the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.
 byte[] getTmgi()
          Gets the value corresponding to the payload of the [TMGI] Avp.
 void setFileRepairSupported(java.lang.Integer fileRepairSupported)
          Sets the value corresponding to the payload of the [File-Repair-Supported] Avp.
 void setMbms2G3GIndicator(java.lang.Integer mbms2G3GIndicator)
          Sets the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.
 void setMbmsServiceAreas(byte[][] mbmsServiceAreas)
          Sets the values corresponding to the payloads of the [MBMS-Service-Area] Avps.
 void setMbmsServiceType(java.lang.Integer mbmsServiceType)
          Sets the value corresponding to the payload of the [MBMS-Service-Type] Avp.
 void setMbmsSessionIdentity(byte[] mbmsSessionIdentity)
          Sets the value corresponding to the payload of the [MBMS-Session-Identity] Avp.
 void setMbmsUserServiceType(java.lang.Integer mbmsUserServiceType)
          Sets the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.
 void setRai(java.lang.String rai)
          Sets the value corresponding to the payload of the [RAI] Avp.
 void setRequiredMbmsBearerCapabilities(java.lang.String requiredMBMSBearerCapabilities)
          Sets the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.
 void setTmgi(byte[] tmgi)
          Sets the value corresponding to the payload of the [TMGI] Avp.
 Avp toAvp()
          Transforms a MBMSInformation object into a Grouped [MBMS-Information] Avp.
 void validate()
          Validates the members of the MBMSInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBMSInformation

public MBMSInformation()
Constructs an empty MBMSInformation object representing the [MBMS-Information] Avp.


MBMSInformation

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

The method takes a List of Avps as an input. If an Avp code inside the list corresponds to a member of MBMSInformation, 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 [MBMS-Information] Avp.
Throws:
AvpTransformationException - if the Avp value is in an unexpected format.
Method Detail

getFileRepairSupported

public java.lang.Integer getFileRepairSupported()
Gets the value corresponding to the payload of the [File-Repair-Supported] Avp.

Returns:
the value corresponding to the payload of the [File-Repair-Supported] Avp.

setFileRepairSupported

public void setFileRepairSupported(java.lang.Integer fileRepairSupported)
Sets the value corresponding to the payload of the [File-Repair-Supported] Avp.

Parameters:
fileRepairSupported - the value corresponding to the payload of the [File-Repair-Supported] Avp.

getMbms2G3GIndicator

public java.lang.Integer getMbms2G3GIndicator()
Gets the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.

Returns:
the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.

setMbms2G3GIndicator

public void setMbms2G3GIndicator(java.lang.Integer mbms2G3GIndicator)
Sets the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.

Parameters:
mbms2G3GIndicator - the value corresponding to the payload of the [MBMS-2G-3G-Indicator] Avp.

getMbmsServiceAreas

public byte[][] getMbmsServiceAreas()
Gets the values corresponding to the payloads of the [MBMS-Service-Area] Avps.

Returns:
the values corresponding to the payloads of the [MBMS-Service-Area] Avps.

setMbmsServiceAreas

public void setMbmsServiceAreas(byte[][] mbmsServiceAreas)
Sets the values corresponding to the payloads of the [MBMS-Service-Area] Avps.

Parameters:
fileRepairSupported - the values corresponding to the payloads of the [MBMS-Service-Area] Avps.

getMbmsServiceType

public java.lang.Integer getMbmsServiceType()
Gets the value corresponding to the payload of the [MBMS-Service-Type] Avp.

Returns:
the value corresponding to the payload of the [MBMS-Service-Type] Avp.

setMbmsServiceType

public void setMbmsServiceType(java.lang.Integer mbmsServiceType)
Sets the value corresponding to the payload of the [MBMS-Service-Type] Avp.

Parameters:
mbmsServiceType - the value corresponding to the payload of the [MBMS-Service-Type] Avp.

getMbmsSessionIdentity

public byte[] getMbmsSessionIdentity()
Gets the value corresponding to the payload of the [MBMS-Session-Identity] Avp.

Returns:
the value corresponding to the payload of the [MBMS-Session-Identity] Avp.

setMbmsSessionIdentity

public void setMbmsSessionIdentity(byte[] mbmsSessionIdentity)
Sets the value corresponding to the payload of the [MBMS-Session-Identity] Avp.

Parameters:
mbmsSessionIdentity - the value corresponding to the payload of the [MBMS-Session-Identity] Avp.

getMbmsUserServiceType

public java.lang.Integer getMbmsUserServiceType()
Gets the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.

Returns:
the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.

setMbmsUserServiceType

public void setMbmsUserServiceType(java.lang.Integer mbmsUserServiceType)
Sets the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.

Parameters:
mbmsUserServiceType - the value corresponding to the payload of the [MBMS-User-Service-Type] Avp.

getRai

public java.lang.String getRai()
Gets the value corresponding to the payload of the [RAI] Avp.

Returns:
the value corresponding to the payload of the [RAI] Avp.

setRai

public void setRai(java.lang.String rai)
Sets the value corresponding to the payload of the [RAI] Avp.

Parameters:
rai - the value corresponding to the payload of the [RAI] Avp.

getRequiredMbmsBearerCapabilities

public java.lang.String getRequiredMbmsBearerCapabilities()
Gets the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.

Returns:
the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.

setRequiredMbmsBearerCapabilities

public void setRequiredMbmsBearerCapabilities(java.lang.String requiredMBMSBearerCapabilities)
Sets the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.

Parameters:
requiredMbmsBearerCapabilities - the value corresponding to the payload of the [Required-MBMS-Bearer-Capabilities] Avp.

getTmgi

public byte[] getTmgi()
Gets the value corresponding to the payload of the [TMGI] Avp.

Returns:
the value corresponding to the payload of the [TMGI] Avp.

setTmgi

public void setTmgi(byte[] tmgi)
Sets the value corresponding to the payload of the [TMGI] Avp.

Parameters:
tmgi - the value corresponding to the payload of the [TMGI] Avp.

validate

public void validate()
              throws ChargingValidationException
Validates the members of the MBMSInformation 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 MBMSInformation is in an unexpected format.

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.