IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.event
Class MirrorNotifier

java.lang.Object
  extended bycom.ibm.btt.event.MirrorNotifier
All Implemented Interfaces:
Notifier

public class MirrorNotifier
extends java.lang.Object
implements Notifier

A Mirror Notifier represents a BTT Notifier in Event Manager. When a BTT Notifier is created, a corresponding Mirror Notifier is also created and registered in Event Manager.


Field Summary
protected  java.util.Hashtable handlersList
          Handler list stores all the handlers which interest in this notifier.
protected  java.lang.String name
          This constructor creates a MirrorNotifier object.
 
Constructor Summary
MirrorNotifier()
          This constructor creates a MirrorNotifier object.
MirrorNotifier(java.lang.String aName)
          This constructor creates a MirrorNotifier object with its name attribute set to aName.
 
Method Summary
protected  void addBTTMirrorHandler(MirrorHandler aHandler, java.lang.String anEventName)
          Stores BTT Mirror Handler in interested event list.
 MirrorHandler containsMirrorHandler(java.lang.String anEventName, java.lang.String GlobalHandlerID)
          Checks whether Mirror Notifier's handler list for a specified event contains a specified MirrorHandler.
 java.util.Hashtable getHandlersList()
          Returns the handler list .
 java.lang.String getName()
          Returns the Mirror Notifier's name.
 void removeBTTMirrorHandler(java.lang.String anEventName, java.lang.String aHandlerGlobalID)
          Removes a BTT Mirror Handler from the BTT Mirror Handler List.
 void setName(java.lang.String aName)
          Sets the notifier name to aName.
protected  void signalEvent(DSEEventObject anEvent)
          This method is to fire the event.
 void signalEvent(java.lang.String anEventName)
          This method is to fire the event.
 void signalEvent(java.lang.String anEventName, java.util.Hashtable params)
          This method is to fire the event.
 void terminate()
          This is a method in interface com.ibm.btt.event.Notifier.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name
This constructor creates a MirrorNotifier object.


handlersList

protected java.util.Hashtable handlersList
Handler list stores all the handlers which interest in this notifier.

Constructor Detail

MirrorNotifier

public MirrorNotifier()
This constructor creates a MirrorNotifier object.


MirrorNotifier

public MirrorNotifier(java.lang.String aName)
This constructor creates a MirrorNotifier object with its name attribute set to aName.

Parameters:
aName - java.lang.String
Method Detail

addBTTMirrorHandler

protected void addBTTMirrorHandler(MirrorHandler aHandler,
                                   java.lang.String anEventName)
                            throws DSEInvalidArgumentException
Stores BTT Mirror Handler in interested event list.

Throws:
DSEInvalidArgumentException

containsMirrorHandler

public MirrorHandler containsMirrorHandler(java.lang.String anEventName,
                                           java.lang.String GlobalHandlerID)
Checks whether Mirror Notifier's handler list for a specified event contains a specified MirrorHandler.

Parameters:
anEventName - java.lang.String
GlobalHandlerID - java.lang.String
Returns:
com.ibm.btt.event.MirrorHandler

getHandlersList

public java.util.Hashtable getHandlersList()
Returns the handler list .

Returns:
java.util.Hashtable

getName

public java.lang.String getName()
Returns the Mirror Notifier's name.

Specified by:
getName in interface Notifier
Returns:
name java.lang.String

removeBTTMirrorHandler

public void removeBTTMirrorHandler(java.lang.String anEventName,
                                   java.lang.String aHandlerGlobalID)
                            throws DSEHandlerNotFoundException
Removes a BTT Mirror Handler from the BTT Mirror Handler List.

Parameters:
anEventName - java.lang.String
aHandlerGlobalID - java.lang.String
Throws:
DSEHandlerNotFoundException

setName

public void setName(java.lang.String aName)
Sets the notifier name to aName.

Specified by:
setName in interface Notifier
Parameters:
aName - java.lang.String

signalEvent

protected void signalEvent(DSEEventObject anEvent)
This method is to fire the event. It takes DSEEventObject as a parameter. When this method is invoked , the instance of DSEEventObject is sent to event manager via a message queue.

Parameters:
anEvent - com.btt.event.DSEEventObject

signalEvent

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

Specified by:
signalEvent in interface Notifier
Parameters:
anEventName - java.lang.String
Throws:
DSEInvalidArgumentException

signalEvent

public void signalEvent(java.lang.String anEventName,
                        java.util.Hashtable params)
                 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.

Specified by:
signalEvent in interface Notifier
Parameters:
anEventName - java.lang.String
params - java.util.Hashtable
Throws:
DSEInvalidArgumentException

terminate

public void terminate()
               throws DSEException
This is a method in interface com.ibm.btt.event.Notifier. It does nothing in Mirror Notifier.

Specified by:
terminate in interface Notifier
Throws:
DSEException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005