jain.protocol.ss7.oam
Interface OamLayerManager
- All Known Subinterfaces:
- Mtp2LayerManager, Mtp3LayerManager, SccpLayerManager, TcapLayerManager
- public abstract interface OamLayerManager
This interface defines the methods common to all Protocol Layer Managers.
It defines the methods to:
- Commit all operations on any
Managed Objects in this layer.
- Get the current configuration of the SS7 Stack being managed.
Invoking this method will create instances of Managed Objects for
each physical element in the system and create the necessary
associations between them.
- Dynamically configure the Protocol Variant supported by this Protocol
Layer Manager
Method Summary |
void |
commit()
Commit all operations on any Managed Objects
in this layer. |
int |
getProtocolVariant()
Returns the Protocol Variant of the SS7 Protocol Layer represented by this
OamLayerManager. |
int |
getProtocolYear()
Returns the particular year of the the Protocol variant's recommendations that
are supported by the Protocol Layer represented by this Layer Manager. |
java.lang.String |
getVendorDetails()
Returns a String that identifies the Vendor that supplied this
implementation. |
void |
readCurrentConfiguration()
Gets the current configuration of the SS7 Layer being managed. |
void |
setProtocolVariant(int variant)
Sets the protocol variant of the SS7 Protocol Layer represented by this
OamLayerManager. |
void |
setProtocolYear(int protocolYear)
Sets the particular year of the the Protocol variant's recommendations that
are to be supported by the Protocol Layer. |
PROTOCOL_VARIANT_ANSI
public static final int PROTOCOL_VARIANT_ANSI
- A Protocol Version constant: ANSI Protocol
PROTOCOL_VARIANT_ITU
public static final int PROTOCOL_VARIANT_ITU
- A Protocol Version constant: ITU Protocol
PROTOCOL_VARIANT_OTHER
public static final int PROTOCOL_VARIANT_OTHER
- A Protocol Version constant: a protocol other then ITU or ANSI
commit
public void commit()
throws CommitException
- Commit all operations on any Managed Objects
in this layer.
The implementation of this method shall commit all operations to the underlying
proprietary management system.
Successfully invoking the 'commit()' command shall have three separate consequences:
- When an application requests the creation of a MO from this Layer Maneger,
the Layer Manager should create an instance of the appropriate MO.
Only when this commit() method has been invoked should the corresponding element
be committed to the underlying proprietary management system.
- When the attributes of a MO are modified, the attribute values will be changed in that MO.
Only when this commit() method has been invoked shall the changes be propagated to the
underlying proprietary management system.
- When an application requests the deletion of a MO from a Layer Manager,
that MO should be tagged 'for deletion', but the corresponding element
should not be deleted from the underlying proprietary management system until
this commit() method has been invoked.
- Throws:
- CommitException - - if any of the operations to be committed were not
committed successfully. This CommitException shall list the operations
to were to be committed and will indicate whether or not each operation was
successfully committed.
readCurrentConfiguration
public void readCurrentConfiguration()
throws ReadConfigurationException
- Gets the current configuration of the SS7 Layer being managed.
Invoking this method will create instances of Managed Objects for
each physical element in the system and create the necessary
associations between them
- Throws:
- ReadConfigurationException - - if an error is encountered while attempting to
establish the current system configuration or while creating the Managed Objects that
represent the current system configuration.
getVendorDetails
public java.lang.String getVendorDetails()
- Returns a String that identifies the Vendor that supplied this
implementation.
- Returns:
- a string identifying the Vendor implementation
getProtocolVariant
public int getProtocolVariant()
- Returns the Protocol Variant of the SS7 Protocol Layer represented by this
OamLayerManager. The particular year of the the Protocol variant's recommendations can
be established by calling the
setProtocolVariant
public void setProtocolVariant(int variant)
throws java.lang.UnsupportedOperationException,
java.lang.IllegalArgumentException
- Sets the protocol variant of the SS7 Protocol Layer represented by this
OamLayerManager. If the underlying SS7 Stack has the the capability of being
configured dynamically as to what variant of the protocol is it supporting
then this method will dynamically configure the stack.
- Parameters:
variant
- the Protocol Variant that this Protocol Layer shall be
configured to.- Returns:
- one of the following:
- PROTOCOL_VARIANT_ANSI
- PROTOCOL_VARIANT_ITU
- PROTOCOL_VARIANT_OTHER
- Throws:
- java.lang.UnsupportedOperationException - if the implementation does not support the configuration
of the protocol variant (i.e. ProtocolVariant is a read-only value).
- java.lang.IllegalArgumentException - - if the suplied protocol variant is not one of the defined types
setProtocolYear
public void setProtocolYear(int protocolYear)
throws java.lang.UnsupportedOperationException,
java.lang.IllegalArgumentException
- Sets the particular year of the the Protocol variant's recommendations that
are to be supported by the Protocol Layer.
If the underlying SS7 Stack has the the capability of being
configured dynamically then this method will dynamically configure the stack. For example,
if the ProtocolVariant of this Protocol Layer is PROTOCOL_VARIANT_ITU
then a value of 1993 or 1997 could be supplied as the protocolYear
to configure the particular set of ITU Reccommendations supported.
- Parameters:
protocolYear
- the year of protocol variant's recommendations (in the format yyyy).- Throws:
- java.lang.UnsupportedOperationException - if the implementation does not support the configuration
of the protocol year (i.e. ProtocolYear is a read-only value).
- java.lang.IllegalArgumentException - - if the suplied protocol year is in an incorrect format
getProtocolYear
public int getProtocolYear()
- Returns the particular year of the the Protocol variant's recommendations that
are supported by the Protocol Layer represented by this Layer Manager. For example,
if the ProtocolVariant of this Protocol Layer is PROTOCOL_VARIANT_ITU
then this method might return 1993 or 1997 to distinguish the
particular set of ITU Recommendations supported.
- Returns:
- the protocol year in the format yyyy.
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