IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.event
Class BTTNotifier

java.lang.Object
  extended by com.ibm.btt.event.BTTNotifier
All Implemented Interfaces:
Notifier

public class BTTNotifier
extends java.lang.Object
implements Notifier

BTTNotifier class provides the capability of processing event notifications and sending event notifications to Message Queue.


Field Summary
static java.lang.String COPYRIGHT
           
protected  java.util.Hashtable handlersList
          Handler list stores all the handlers which interest in this notifer.
protected  java.lang.String name
          BTTNotifer's Name
protected  JMSEvTransmit transmit
          Init_Transmit BTTNotifer's JMSEvTransmit
 
Constructor Summary
BTTNotifier()
          This constructor creates a BTTNotifier object.
BTTNotifier(java.lang.String aName)
          This constructor creates a BTTNotifier with a name.
 
Method Summary
 java.lang.String getName()
          Gets the name attribute value.
 JMSEvTransmit getTransmit()
          Returns JMSEvTransmit instance.
 void setName(java.lang.String aName)
          Sets the notifier name to aName
 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()
          Provides a housekeeping process for the notifier instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

name

protected java.lang.String name
BTTNotifer's Name


handlersList

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


transmit

protected JMSEvTransmit transmit
Init_Transmit BTTNotifer's JMSEvTransmit

Constructor Detail

BTTNotifier

public BTTNotifier()
This constructor creates a BTTNotifier object.


BTTNotifier

public BTTNotifier(java.lang.String aName)
This constructor creates a BTTNotifier with a name.

This constructor creates a BTTNotifier with name aName and register in event manager through a message queue.

Parameters:
aName - java.lang.String
Method Detail

getName

public java.lang.String getName()
Gets the name attribute value.

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

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

public void signalEvent(DSEEventObject anEvent)
                 throws DSEInvalidArgumentException
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.ibm.btt.event.DSEEventObject
Throws:
DSEInvalidArgumentException

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 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
Provides a housekeeping process for the notifier instance.

Specified by:
terminate in interface Notifier
Throws:
DSEException

getTransmit

public JMSEvTransmit getTransmit()
Returns JMSEvTransmit instance. Each BTT Notifier has a JMSEvTransmit instance which sends event to event manager via a message queue.

Returns:
com.ibm.btt.event.JMSEvTransmit

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009