javax.slee

Class Address

java.lang.Object

javax.slee.Address

All Implemented Interfaces:

Serializable

public class Address
extends Object
implements Serializable

The Address class encapsulates an address that can be used by the SLEE. An address consists of the following two components:

• Address Plan - the plan that defines the address or numbering type and the format of the address string.
• Address String - some combination of alphanumeric characters and symbols that identify an address within the domain identified by the address plan.

An Address object is immutable. Once it has been created the values contained by it cannot change.

Valid Addresses The valid values for address strings is dependent on the address plan for an address. The following is a list of valid address strings for each address plan:

• IP address:
  For both Ipv4 and IPv6 the dotted quad/hex notation is used. The address can optionally be followed by a port number separated by a colon.
  For Example: "127.0.0.1:42"
• MULTICAST address:
  This address is an IP address in dotted notation that is either an Ipv4 class D address or an Ipv6 equivalent address. notation.
  For example: "224.0.0.0"
• UNICAST address:
  This address is an IP address in dotted notation that is not a multicast or broadcast address. notation.
  For example: "127.0.0.1"
• E164 address:
  This address is an international number without the international access code, but including the country code and area code (without the leading zero).
  For example: "442890100100" for a UK based number
• E164_MOBILE address:
  This address is an E.164 mobile number.
  For example: "44791111111" for a UK based mobile number
• AESA address:
  This address is the ATM End System Address in binary format (40 bytes).
  For example: 01234567890ABCDEF01234567890ABCDEF01234567
• URI address:
  This address is an uniform resource locator as defined in IETF RFC 2396.
  For example: "http://jcp.org", "mailto:jainslee@jcp.org"
• NSAP address:
  This address is an binary representation of a Network Service Access Point.
  For example: 490001AA000400010420
• SMTP address:
  This address is an email address as specified in IETF RFC 822.
  For example: "jain@sun.com"
• X400 address:
  This address is the X400 address structured as a set of attribute value pairs separated by semicolons.
  For example: "C=nl;ADMD= ;PRMD=uninet;O=sun;S=Foo;I=S;G=Bar'
• SIP address:
  This address is a Session Initiation Protocol address as specified in IETF RFC 2543.
  For example: "sip:jain@sun.com"
• H323 address:
  This address is an H.323 address. An H.323 address may be identified by a list of addresses of different types, including URLs.
  For example: "442890100100,http://www.sun.com,jain@sun.com". This would be an H.323 address which is a combination of an E.164 address, a URL address and an email address.
• GT address:
  This address is a Global Title. The format of a Global Title is GTI.TT.NP.NA.AI where:
  GTI is the Global Title Indicator
  TT is the Translation Type
  NP is the Numbering Plan
  NA is the Nature of Address Indicator
  AI is the Address Information
  TT, NP, and NA are all optional depending on the Global Title Indicator and standard being used.
  For example: 1.0.0.0.1234
• SSN address:
  This address is a Sub System Number.
  For example: "6.255.255.255". The 6 equals the sub system number, that is the 6 is equal to the Home Location Register. The sub system number is seperated by a full stop '.' from the Signaling Point Code, which must be in the format of X.X.X
• SLEE Profile Table address:
  This address is the name of a SLEE Profile Table.
  For example: ServiceOptions
• SLEE Profile address:
  This address is the encoded table name and profile name of a SLEE profile. The names are separated using a forward slash '/' character.
  For example: ServiceOptions/Gold

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Address(AddressPlan addressPlan, String addressString) Create a new Address using an address plan and address string.
Address(AddressPlan addressPlan, String addressString, AddressPresentation addressPresentation, AddressScreening addressScreening, String subAddressString, String addressName) Create a new Address using an address plan, an address string, an additional optional attributes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compare this address object for equality with another.
String	getAddressName() Get the optional address name for the address.
AddressPlan	getAddressPlan() Get the address plan for the address.
AddressPresentation	getAddressPresentation() Get the optional address presentation attribute for the address.
AddressScreening	getAddressScreening() Get the optional address screening attribute for the address.
String	getAddressString() Get the address string for the address.
String	getSubAddressString() Get the optional sub-address string for the address.
int	hashCode() Get a hash code value for this address object.
String	toString() Get the textual representation of the address object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Address

public Address(AddressPlan addressPlan,
       String addressString)

Create a new Address using an address plan and address string.

Parameters:

addressPlan - the address plan for this address.

addressString - the address string for this address.

Throws:

NullPointerException - if either addressPlan or addressString is null.

IllegalArgumentException - if addressString is zero-length.

Address

public Address(AddressPlan addressPlan,
       String addressString,
       AddressPresentation addressPresentation,
       AddressScreening addressScreening,
       String subAddressString,
       String addressName)

Create a new Address using an address plan, an address string, an additional optional attributes.

Parameters:

addressPlan - the address plan for this address.

addressString - the address string for this address.

addressPresentation - an optional argument describing whether the address can be presented to other call parties.

addressScreening - an optional argument describing whether the address has been screened by a user application.

subAddressString - an optional argument that provides a sub-address string for protocols that allow sub-addressing.

addressName - an optional argument that allows a more personal name to be associated with the address.

Throws:

NullPointerException - if either addressPlan or addressString is null.

IllegalArgumentException - if addressString is zero-length.

Method Detail

getAddressPlan

public AddressPlan getAddressPlan()

Get the address plan for the address.

Returns:

the address plan.

getAddressString

public String getAddressString()

Get the address string for the address.

Returns:

the address string.

getAddressPresentation

public AddressPresentation getAddressPresentation()

Get the optional address presentation attribute for the address.

Returns:

the address presentation attribute, or null if no address presentation attribute was specified.

getAddressScreening

public AddressScreening getAddressScreening()

Get the optional address screening attribute for the address.

Returns:

the address screening attribute, or null if no address screening attribute was specified.

getSubAddressString

public String getSubAddressString()

Get the optional sub-address string for the address.

Returns:

the sub-address string, or null if no sub-address string was specified.

getAddressName

public String getAddressName()

Get the optional address name for the address.

Returns:

the address name, or null if no address name was specified.

equals

public boolean equals(Object obj)

Compare this address object for equality with another.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this with.

Returns:

true if obj is an instance of this class containing the same address plan and address string as this, false otherwise.

hashCode

public int hashCode()

Get a hash code value for this address object.

Overrides:

hashCode in class Object

Returns:

a hash code value.

toString

public String toString()

Get the textual representation of the address object. The format of the returned string is: <address-plan>: <address-string>

Overrides:

toString in class Object

Returns:

the textual representation of the address object.