jain.protocol.ss7
Class SccpUserAddress

java.lang.Object
  |
  +--jain.protocol.ss7.SccpUserAddress

All Implemented Interfaces:

java.io.Serializable, SS7Address

public final class SccpUserAddress

extends java.lang.Object

implements java.io.Serializable, SS7Address

SccpUserAddress represents an address of a Sccp User application.
A Sccp User application may handle a number of Sccp User Addresses and will register as an Event Listener with any JainProvider for each Sccp 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 one or both of the following:

• Sub-System Address
• Global Title for use in Global Title translation.

It is permitted for more than one JainListener to register with the same JainProvider with the same Sccp User Address and events sent to that Sccp User Address will be sent to all JainListeners of that User Address.

Version:

1.1

Author:

Sun Microsystems Inc.

See Also:

Serialized Form

Constructor Summary

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

SccpUserAddress(SubSystemAddress subSystemAddress)
Constructs a SccpUserAddress with the specified SubSystemAddress (Signalling Point Code and Sub-System Number).

Method Summary

GlobalTitle	getGlobalTitle() Gets the Global Title of the User Address.
boolean	getNationalUse() Gets the National Use of this Sccp User Address.
int	getRoutingIndicator() Gets the Routing indicator.
SubSystemAddress	getSubSystemAddress() Gets the Subsystem address, containing the Signaling Point Code and Sub System Number of the subsystem.
void	setGlobalTitle(GlobalTitle globalTitle) Sets the Global Title of this User Address.
void	setNationalUse(boolean nationalUse) Sets the National Use of this Sccp User Address.
void	setRoutingIndicator(int routingIndicator) Sets the Routing indicator, which indicates if the global title or a combination of the SubSystemAddress will be used by SCCP to route a message.
void	setSubSystemAddress(SubSystemAddress subSystemAddress) Sets the Subsystem address, containing the Signaling Point Code and Sub System Number of the subsystem.
java.lang.String	toString() String representation of class SccpUserAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SccpUserAddress

public SccpUserAddress(SubSystemAddress subSystemAddress)

Constructs a SccpUserAddress with the specified SubSystemAddress (Signalling Point Code and Sub-System Number). This constructor automatically sets the Routing indicator to ROUTING_SUBSYSTEM.

Parameters:

subSystemAddress - the new SubSystem Address supplied to the constructor

Since:

JAIN TCAP v1.1

SccpUserAddress

public SccpUserAddress(GlobalTitle globalTitle)

Constructs a SccpUserAddress with the specified Global Title. This constructor automatically sets the Routing indicator to ROUTING_GLOBALTITLE.

Parameters:

globalTitle - the new GlobalTitle supplied to the method

Since:

JAIN TCAP v1.1

Method Detail

setRoutingIndicator

public void setRoutingIndicator(int routingIndicator)
                         throws java.lang.IllegalArgumentException

Sets the Routing indicator, which indicates if the global title or a combination of the SubSystemAddress will be used by SCCP to route a message.

Parameters:

routingIndicator - The new Routing Indicator value is one of the following:-

• ROUTING_SUBSYSTEM
• ROUTING_GLOBALTITLE

See Also:

AddressConstants

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 the following five different types:

• GTIndicator0000
• GTIndicator0001
• GTIndicator0010
• GTIndicator0011
• GTIndicator0100

Parameters:

globalTitle - the GlobalTitle of this SccpUserAddress

See Also:

GlobalTitle

setSubSystemAddress

public void setSubSystemAddress(SubSystemAddress subSystemAddress)

Sets the Subsystem address, containing the Signaling Point Code and Sub System Number of the subsystem.

Parameters:

subSystemAddress - the new Subsystem Address

See Also:

SubSystemAddress

setNationalUse

public void setNationalUse(boolean nationalUse)

Sets the National Use of this Sccp User Address. The National Use represents bit eight of the Address Indicator. It is reserved for national use and is always set to zero on an international network. Note to developers - The National Use field is defaulted to false (zero).

Parameters:

nationalUse - the new National Use value

getRoutingIndicator

public int getRoutingIndicator()

Gets the Routing indicator. The indicator indicates if global title or a combination of SubSystemAddress will be used by SCCP to route a message.

Returns:

one of the following:-

• ROUTING_SUBSYSTEM
• ROUTING_GLOBALTITLE

getGlobalTitle

public GlobalTitle getGlobalTitle()
                           throws ParameterNotSetException,
                                  MandatoryParameterNotSetException

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 Global Title of this SccpUserAddress

Throws:

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

MandatoryParameterNotSetException - this exception is thrown if the GlobalTitle parameter has not been set and the Routing Indicator is of type ROUTING_GLOBALTITLE.

getSubSystemAddress

public SubSystemAddress getSubSystemAddress()
                                     throws ParameterNotSetException,
                                            MandatoryParameterNotSetException

Gets the Subsystem address, containing the Signaling Point Code and Sub System Number of the subsystem.

Returns:

the Subsystem Address of this Sccp User Address

Throws:

ParameterNotSetException - thrown if theSubSystemAddress parameter has not been set

MandatoryParameterNotSetException - this exception is thrown if the SubSystemAddress parameter has not been set and the Routing Indicator is of type ROUTING_SUBSYSTEM

Since:

JAIN TCAP v1.1

See Also:

SubSystemAddress

getNationalUse

public boolean getNationalUse()

Gets the National Use of this Sccp User Address. The National Use represents bit eight of the Address Indicator. It is reserved for national use and is always set to zero on an international network.

Returns:

The National Use of this Sccp User Address one fo the following:-

• true - Octet eight of the Address Indicator equals 1
• false - Octet eight of the Address Indicator equals 0

Since:

JAIN TCAP v1.1

toString

public java.lang.String toString()

String representation of class SccpUserAddress

Overrides:

toString in class java.lang.Object

Returns:

String provides description of class SccpUserAddress