jain.protocol.ss7.tcap
Class TcapUserAddress

java.lang.Object
  |
  +--jain.protocol.ss7.tcap.TcapUserAddress

public final class TcapUserAddress
extends java.lang.Object
implements java.io.Serializable

TcapUserAddress represents an address of a TCAP User application.
A TCAP User application may handle a number of User Addresses and will register as an Event Listener of a JainTcapProvider for that User Address.

Any Events addressed to a User Address will be passed to the User application to whom the User Address belongs. The User Address comprises of the:


It is permitted for more than one JainTcapListener to register with the same JainTcapProvider with the same User Address and events sent to that User Address will be sent to all JainTcapListeners of that User Address. i.e. it is up to the implementation of JAIN TCAP to manage how the Events are handled between these Listeners.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Constructor Summary
TcapUserAddress(byte[] signalingPointCode, short subSystemNumber)
          Constructs a TcapUserAddress with the specified Signalling Point Code and Sub-System Number.
TcapUserAddress(GlobalTitle globalTitle)
          Constructs a TcapUserAddress with the specified Global Title.
 
Method Summary
 GlobalTitle getGlobalTitle()
          Gets the Global Title of the User Address.
 byte[] getSignalingPointCode()
          Gets the Signaling Point Code of the User Address.
 short getSubSystemNumber()
          Gets the Sub-System Number of the User Address.
 boolean isGlobalTitleRouting()
          Gets the Global Title Routing indicator.
 boolean isSignalingPointCodePresent()
          Indicates if the Signaling Point Code is present in this User Address.
 void setGlobalTitle(GlobalTitle globalTitle)
          Sets the Global Title of this User Address.
 void setGlobalTitleRouting(boolean gtRoutingIndicator)
          Sets the Global Title Routing indicator.
 void setSignalingPointCode(byte[] signalingPointCode)
          Sets the Signaling Point Code of the User Address.
 void setSubSystemNumber(short subSystemNumber)
          Sets the Sub-System Number of the User Address.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TcapUserAddress

public TcapUserAddress(byte[] signalingPointCode,
                       short subSystemNumber)
Constructs a TcapUserAddress with the specified Signalling Point Code and Sub-System Number. Using this constructor will automaticaly set the global title routing indicator to false.
Parameters:
signalingPointCode - the Signaling Point Code of the User Address
subSystemNumber - the Sub-System Number of the User Address

TcapUserAddress

public TcapUserAddress(GlobalTitle globalTitle)
Constructs a TcapUserAddress with the specified Global Title. Using this constructor will automaticaly set the global title routing indicator to true.
Parameters:
globalTitle - the Global title
Method Detail

isGlobalTitleRouting

public boolean isGlobalTitleRouting()
Gets the Global Title Routing indicator. The indicator indicates if global title will be used by SCCP to route a message.
Returns:
true if Global Title is used for routing, false if SSN is used for routing.

setGlobalTitleRouting

public void setGlobalTitleRouting(boolean gtRoutingIndicator)
Sets the Global Title Routing indicator. The indicator indicates if global title will be used by SCCP to route a message. If set to true, SCCP will use the global title to route a message, if set to false, SCCP will use the SSN to route the message.
Parameters:
gtRoutingIndicator - Enable/disable global title routing.

isSignalingPointCodePresent

public boolean isSignalingPointCodePresent()
Indicates if the Signaling Point Code is present in this User Address.
Returns:
true if Signaling Point Code has been set.

getSignalingPointCode

public byte[] getSignalingPointCode()
                             throws ParameterNotSetException
Gets the Signaling Point Code of the User Address. There is no restriction on the limit of the byte[ ] used by the Signaling Point Code. This byte[] limitation should happen during the instantiation of the Signaling Point Code object therefore it will be dependent on the implementation of the JAIN TCAP API.
Returns:
the signalingPointCode of this User Address
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setSignalingPointCode

public void setSignalingPointCode(byte[] signalingPointCode)
Sets the Signaling Point Code of the User Address. There is no restriction on the limit of the byte[ ] used by the Signaling Point Code. This byte[] limitation should happen during the instantiation of the Signaling Point Code object therefore it will be dependent on the implementation of the JAIN TCAP API.
Parameters:
signalingPoint - the signalingPointCode of this TcapUserAddress

getSubSystemNumber

public short getSubSystemNumber()
                         throws ParameterNotSetException
Gets the Sub-System Number of the User Address.
Returns:
the SubSystemNumber of this TcapUserAddress
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setSubSystemNumber

public void setSubSystemNumber(short subSystemNumber)
Sets the Sub-System Number of the User Address.
Parameters:
subSystemNumber - the SubSystemNumber of this TcapUserAddress

getGlobalTitle

public GlobalTitle getGlobalTitle()
                           throws ParameterNotSetException
Gets the Global Title of the User Address. The globalTitle is an object, of which the default value is null. If the get accessor method is used and the globaltitle object has a null value, then a ParameterNotSetException will be thrown.
Returns:
the GlobalTitle of this TcapUserAddress
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setGlobalTitle

public void setGlobalTitle(GlobalTitle globalTitle)
Sets the Global Title of this User Address. The Global Title is an object which can be identified to be one of five different types.

toString

public java.lang.String toString()
Returns a string representation of an instance of this class.
Overrides:
toString in class java.lang.Object


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems