raccoon.core.file.endpoint.poller.handlers
Class BulkXmlHandler

java.lang.Object
  raccoon.core.file.endpoint.poller.handlers.BulkXmlHandler

All Implemented Interfaces:

IEventHandler

public class BulkXmlHandler
extends java.lang.Object
implements IEventHandler

TODO Document this class.

Since:

Raccoon v1.0

Version:

$Id:$

Author:

Cedric ROUVRAIS

Constructor Summary

BulkXmlHandler()

Method Summary

java.lang.String	getEndToken()
int	getGroupingFactor()
java.lang.String	getHandlerName() Returns the unique logical name of this event handler.
java.lang.String	getStartToken()
java.lang.String	getXmlTail()
boolean	isRunning() Should return true if this instance is active.
void	onEvent(java.lang.Object pEventObject, ITracking pEventTracking) Handles the incoming EAI Event.
void	setEndToken(java.lang.String pEndToken)
void	setGroupingFactor(int pGroupingFactor)
void	setStartToken(java.lang.String pStartToken)
void	setXmlTail(java.lang.String pXmlTail)
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

BulkXmlHandler

public BulkXmlHandler()

Method Detail

onEvent

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

Description copied from interface: IEventHandler

Handles the incoming EAI Event.

This method, to be implemented by all EventHandlers, will be invoked each time a message arrives on the subject/topic

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()

Description copied from interface: IEventHandler

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

Description copied from interface: IEventHandler

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

Description copied from interface: IEventHandler

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()

Description copied from interface: IEventHandler

Should return true if this instance is active.

Specified by:

isRunning in interface IEventHandler

Returns:

boolean the state of this event handler.

getStartToken

public java.lang.String getStartToken()

setStartToken

public void setStartToken(java.lang.String pStartToken)

getEndToken

public java.lang.String getEndToken()

setEndToken

public void setEndToken(java.lang.String pEndToken)

getXmlTail

public java.lang.String getXmlTail()

setXmlTail

public void setXmlTail(java.lang.String pXmlTail)

getGroupingFactor

public int getGroupingFactor()

setGroupingFactor

public void setGroupingFactor(int pGroupingFactor)