jain.protocol.ss7.oam.mtp3
Interface Mtp3SapMO

All Known Subinterfaces:
OwnSignallingPointMO
public abstract interface Mtp3SapMO
extends Mtp3ManagedObject

This interface identifies an Mtp3 Service Access Point (SAP). The MTP-3 SAP can represent either a local or remote signalling point. In the case of a local signalling point, this interface is extended by the Signalling Point MO interface. The remote signalling point can be either an adjacent or a far-end node.

The following statistics can be collected for this MO

The following Alarms can be emitted by this MO

The following Errors can be emitted by this MO

Field Summary
static int NI_INTERNATIONAL_00
          A Network Indicator constant: Indicates the International Network 00, this has an integer value of 0.
static int NI_INTERNATIONAL_01
          A Network Indicator constant: Indicates the International Network 01, this has an integer value of 1.
static int NI_NATIONAL_10
          A Network Indicator constant: Indicates the National Network 10, this has an integer value of 2.
static int NI_NATIONAL_11
          A Network Indicator constant: Indicates the National Network 11, this has an integer value of 3.
static int SI_BROADBAND_ISUP
          Service Indicator constant: Indicates broadband ISDN User Part.
static int SI_DUP_CALL_CIRCUIT
          Service Indicator constant: Indicates Data User Part - call and circuit-related messages.
static int SI_DUP_FACILITY_CANCELLATION
          Service Indicator constant: Indicates Data User Part - facility registration and cancellation messages.
static int SI_ISUP
          Service Indicator constant: Indicates ISDN User Part
static int SI_MTP_TESTING
          Service Indicator constant: Indicates reserved for MTP Testing User Part.
static int SI_SATELLITE_ISUP
          Service Indicator constant: Indicates satellite ISDN User Part.
static int SI_SCCP
          Service Indicator constant: Indicates SCCP.
static int SI_SIG_NET_MAN_MESSAGES
          Service Indicator constant: Indicates signalling network management messages.
static int SI_SIG_NET_TEST_MAIN_MESSAGES
          Service Indicator constant: Indicates signalling network testing and maintenance messages.
static int SI_TUP
          Service Indicator constant: Indicates Telephone User Part.
static int STATUS_ALLOWED
          A SAP Status constant: Indicates that the status of the Access Point is Allowed.
static int STATUS_CONGESTED
          A SAP Status constant: Indicates that the status of the Access Point is Congested.
static int STATUS_PROHIBITED
          A SAP Status constant: Indicates that the status of the Access Point is Prohibited.
static int TYPE_SEP
          A Signalling Type constant: Indicates a Signalling End Point.
static int TYPE_STEP
          A Signalling Type constant: Indicates a Signalling Transfer End Point.
static int TYPE_STP
          A Signalling Type constant: Indicates a Signalling Transfer Point.
 
Fields inherited from class jain.protocol.ss7.oam.OamManagedObject
OBJECTID_CONCERNED_AREA, OBJECTID_GLOBAL_TITLE_ENTRY, OBJECTID_LINK, OBJECTID_LINKSET, OBJECTID_MTP2_SAP, OBJECTID_MTP2_TIMER_PROFILE, OBJECTID_MTP3_SAP, OBJECTID_MTP3_TIMER_PROFILE, OBJECTID_OWN_SIGNALLING_POINT, OBJECTID_ROUTE, OBJECTID_ROUTESET, OBJECTID_SCCP_ENTITY_SET, OBJECTID_SCCP_ROUTING_CONTROL, OBJECTID_SCCP_SAP, OBJECTID_SCCP_TIMER_PROFILE, OBJECTID_SCREENING_TABLE, OBJECTID_TCAP
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 int getNetworkIndicator()
          Gets the Network Indicator of this Service Access Point (one of the Network Indicator constants).
 int getSapStatus()
          Returns the status of the signalling point identified by this Service Access Point (one of the SAP Status constants).
 int getServiceIndicator()
          Returns the service indicator one of the service indicator constants.
 long getSignallingPointCode()
          Gets the Signalling Point Code of this Signalling Point.
 int getType()
          Returns the type of this Signalling point (one of the Signalling Type constants).
 void setNetworkIndicator(int networkInd)
          Sets the Network Indicator parameter of this Service Access Point (one of the Network Indicator constants).
 void setServiceIndicator(int serviceIndicator)
          Sets the service indicator (one of the service indicator constants).
 void setSignallingPointCode(long pointCode)
          Sets the Signalling Point Code of this Signalling Point.
 void setType(int type)
          Sets the type of this Signalling Point (one of the Signalling Type constants).
 
