jain.protocol.ss7.oam.mtp3
Interface Mtp3SapMO

public abstract interface Mtp3SapMO
extends Mtp3ManagedObject

This interface identifies an Mtp3 Service Access Point (SAP) and contains the SAP address. There may be many Mtp3Saps associated with the one MTP3 Layer MO and a Mtp3Sap may only be associated with one MTP3 Layer MO.

Field Summary
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
          Access Point Status constant: Indicates that the status of the Access Point is Allowed.
static int STATUS_CONGESTED
          Access Point Status constant: Indicates that the status of the Access Point is Congested.
static int STATUS_PROHIBITED
          Access Point Status constant: Indicates that the status of the Access Point is Prohibited.
 
Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 int getNetworkIndicator()
          Gets the Network Indicator parameter of this 'Access Point'.
 int getSapStatus()
          The status of the Access Point can be: Allowed - The Access Point is reachable and functioning normally.
 int getServiceIndicator()
          Returns the service indicator.
 SignallingPointMO getSignallingPoint()
          Gets the Signalling Point of this 'Access Point'.
 SccpSapMO[] getUserEntity()
          Returns the set of the User Entities that are currently using the Service Access Point.
 SccpSapMO getUserEntity(int index)
          Returns the User entity at the specified position in the list of the User Entities that are using the Service Access Point.
 void setNetworkIndicator(int networkInd)
          Sets the Network Indicator parameter of this 'Access Point'.
 void setSapStatus(int status)
          The status of the Access Point can be: Allowed - The Access Point is reachable and functioning normally.
 void setServiceIndicator(int indicator)
          Sets the service indicator.
 void setSignallingPoint(SignallingPointMO signallingPoint)
          Sets the Signalling Point of this 'Access Point'.
 void setUserEntity(int index, SccpSapMO userEntity)
          Sets the User entity at the specified position in the list of the User Entities that are using the Service Access Point.
 void setUserEntity(SccpSapMO[] userEntityList)
          Sets the User entity at the specified position in the list of the User Entities that are using the Service Access Point.
 
Methods inherited from interface jain.protocol.ss7.oam.mtp3.Mtp3ManagedObject
addMtp3AlarmListener, addMtp3ErrorListener, removeMtp3AlarmListener, removeMtp3ErrorListener
 
Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject
addPropertyChangeListener, getName, removePropertyChangeListener, setName
 

Field Detail

STATUS_ALLOWED

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

STATUS_PROHIBITED

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

STATUS_CONGESTED

public static final int STATUS_CONGESTED
Access Point 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.
Method Detail

setUserEntity

public void setUserEntity(int index,
                          SccpSapMO userEntity)
Sets the User entity at the specified position in the list of the User Entities that are using the Service Access Point. For this MTP3 Access Point the User Entities will be instances of the SCCP.
Parameters:
index - the index of the element in the array
userEntity - the User Entity (the SCCP instance) to be set.

setUserEntity

public void setUserEntity(SccpSapMO[] userEntityList)
Sets the User entity at the specified position in the list of the User Entities that are using the Service Access Point. For this MTP3 Access Point the User Entities will be instances of the SCCP.
Parameters:
userEntityList - the User Entities.

getUserEntity

public SccpSapMO getUserEntity(int index)
Returns the User entity at the specified position in the list of the User Entities that are using the Service Access Point. For this MTP3 Access Point the User Entities will be instances of the SCCP.
Parameters:
index - the index of the element in the array
Returns:
the User Entity (the SCCP instance).

getUserEntity

public SccpSapMO[] getUserEntity()
Returns the set of the User Entities that are currently using the Service Access Point. For this MTP3 Access Point the User Entities will be instances of the SCCP.
Returns:
an array of SCCP Access Points that are currently User Entiites of this Service Access Point.

setSignallingPoint

public void setSignallingPoint(SignallingPointMO signallingPoint)
                        throws java.beans.PropertyVetoException
Sets the Signalling Point of this 'Access Point'.
Parameters:
sp - the signalling point
Throws:
PropertyVetoException - thrown if the proposed attribute change is unacceptable.

getSignallingPoint

public SignallingPointMO getSignallingPoint()
Gets the Signalling Point of this 'Access Point'.
Returns:
the Signalling Point

setNetworkIndicator

public void setNetworkIndicator(int networkInd)
                         throws java.beans.PropertyVetoException
Sets the Network Indicator parameter of this 'Access Point'.
Parameters:
networkInd - one of the following:
  • NI_INTERNATIONAL_00
  • NI_INTERNATIONAL_01
  • NI_NATIONAL_10
  • NI_NATIONAL_11
Throws:
PropertyVetoException - thrown if the proposed attribute change is unacceptable.

getNetworkIndicator

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

setServiceIndicator

public void setServiceIndicator(int indicator)
Sets the service indicator. This is used by signalling handling functions to to perform message distribution and, in some applications, to perform message routing.
Parameters:
indicator - one of the Service Indicator constants

getServiceIndicator

public int getServiceIndicator()
Returns the service indicator. This is used by signalling handling functions to to perform message distribution and, in some applications, to perform message routing.
Returns:
one of the service indicator constants

setSapStatus

public void setSapStatus(int status)
The status of the Access Point can be:

getSapStatus

public int getSapStatus()
The status of the Access Point can be:
01 September 99
If you have any comments or queries, please mail them to JainOAM@East.Sun.Com

Copyright - 1999 Sun Microsystems