jain.protocol.ss7.tcap
Interface JainTcapListener


public abstract interface JainTcapListener
extends java.util.EventListener

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. It must be noted that any object that implements the:

The Events emitted by a JainTcapProviderImpl may be one of two types:

A TCAP User application will only receive Dialogue and Component handling indication Events once it has registered as an EventListener of a JainTcapProviderImpl. The User application will register with the JainTcapProviderImpl with an User Address by invoking the ProviderImpl's addJainTcapListener() method. Any Events addressed to a User Address belonging to an User Application will be passed to that User application.

The User application will use the JainTcapProviderImpl to send TCAP messages by sending Dialogue Request Events and Component Request Events to that JainTcapProviderImpl. These Events will be handled by the JainTcapProviderImpl's sendComponentReqEvent() and sendDialogueReqEvent() methods. The User application must send Dialogue Request Events with the same Originating Transaction Id to the same JainTcapProviderImpl.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
JainTcapProvider

Method Summary
 void addUserAddress(TcapUserAddress userAddress)
          Adds a TcapUserAddress to the vector of User Addresses used by a JainTcapListenerImpl.
 java.util.Vector getUserAddressList()
          Returns the list of User Addresses used by this JainTcapListenerImpl.
 void processComponentIndEvent(ComponentIndEvent event)
          Processes a Component Indication Event emitted by the JainTcapProvider.
 void processDialogueIndEvent(DialogueIndEvent event)
          Processes a Dialogue Indication Event emitted by the JainTcapProvider.
 void processTcapError(TcapErrorEvent error)
          Processes an error Event emitted by a JainTcapProvider.
 void removeUserAddress(TcapUserAddress userAddress)
          Removes a TcapUserAddress from the list of User Addresses used by a JainTcapListenerImpl.
 

Method Detail

processComponentIndEvent

public void processComponentIndEvent(ComponentIndEvent event)
Processes a Component Indication Event emitted by the JainTcapProvider. Similiar to TCAP the restriction that Indications events can only passed from TCAP (the JainTcapProviderImpl) to the Tcap User (JainTcapListenerImpl), is enforced by the JAIN TCAP Event hierarchy. error checking within the specification, to ensure like TCAP processing
Parameters:
event - the Component Indication Event to be processed.

processDialogueIndEvent

public void processDialogueIndEvent(DialogueIndEvent event)
Processes a Dialogue Indication Event emitted by the JainTcapProvider. Similiar to TCAP the restriction that Indications events can only passed from TCAP (the JainTcapProviderImpl) to the Tcap User (JainTcapListenerImpl), is enforced by the JAIN TCAP Event hierarchy.
Parameters:
event - The Dialogue Indication Event to be processed.

processTcapError

public void processTcapError(TcapErrorEvent error)
Processes an error Event emitted by a JainTcapProvider. A provider will fire this event to all registered JainTcapListeners whenever it encounters an error that cannot be handled through regular TCAP error handling mechanisms.
Parameters:
error - the error event to be processed.

addUserAddress

public void addUserAddress(TcapUserAddress userAddress)
Adds a TcapUserAddress to the vector of User Addresses used by a JainTcapListenerImpl. A JainTcapListenerImpl may choose to register as an Event Listener of a JainTcapProvider for all of its User Addresses. Any Tcap messages addressed to any of this JainTcapListenerImpls' User Addresses will be passed to this JainTcapListenerImpl as events by the JainTcapProviderImpl.
Parameters:
userAddress - the User Address to be added to this JainTcapListenerImpl's vector of User Addresses.

removeUserAddress

public void removeUserAddress(TcapUserAddress userAddress)
Removes a TcapUserAddress from the list of User Addresses used by a JainTcapListenerImpl.
Parameters:
userAddress - the User Address to be removed from this JainTcapListenerImpl's vector of User Addresses.

getUserAddressList

public java.util.Vector getUserAddressList()
Returns the list of User Addresses used by this JainTcapListenerImpl.
Returns:
the vector of User Addresses used by this JainTcapListenerImpl.


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems