raccoon.tibco.tibrv.admin
Class AdminHandler

java.lang.Object
  raccoon.tibco.tibrv.admin.AdminHandler

All Implemented Interfaces:

IEventHandler

public class AdminHandler
extends java.lang.Object
implements IEventHandler

The administrative message handler.

Since:

Raccoon v1.0

Version:

$Id:$

Author:

Cedric ROUVRAIS

Constructor Summary

AdminHandler(ILogger pLogger)
Default constructor.

Method Summary

java.lang.String	getHandlerName() Returns the unique logical name of this event handler.
boolean	isRunning() Should return true if this instance is active.
void	onEvent(java.lang.Object pEventObject, ITracking pEventTracking) Invoked when the shutdown command is received.
void	start() Invoked by the subscribing application to inform the handler that it must load itself.
void	stop() Invoked by the subscribing application to inform the handle that it must shut down.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminHandler

public AdminHandler(ILogger pLogger)

Default constructor.

Parameters:

pLogger - the logging service that this component will use.

Method Detail

onEvent

public void onEvent(java.lang.Object pEventObject,
                    ITracking pEventTracking)
             throws RaccoonException

Invoked when the shutdown command is received.

Specified by:

onEvent in interface IEventHandler

Parameters:

pEventObject - the java object that was received by the subscriber

pEventTracking - the tracking element related to this event.

Throws:

RaccoonException - the only type of exception you have the right to throw.

getHandlerName

public java.lang.String getHandlerName()

Returns the unique logical name of this event handler. This logical name is used to selectively start/stop event handlers, it must be unique per subscriber.

Specified by:

getHandlerName in interface IEventHandler

Returns:

the logical name of this event handler

start

public void start()
           throws RaccoonException

Invoked by the subscribing application to inform the handler that it must load itself.

Specified by:

start in interface IEventHandler

Throws:

RaccoonException - if the handler couldn't load itself.

stop

public void stop()
          throws RaccoonException

Invoked by the subscribing application to inform the handle that it must shut down.

Specified by:

stop in interface IEventHandler

Throws:

RaccoonException - if the event handler can't shut down.

isRunning

public boolean isRunning()

Should return true if this instance is active.

Specified by:

isRunning in interface IEventHandler

Returns:

boolean the state of this event handler.