Package jain.protocol.ss7.tcap

This package contains the main interfaces required to represent JAIN TCAP protocol stacks, JAIN TCAP applications, as well as the Classes and Exceptions needed to send and receive JAIN TCAP primitives.

See:
Description

Interface Summary

JainTcapListener	This interface defines the methods required by all TCAP user applications to receive and process JAIN TCAP Events that are emitted by an object implementing the JainTcapProvider interface.
JainTcapProvider	This interface must be implemented by any Object representing the JAIN TCAP layer of any SS7 stack that interacts directly with a proprietary (stack vendor specific) implementation of the TCAP layer.
JainTcapStack	This interface defines the methods required to represent a proprietary JAIN TCAP protocol stack, the implementation of which will be vendor specific.

Class Summary

ComponentIndEvent	A ComponentIndEvent is the super class of all Component Indication primitives, which represent TCAP Component Indications sent from a JainTcapProvider to a JainTcapListener .
ComponentReqEvent	A ComponentReqEvent is the superclass of all Component request primitives, which represent TCAP Component requests sent from a JainTcapListener to a JainTcapProvider .
DialogueIndEvent	A DialogueIndEvent is the superclass of all Dialogue Indication primitives, which represent TCAP Dialogue Indications sent from a JainTcapProvider to a JainTcapListener .
DialogueReqEvent	A DialogueReqEvent is the superclass of all Dialogue Request primitives, which represent TCAP Dialogue Requests sent from a JainTcapProvider to a JainTcapListener .
GlobalTitle	Deprecated. As of JAIN TCAP v1.1.
GTIndicator0001	Deprecated. As of JAIN TCAP v1.1.
GTIndicator0010	Deprecated. As of JAIN TCAP v1.1.
GTIndicator0011	Deprecated. As of JAIN TCAP v1.1.
GTIndicator0100	Deprecated. As of JAIN TCAP v1.1.
TcapConstants	Constants used in the "jain.protocol.ss7.tcap" package
TcapErrorEvent	This Event may be emitted by a JainTcapProvider if the Provider encounters an Error that cannot be passed to all registered JainTcapListeners through normal TCAP error handling mechanisms.
TcapUserAddress	Deprecated. As of JAIN TCAP v1.1.

Exception Summary

InvalidUserAddressException	Deprecated. As of JAIN TCAP v1.1.
ProviderNotAttachedException	Deprecated. As of JAIN TCAP v1.1.
TcapException	Deprecated. As of JAIN TCAP v1.1.
UnableToDeleteProviderException	Deprecated. As of JAIN TCAP v1.1.

Package jain.protocol.ss7.tcap Description

This package contains the main interfaces required to represent JAIN TCAP protocol stacks, JAIN TCAP applications, as well as the Classes and Exceptions needed to send and receive JAIN TCAP primitives. The implementation of the two stack vendor specific interfaces, namely JainTcapStack and JainTcapProvider will be vendor specific, however the naming of these proprietory implementations is mandated. The class name of the vendor specific implementations must be the JAIN TCAP "InterfaceName" of which that class implements with "Impl" appended to the end of it. For example a vendor implementation of the JainTcapStack Interface must be called "JainTcapStackImpl". Therefore once each vendor has implemented the JAIN TCAP API specification they must has two proprietary classes called JainTcapStackImpl.class and JainTcapProviderImpl.class. The characteristics of the three main interfaces are listed below:

• JainTcapStack: This Interface defines the minimial management properties that enables the JAIN TCAP API specification to operate independently of the JAIN OAM API Specification. Therefore the JainTcapStack Object is a representation of the main management functionality of the TCAP layer, as well as the central point for the creation of JainTcapProviders. From within the JainTcapStack Object it is possible for any application to get a list of JainTcapProvider objects that are attached to the underlying JainTcapStack by using the getProviderList method with the JainTcapStack Object. This method returns an ArrayList of JainTcapProvider references of which a JainTcapListener Object may register. Similiarly if the JainTcapStack Object has no JainTcapProviders attached to it, the JainTcapListener may use the createProvider method to create a new JainTcapProvider object.
  
  
  
• JainTcapProvider: This Interface defines the methods for adding JainTcapListeners to, and removing JainTcapListeners from a list of registered JainTcapListeners held within the JainTcapProvider. The JainTcapListener registers with a JainTcapProvider with a User Address, this is explained in more detail in the definition of a JainTcapListener below. Other methods defined within the JainTcapProvider provide the functionality for a JainTcapListener to obtain a Dialogue with another JainTcapListener based on a Dialogue Id. The JainTcapProvider also defines the functionality to obtain Invoke Id's based on a specific Dialogue Id, that enables a JainTcapListener to Invoke operations on another JainTcapListener to which a Dialogue has been initiated. In order for communication to take place between a local JainTcapListener and a remote JainTcapListener, the local JainTcapListener must send a number of Component Request Events interspersed by Dialogue Request Events to it's associated JainTcapProvider. The Jain User Address of the remote JainTcapListener should be set in the appropriate Dialogue Request Events.
  
  
  
• JainTcapListener: This Interface defines the methods required by all JainTcapListeners to receive and process Events that are emitted by a JainTcapProvider. A remote JainTcapProvider which receives Component Indications and a Dialogue Indication (which were sent by the local JainTcapListener) out of the TCAP layer of its SS7 protocol stack, encapsulates them as Events and passes them to the remote JainTcapListener. As mentioned above this occurs by Event passing, were the remote JainTcapProvider invokes the processComponentIndEvent and processDialogueIndEvent as appropriate and passes the relevant Event within the method to the remote JainTcapListener. The same process occurs when the local JainTcapProvider passes Indication Events (received from the remote JainTcapListener) to the local JainTcapListener.
  
  
  • A JainTcapListener registers with a JainTcapProvider to become an Event Listener of that JainTcapProvider, it registers with an object reference to itself and its Jain User Address. These two values are stored by the JainTcapProvider and the Jain User Address is used as a lookup to obtain an object reference to a specific JainTcapListener. The Jain User Address is used for the routing of Tcap messages between various local and remote JainTcapListeners.
    
    
  • A JainTcapListener may have multiple Tcap User Addresses, which enables it to operate over a number of Sub-Systems, however the JainTcapListener may only register with a JainTcapProvider, with only one Tcap User Address at any specific time. For example if a specific JainTcapListenerImpl (application developer specific implementation of the JainTcapListener interface), which operates over two Jain User Addresses, wants to register itself for both tcap User Adresses with the same JainTcapProviderImpl (vendor specific implementation of the JainTcapProvider interface), then the JainTcapListenerImpl will have to invoke the addJainTcapListener method within the JainTcapProviderImpl twice, once for each Jain User Address.
    
  • The Jain User Address methods defined within the JainTcapListener interface, provide the functionality that enables the JainTcapListenerImpl to manipulate and maintain the list of Tcap User Addresses it supports.

Note:

The cardinality of the relationship between JainTcapListeners and JainTcapProviders is not restricted in any way. The restriction of this cardinality is dependent on a vendors specific implementation of the JAIN TCAP API, were the necessary exceptions are thrown if the specificied cardinality is violated. However it is mandated that there may only be one JainTcapStack Object for the TCAP Layer of an SS7 protocol stack.