com.ibm.diameter.charging.util
Class WLANInformation

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

public class WLANInformation
extends java.lang.Object

WLANInformation is a lightweight representation of the Grouped [WLAN-Information] Avp. It is used to record accounting and charging information that is specific to the Wireless Local Area Network (WLAN) service.

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


Constructor Summary
WLANInformation()
          Constructs an empty WLANInformation object representing the [WLAN-Information] Avp.
WLANInformation(java.util.List<Avp> avps)
          Constructs an WLANInformation object representing the Grouped [WLAN-Information] Avp.
 
Method Summary
 java.lang.String getPdgAddress()
          Gets the value corresponding to the payload of the [PDG-Address] Avp.
 java.lang.Integer getPdgChargingId()
          Gets the value corresponding to the payload of the [PDG-Charging-Id] Avp.
 java.lang.String getWagAddress()
          Gets the value corresponding to the payload of the [WAG-Address] Avp.
 java.lang.String getWagPlmnId()
          Gets the value corresponding to the payload of the [WAG-PLMN-Id] Avp.
 WLANRadioContainer getWlanRadioContainer()
          Gets the value corresponding to the payload of the [WLAN-Radio-Container] Avp.
 java.lang.Integer getWlanSessionId()
          Gets the value corresponding to the payload of the [WLAN-Session-Id] Avp.
 java.lang.String getWlanUELocalIPAddress()
          Gets the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.
 void setPdgAddress(java.lang.String pdgAddress)
          Sets the value corresponding to the payload of the [PDG-Address] Avp.
 void setPdgChargingId(java.lang.Integer pdgChargingId)
          Sets the value corresponding to the payload of the [PDG-Charging-Id] Avp.
 void setWagAddress(java.lang.String wagAddress)
          Sets the value corresponding to the payload of the [WAG-Address] Avp.
 void setWagPlmnId(java.lang.String wagPlmnId)
          Sets the value corresponding to the payload of the [WAG-PLMN-Id] Avp.
 void setWlanRadioContainer(WLANRadioContainer wlanRadioContainer)
          Sets the value corresponding to the payload of the [WLAN-Radio-Container] Avp.
 void setWlanSessionId(java.lang.Integer wlanSessionId)
          Sets the value corresponding to the payload of the [WLAN-Session-Id] Avp.
 void setWlanUELocalIPAddress(java.lang.String wlanUELocalIPAddress)
          Sets the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.
 Avp toAvp()
          Transforms a WLANInformation object into a Grouped [WLAN-Information] Avp.
 void validate()
          Validates the members of the WLANInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WLANInformation

public WLANInformation()
Constructs an empty WLANInformation object representing the [WLAN-Information] Avp.


WLANInformation

public WLANInformation(java.util.List<Avp> avps)
                throws AvpTransformationException
Constructs an WLANInformation object representing the Grouped [WLAN-Information] Avp.

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

getPdgAddress

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

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

setPdgAddress

public void setPdgAddress(java.lang.String pdgAddress)
Sets the value corresponding to the payload of the [PDG-Address] Avp.

Parameters:
pdgAddress - the value corresponding to the payload of the [PDG-Address] Avp.

getPdgChargingId

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

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

setPdgChargingId

public void setPdgChargingId(java.lang.Integer pdgChargingId)
Sets the value corresponding to the payload of the [PDG-Charging-Id] Avp.

Parameters:
pdgChargingId - the value corresponding to the payload of the [PDG-Charging-Id] Avp.

getWagAddress

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

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

setWagAddress

public void setWagAddress(java.lang.String wagAddress)
Sets the value corresponding to the payload of the [WAG-Address] Avp.

Parameters:
wagAddress - the value corresponding to the payload of the [WAG-Address] Avp.

getWagPlmnId

public java.lang.String getWagPlmnId()
Gets the value corresponding to the payload of the [WAG-PLMN-Id] Avp.

Returns:
the value corresponding to the payload of the [WAG-PLMN-Id] Avp.

setWagPlmnId

public void setWagPlmnId(java.lang.String wagPlmnId)
Sets the value corresponding to the payload of the [WAG-PLMN-Id] Avp.

Parameters:
wagPlmnId - the value corresponding to the payload of the [WAG-PLMN-Id] Avp.

getWlanRadioContainer

public WLANRadioContainer getWlanRadioContainer()
Gets the value corresponding to the payload of the [WLAN-Radio-Container] Avp.

Returns:
the value corresponding to the payload of the [WLAN-Radio-Container] Avp.

setWlanRadioContainer

public void setWlanRadioContainer(WLANRadioContainer wlanRadioContainer)
Sets the value corresponding to the payload of the [WLAN-Radio-Container] Avp.

Parameters:
wlanRadioContainer - the value corresponding to the payload of the [WLAN-Radio-Container] Avp.

getWlanSessionId

public java.lang.Integer getWlanSessionId()
Gets the value corresponding to the payload of the [WLAN-Session-Id] Avp.

Returns:
the value corresponding to the payload of the [WLAN-Session-Ids] Avp.

setWlanSessionId

public void setWlanSessionId(java.lang.Integer wlanSessionId)
Sets the value corresponding to the payload of the [WLAN-Session-Id] Avp.

Parameters:
wlanSessionId - the value corresponding to the payload of the [WLAN-Session-Id] Avp.

getWlanUELocalIPAddress

public java.lang.String getWlanUELocalIPAddress()
Gets the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.

Returns:
the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.

setWlanUELocalIPAddress

public void setWlanUELocalIPAddress(java.lang.String wlanUELocalIPAddress)
Sets the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.

Parameters:
wlanUELocalIPAddress - the value corresponding to the payload of the [WLAN-UE-Local-IP-Address] Avp.

validate

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

toAvp

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

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

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


Copyright © 2006 IBM Corp. All Rights Reserved.