jain.protocol.ss7.tcap
Class TcapUserAddress

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

All Implemented Interfaces:

java.io.Serializable

Deprecated. As of JAIN TCAP v1.1. This class is no longer needed as a result of the addition of the SccpUserAddress class.

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:

• Signaling Point Code
• Sub-System Number
• Optionally Global Title for use in Global Title translation.

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.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Constructor Summary

TcapUserAddress(byte[] signalingPointCode, short subSystemNumber)
Deprecated. Constructs a TcapUserAddress with the specified Signalling Point Code and Sub-System Number.

TcapUserAddress(GlobalTitle globalTitle)
Deprecated. Constructs a TcapUserAddress with the specified Global Title.

Method Summary

GlobalTitle	getGlobalTitle() Deprecated. Gets the Global Title of the User Address.
byte[]	getSignalingPointCode() Deprecated. Gets the Signalling Point Code of the User Address.
short	getSubSystemNumber() Deprecated. Gets the Sub-System Number of the User Address.
boolean	isGlobalTitleRouting() Deprecated. Gets the Global Title Routing indicator.
boolean	isSignalingPointCodePresent() Deprecated. Indicates if the Signalling Point Code is present in this User Address.
void	setGlobalTitle(GlobalTitle globalTitle) Deprecated. Sets the Global Title of this User Address.
void	setGlobalTitleRouting(boolean gtRoutingIndicator) Deprecated. Sets the Global Title Routing indicator.
void	setSignalingPointCode(byte[] pointCode) Deprecated. Sets the Signalling Point Code of the User Address.
void	setSubSystemNumber(short subSystemNumber) Deprecated. Sets the Sub-System Number of the User Address.
java.lang.String	toString() Deprecated. 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)

Deprecated.

Constructs a TcapUserAddress with the specified Signalling Point Code and Sub-System Number. Using this constructor will automatically set the global title routing indicator to false.

Parameters:

signalingPointCode - the Signalling Point Code of the User Address. The format of the signalling point code is described at setSignallingPointCode(byte[]).

subSystemNumber - the Sub-System Number of the User Address

TcapUserAddress

public TcapUserAddress(GlobalTitle globalTitle)

Deprecated.

Constructs a TcapUserAddress with the specified Global Title. Using this constructor will automatically set the global title routing indicator to true.

Parameters:

globalTitle - the Global title

Method Detail

isGlobalTitleRouting

public boolean isGlobalTitleRouting()

Deprecated.

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)

Deprecated.

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()

Deprecated.

Indicates if the Signalling Point Code is present in this User Address.

Returns:

true if Signalling Point Code has been set.

getSignalingPointCode

public byte[] getSignalingPointCode()
                             throws ParameterNotSetException

Deprecated.

Gets the Signalling Point Code of the User Address. The format of the signalling point code is described at setSignallingPointCode(byte[]).

Throws:

ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setSignalingPointCode

public void setSignalingPointCode(byte[] pointCode)

Deprecated.

Sets the Signalling Point Code of the User Address. The signalling point code (spc) is a 3 byte array where:

spc[0] == Signalling Point ID (member)
spc[1] == Area Id (cluster)
spc[2] == Zone Id (network)

The permitted ranges for each value are outlined in the table below.

	Signalling Point ID (member)	Area ID (cluster)	Zone Id (network)
ANSI	000-255	000-255	000-255
ITU	000-007	000-255	000-007

NB:A byte in Java contains a signed integer and thus ranges from -128 to 127.

When converting an Integer (intVal) to a byte (byteVal) using the following code:

int x;
.....
Integer intVal = new Integer(x);
byte byteVal = intVal.byteValue();

The following values will be obtained:

intObj.intValue()	intObj.byteValue()
0	0
127	127
128	-128
255	-1

This fact should be remembered when supplying bytes to this method.

Parameters:

pointCode - the signalingPointCode of this TcapUserAddress

getSubSystemNumber

public short getSubSystemNumber()
                         throws ParameterNotSetException

Deprecated.

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)

Deprecated.

Sets the Sub-System Number of the User Address.

Parameters:

subSystemNumber - the SubSystemNumber of this TcapUserAddress

getGlobalTitle

public GlobalTitle getGlobalTitle()
                           throws ParameterNotSetException

Deprecated.

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)

Deprecated.

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.

• GTIndicator0000
• GTIndicator0001
• GTIndicator0010
• GTIndicator0011
• GTIndicator0100

Parameters:

globalTitle - the GlobalTitle of this TcapUserAddress

toString

public java.lang.String toString()

Deprecated.

Returns a string representation of an instance of this class.

Overrides:

toString in class java.lang.Object