Methods inherited from interface jain.protocol.ss7.oam.mtp3.Mtp3ManagedObject
addMtp3AlarmListener, addMtp3ErrorListener, removeMtp3AlarmListener, removeMtp3ErrorListener
 
Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject
addPropertyChangeListener, addVetoableChangeListener, getName, getObjectId, getProprietaryInformation, removePropertyChangeListener, removeVetoableChangeListener, setName
 

Field Detail

STATUS_ALLOWED

public static final int STATUS_ALLOWED
A SAP Status constant: Indicates that the status of the Access Point is Allowed.

STATUS_PROHIBITED

public static final int STATUS_PROHIBITED
A SAP Status constant: Indicates that the status of the Access Point is Prohibited.

STATUS_CONGESTED

public static final int STATUS_CONGESTED
A SAP Status constant: Indicates that the status of the Access Point is Congested.

SI_SIG_NET_MAN_MESSAGES

public static final int SI_SIG_NET_MAN_MESSAGES
Service Indicator constant: Indicates signalling network management messages.

SI_SIG_NET_TEST_MAIN_MESSAGES

public static final int SI_SIG_NET_TEST_MAIN_MESSAGES
Service Indicator constant: Indicates signalling network testing and maintenance messages.

SI_SCCP

public static final int SI_SCCP
Service Indicator constant: Indicates SCCP.

SI_TUP

public static final int SI_TUP
Service Indicator constant: Indicates Telephone User Part.

SI_ISUP

public static final int SI_ISUP
Service Indicator constant: Indicates ISDN User Part

SI_DUP_CALL_CIRCUIT

public static final int SI_DUP_CALL_CIRCUIT
Service Indicator constant: Indicates Data User Part - call and circuit-related messages.

SI_DUP_FACILITY_CANCELLATION

public static final int SI_DUP_FACILITY_CANCELLATION
Service Indicator constant: Indicates Data User Part - facility registration and cancellation messages.

SI_MTP_TESTING

public static final int SI_MTP_TESTING
Service Indicator constant: Indicates reserved for MTP Testing User Part.

SI_BROADBAND_ISUP

public static final int SI_BROADBAND_ISUP
Service Indicator constant: Indicates broadband ISDN User Part.

SI_SATELLITE_ISUP

public static final int SI_SATELLITE_ISUP
Service Indicator constant: Indicates satellite ISDN User Part.

NI_INTERNATIONAL_00

public static final int NI_INTERNATIONAL_00
A Network Indicator constant: Indicates the International Network 00, this has an integer value of 0.

NI_INTERNATIONAL_01

public static final int NI_INTERNATIONAL_01
A Network Indicator constant: Indicates the International Network 01, this has an integer value of 1.

NI_NATIONAL_10

public static final int NI_NATIONAL_10
A Network Indicator constant: Indicates the National Network 10, this has an integer value of 2.

NI_NATIONAL_11

public static final int NI_NATIONAL_11
A Network Indicator constant: Indicates the National Network 11, this has an integer value of 3.

TYPE_SEP

public static final int TYPE_SEP
A Signalling Type constant: Indicates a Signalling End Point.

TYPE_STP

public static final int TYPE_STP
A Signalling Type constant: Indicates a Signalling Transfer Point.

TYPE_STEP

public static final int TYPE_STEP
A Signalling Type constant: Indicates a Signalling Transfer End Point.
Method Detail

setSignallingPointCode

public void setSignallingPointCode(long pointCode)
                            throws java.lang.IllegalArgumentException
Sets the Signalling Point Code of this Signalling Point. The signalling point code is a 9 digit number that takes the format:

SSSAAAZZZ

where:

SSS == Signalling Point ID (member)
AAA == Area Id (cluster)
ZZZ == 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
Parameters:
pointCode - the signalling point code
Throws:
java.lang.IllegalArgumentException - - thrown if the supplied point code is not in the correct format

getSignallingPointCode

