com.ibm.diameter.charging.util
Class RedirectServer

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

public class RedirectServer
extends java.lang.Object

RedirectServer is a lightweight representation of the Grouped [Redirect-Server] Avp. It contains the address information for a redirect server.

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


Constructor Summary
RedirectServer()
          Constructs an empty RedirectServer object representing the [Redirect-Server] Avp.
RedirectServer(java.util.List<Avp> avps)
          Constructs a RedirectServer object representing the Grouped [Redirect-Server] Avp.
 
Method Summary
 java.lang.Integer getRedirectAddressType()
          Gets the value corresponding to the payload of the {Redirect-Address-Type} Avp.
 java.lang.String getRedirectServerAddress()
          Gets the value corresponding to the payload of the {Redirect-Server-Address} Avp.
 void setRedirectAddressType(java.lang.Integer redirectAddressType)
          Sets the value corresponding to the payload of the {Redirect-Address-Type} Avp.
 void setRedirectServerAddress(java.lang.String redirectServerAddress)
          Sets the value corresponding to the payload of the {Redirect-Server-Address} Avp.
 Avp toAvp()
          Transforms a RedirectServer object into a Grouped [Redirect-Server] Avp.
 void validate()
          Validates the members of the RedirectServer object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RedirectServer

public RedirectServer()
Constructs an empty RedirectServer object representing the [Redirect-Server] Avp.


RedirectServer

public RedirectServer(java.util.List<Avp> avps)
               throws AvpTransformationException
Constructs a RedirectServer object representing the Grouped [Redirect-Server] Avp.

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

getRedirectAddressType

public java.lang.Integer getRedirectAddressType()
Gets the value corresponding to the payload of the {Redirect-Address-Type} Avp.

Returns:
the value corresponding to the payload of the {Redirect-Address-Type} Avp.

setRedirectAddressType

public void setRedirectAddressType(java.lang.Integer redirectAddressType)
Sets the value corresponding to the payload of the {Redirect-Address-Type} Avp.

Parameters:
redirectAddressType - the value corresponding to the payload of the {Redirect-Address-Type} Avp.

getRedirectServerAddress

public java.lang.String getRedirectServerAddress()
Gets the value corresponding to the payload of the {Redirect-Server-Address} Avp.

Returns:
the value corresponding to the payload of the {Redirect-Server-Address} Avp.

setRedirectServerAddress

public void setRedirectServerAddress(java.lang.String redirectServerAddress)
Sets the value corresponding to the payload of the {Redirect-Server-Address} Avp.

Parameters:
redirectServerAddress - the value corresponding to the payload of the {Redirect-Server-Address} Avp.

validate

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

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms a RedirectServer object into a Grouped [Redirect-Server] Avp.

All non-null members of RedirectServer will be transformed into Avps nested inside of the [Redirect-Server] Avp.

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


Copyright © 2006 IBM Corp. All Rights Reserved.