IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.event
Interface Notifier

All Known Subinterfaces:
CSClientService, CSServerService, CSServerService
All Known Implementing Classes:
BTTNotifier, CSClient, CSServer, MirrorNotifier

public interface Notifier

This interface provides its implementors with the capability to send and process event notifications. A class that sends event notifications must implement the Notifier interface or be a subclass of BTTNotifier. The Notifier constructor registers a new Notifier instance to the EventManager. The EventManager can then manage the registering of Handlers for local or remote events in a transparent way for the application.

This class originated from com.ibm.dse.base.Notifer. It would be referred by some event model major classes and to conform to the need to consolidate all related event model classes into one package, it is relocated in com.ibm.btt.event.

Code chage summary : None.

Each class that includes the Handler interface must implement all of these methods.


Method Summary
 java.lang.String getName()
          Returns the name of Notifier.
 void setName(java.lang.String aName)
          Sets the name of Notifier.
 void signalEvent(java.lang.String anEventName)
          This method is to fire the event.
 void signalEvent(java.lang.String anEventName, java.util.Hashtable aParametersTable)
          This method is to fire the event.
 void terminate()
          This is a housekeeping process for Notifier instances.
 

Method Detail

getName

java.lang.String getName()
Returns the name of Notifier.

Returns:
java.lang.String

setName

void setName(java.lang.String aName)
Sets the name of Notifier.

Parameters:
aName - java.lang.String

signalEvent

void signalEvent(java.lang.String anEventName)
                 throws DSEInvalidArgumentException
This method is to fire the event. The fired event name is as specified name anEventName.

Parameters:
anEventName - java.lang.String
Throws:
DSEInvalidArgumentException

signalEvent

void signalEvent(java.lang.String anEventName,
                 java.util.Hashtable aParametersTable)
                 throws DSEInvalidArgumentException
This method is to fire the event. The fired event name is as specified name anEventName and the second parameter is a Hashtable params in which user can put any information that needs to go with event object to event manager.

Parameters:
anEventName - java.lang.String
aParametersTable - java.util.Hashtable
Throws:
DSEInvalidArgumentException

terminate

void terminate()
               throws DSEException
This is a housekeeping process for Notifier instances. Subclasses should overwrite this implementation to perform whatever actions are needed to release all the resources acquired by the notifier.

Throws:
DSEException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009