com.ibm.diameter.charging.util
Class ApplicationServerInformation

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

public class ApplicationServerInformation
extends java.lang.Object

ApplicationServerInformation is a lightweight representation of the Grouped [Application-Server-Information] Avp. It contains information about application servers that are visited through the IMS Service Control (ISC) interface.

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


Constructor Summary
ApplicationServerInformation()
          Constructs an empty ApplicationServerInformation object representing the [Application-Server-Information] Avp.
ApplicationServerInformation(java.util.List avps)
          Constructs an ApplicationServerInformation object representing the Grouped [Application-Server-Information] Avp.
 
Method Summary
 java.lang.String[] getApplicationProvidedCalledPartyAddress()
          Gets the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.
 java.lang.String getApplicationServer()
          Gets the value corresponding to the payload of the [Application-Server] Avp.
 void setApplicationProvidedCalledPartyAddress(java.lang.String[] applicationProvidedCalledPartyAddress)
          Sets the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.
 void setApplicationServer(java.lang.String applicationServer)
          Sets the value corresponding to the payload of the [Application-Server] Avp.
 Avp toAvp()
          Transforms an ApplicationServerInformation object into a Grouped [Application-Server-Information] Avp.
 void validate()
          Validates the members of the ApplicationServerInformation object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApplicationServerInformation

public ApplicationServerInformation()
Constructs an empty ApplicationServerInformation object representing the [Application-Server-Information] Avp.


ApplicationServerInformation

public ApplicationServerInformation(java.util.List avps)
                             throws AvpTransformationException
Constructs an ApplicationServerInformation object representing the Grouped [Application-Server-Information] Avp.

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

getApplicationProvidedCalledPartyAddress

public java.lang.String[] getApplicationProvidedCalledPartyAddress()
Gets the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.

Returns:
the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.

setApplicationProvidedCalledPartyAddress

public void setApplicationProvidedCalledPartyAddress(java.lang.String[] applicationProvidedCalledPartyAddress)
Sets the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.

Parameters:
applicationProvidedCalledPartyAddress - the value corresponding to the payload of the [Application-Provided-Called-Party-Address] Avp.

getApplicationServer

public java.lang.String getApplicationServer()
Gets the value corresponding to the payload of the [Application-Server] Avp.

Returns:
the value corresponding to the payload of the [Application-Server] Avp.

setApplicationServer

public void setApplicationServer(java.lang.String applicationServer)
Sets the value corresponding to the payload of the [Application-Server] Avp.

Parameters:
applicationServer - the value corresponding to the payload of the [Application-Server] Avp.

validate

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

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms an ApplicationServerInformation object into a Grouped [Application-Server-Information] Avp.

All non-null members of ApplicationServerInformation will be transformed into Avps nested inside of the [Application-Server-Information] Avp.

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


Copyright © 2006 IBM Corp. All Rights Reserved.