com.ibm.diameter.charging.util
Class AddressDomain

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

public class AddressDomain
extends java.lang.Object

AddressDomain is a lightweight representation of the Grouped [Address-Domain] Avp. It is used to identify the residing domain or network of an address.

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


Constructor Summary
AddressDomain()
          Constructs an empty AddressDomain object representing the [Address-Domain] Avp.
AddressDomain(java.util.List<Avp> avps)
          Constructs an AddressDomain object representing the Grouped [Address-Domain] Avp.
 
Method Summary
 java.lang.String getDomainName()
          Gets the value corresponding to the payload of the [Domain-Name] Avp.
 java.lang.String getTgppImsiMccMnc()
          Gets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.
 void setDomainName(java.lang.String domainName)
          Sets the value corresponding to the payload of the [Domain-Name] Avp.
 void setTgppImsiMccMnc(java.lang.String tgppImsiMccMnc)
          Sets the value corresponding to the payload of the [3GPP-IMSI-MCC-MNC] Avp.
 Avp toAvp()
          Transforms an AddressDomain object into a Grouped [Address-Domain] Avp.
 void validate()
          Validates the members of the AddressDomain object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddressDomain

public AddressDomain()
Constructs an empty AddressDomain object representing the [Address-Domain] Avp.


AddressDomain

public AddressDomain(java.util.List<Avp> avps)
              throws AvpTransformationException
Constructs an AddressDomain object representing the Grouped [Address-Domain] Avp.

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

getDomainName

public java.lang.String getDomainName()
Gets the value corresponding to the payload of the [Domain-Name] Avp.

Returns:
the value corresponding to the payload of the [Domain-Name] Avp.

setDomainName

public void setDomainName(java.lang.String domainName)
Sets the value corresponding to the payload of the [Domain-Name] Avp.

Parameters:
domainName - the value corresponding to the payload of the [Domain-Name] 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.

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.

validate

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

toAvp

public Avp toAvp()
          throws AvpTransformationException
Transforms an AddressDomain object into a Grouped [Address-Domain] Avp.

All non-null members of AddressDomain will be transformed into Avps nested inside of the [Address-Domain] Avp.

Returns:
the [Address-Domain] Avp.
Throws:
AvpTransformationException - if a member of AddressDomain is in an unexpected format.


Copyright © 2006 IBM Corp. All Rights Reserved.