public long getSignallingPointCode()
Gets the Signalling Point Code of this Signalling Point. The format of the signalling point code is explained here.
Returns:
the Signalling Point Code

setNetworkIndicator

public void setNetworkIndicator(int networkInd)
                         throws java.lang.IllegalArgumentException
Sets the Network Indicator parameter of this Service Access Point (one of the Network Indicator constants).
Parameters:
networkInd - one of the following:
  • NI_INTERNATIONAL_00
  • NI_INTERNATIONAL_01
  • NI_NATIONAL_10
  • NI_NATIONAL_11
Throws:
IllegalArgumentException - - if the supplied network indicator is not one of the defined types

getNetworkIndicator

public int getNetworkIndicator()
Gets the Network Indicator of this Service Access Point (one of the Network Indicator constants).
Returns:
one of the following:
  • NI_INTERNATIONAL_00
  • NI_INTERNATIONAL_01
  • NI_NATIONAL_10
  • NI_NATIONAL_11

setServiceIndicator

public void setServiceIndicator(int serviceIndicator)
                         throws java.lang.IllegalArgumentException
Sets the service indicator (one of the service indicator constants). This is used by signalling handling functions to to perform message distribution and, in some applications, to perform message routing.
Parameters:
serviceIndicator - one of the Service Indicator constants, one of the following:
  • SI_BROADBAND_ISUP
  • SI_DUP_CALL_CIRCUIT
  • SI_DUP_FACILITY_CANCELLATION
  • SI_ISUP
  • SI_MTP_TESTING
  • SI_SATELLITE_ISUP
  • SI_SCCP
  • SI_SIG_NET_MAN_MESSAGES
  • SI_SIG_NET_TEST_MAIN_MESSAGES
  • SI_TUP
Throws:
java.lang.IllegalArgumentException - - if the supplied service indicator is not one of the defined types

getServiceIndicator

public int getServiceIndicator()
Returns the service indicator one of the service indicator constants. This is used by signalling handling functions to to perform message distribution and, in some applications, to perform message routing.
Returns:
one of the following service indicator constants:
  • SI_BROADBAND_ISUP
  • SI_DUP_CALL_CIRCUIT
  • SI_DUP_FACILITY_CANCELLATION
  • SI_ISUP
  • SI_MTP_TESTING
  • SI_SATELLITE_ISUP
  • SI_SCCP
  • SI_SIG_NET_MAN_MESSAGES
  • SI_SIG_NET_TEST_MAIN_MESSAGES
  • SI_TUP

setType

public void setType(int type)
             throws java.lang.IllegalArgumentException
Sets the type of this Signalling Point (one of the Signalling Type constants).
Parameters:
type - one of the following:
  • TYPE_SEP - a Signalling End Point.
  • TYPE_STP - a Signalling Transfer Point.
  • TYPE_STEP - a Signalling Transfer End Point.
Throws:
java.lang.IllegalArgumentException - - if the supplied type is not one of the defined Signallling Type constants

getType

public int getType()
Returns the type of this Signalling point (one of the Signalling Type constants).
Returns:
one of the following:
  • TYPE_SEP - a Signalling End Point. This type of Signalling Point contains MTP and ISUP (and/or other MTP Users), but cannot act as an intermediate MTP transfer node in the SS7 network. (It can act as an SCCP Relay Node.)
  • TYPE_STP - a Signalling Transfer Point. This type of Signalling Point acts as an intermediate node between SEPs to transfer messages through the SS7 network, it only contains MTP1
  • TYPE_STEP - a Signalling Transfer End Point. This the type of Signaling Point combines the STP and SEP types, thus acting both as a SEP and as a STP.

getSapStatus

public int getSapStatus()
Returns the status of the signalling point identified by this Service Access Point (one of the SAP Status constants).
Returns:
one of the following SAP Status constants :
  • Allowed - The Access Point is reachable and functioning normally.
  • Prohibited - The Access Point is not reachable. This means that the MTP access point is not accessible
  • Congested - The Access Point is congested. This means that the MTP access point is accessible, but the path to it is heavily loaded.
06 January 2000
If you have any comments or queries, please mail them to Colm Hayden [JAIN SS7 OAM Edit Lead]

Copyright - 2000 Sun Microsystems