jain.protocol.ss7.oam.sccp
Interface SccpSapMO

public abstract interface SccpSapMO

extends SccpManagedObject

This interface defines a SCCP Access Point. This is the Service Access Point (SAP) of the SCCP services to its users and contains the SAP address (the Sub-System number). There may be many SccpSaps associated with the one SCCP Layer MO and a SccpSap may only be associated with one SCCP Layer MO.

Field Summary

static int	STATUS_AVAILABLE Access Point Status constant: Indicates that the status of the Access Point is Available.
static int	STATUS_DEGRADED Access Point Status constant: Indicates that the status of the Access Point is Congested.
static int	STATUS_UNAVAILABLE Access Point Status constant: Indicates that the status of the Access Point is UnAvailable.

Fields inherited from class java.io.Serializable

serialVersionUID

Method Summary

Mtp3SapMO	getMtp3Sap() Returns the MTP3 Access Point representing the MTP used by this SCCP.
int	getSapStatus() Returns the availability status of this SCCP
SubSystemMO	getSubSystemNumber() Gets the SubSystem of this SccpSap.
java.lang.Object[]	getUserEntity() Returns the list of the User Entities of this SCCP SAP.
java.lang.Object	getUserEntity(int index) Returns the User Entity at the specified point of the User Entitty Array.
void	setMtp3Sap(Mtp3SapMO mtp3Sap) Sets the MTP3 Access Point representing the MTP used by this SCCP.
void	setSubSystem(SubSystemMO ssn) Sets the SubSystem of this SccpSap.
void	setUserEntity(int index, java.lang.Object userEntity) Set this User Entitiy as the specified element in the User Entity Array of this Service Access Point.
void	setUserEntity(java.lang.Object[] userEntity) Set the list of User Entities that are using the Service Access Point.

Methods inherited from interface jain.protocol.ss7.oam.sccp.SccpManagedObject

addSccpAlarmListener, addSccpErrorListener, removeSccpAlarmListener, removeSccpErrorListener

Methods inherited from interface jain.protocol.ss7.oam.OamManagedObject

addPropertyChangeListener, getName, removePropertyChangeListener, setName

Field Detail

STATUS_AVAILABLE

public static final int STATUS_AVAILABLE

Access Point Status constant: Indicates that the status of the Access Point is Available. This constant has an integer value of 1.

STATUS_UNAVAILABLE

public static final int STATUS_UNAVAILABLE

Access Point Status constant: Indicates that the status of the Access Point is UnAvailable. This constant has an integer value of 2.

STATUS_DEGRADED

public static final int STATUS_DEGRADED

Access Point Status constant: Indicates that the status of the Access Point is Congested. This constant has an integer value of 3.

Method Detail

setUserEntity

public void setUserEntity(int index,
                          java.lang.Object userEntity)

Set this User Entitiy as the specified element in the User Entity Array of this Service Access Point. For this SCCP Access Point the User Entities will be instances of the SCCP subsystem.

Parameters:

index - the index of the element to be added.

userEntity - the User Entity to be added.

setUserEntity

public void setUserEntity(java.lang.Object[] userEntity)

Set the list of User Entities that are using the Service Access Point. For this SCCP Access Point the User Entities will be instances of the SCCP subsystem.

Parameters:

userEntity - the User Entity to be added.

getUserEntity

public java.lang.Object getUserEntity(int index)

Returns the User Entity at the specified point of the User Entitty Array.

Returns:

the User Entity list.

getUserEntity

public java.lang.Object[] getUserEntity()

Returns the list of the User Entities of this SCCP SAP.

Returns:

the User Entity list

setSubSystem

public void setSubSystem(SubSystemMO ssn)
                  throws java.beans.PropertyVetoException

Sets the SubSystem of this SccpSap.

Parameters:

ssn - the SubSystem of this Access Point

Throws:

PropertyVetoException - thrown if the proposed attribute change is unacceptable.

getSubSystemNumber

public SubSystemMO getSubSystemNumber()

Gets the SubSystem of this SccpSap.

Returns:

the SubSystem of this Access Point

setMtp3Sap

public void setMtp3Sap(Mtp3SapMO mtp3Sap)

Sets the MTP3 Access Point representing the MTP used by this SCCP.

Parameters:

mtp3Sap - the MTP3 Access Point of this SCCP

getMtp3Sap

public Mtp3SapMO getMtp3Sap()

Returns the MTP3 Access Point representing the MTP used by this SCCP.

Returns:

the MTP3 Access Point of this SCCP

getSapStatus

public int getSapStatus()

Returns the availability status of this SCCP

Returns:

either:

• STATUS_AVAILABLE - The Access Point is reachable and functioning normally.
• STATUS_UNAVAILABLE - The Access Point is not reachable.
• STATUS_DEGRADED - The Access Point is congested.