com.adaptris.core

Class DefaultEventHandler

java.lang.Object

com.adaptris.core.EventHandlerBase

com.adaptris.core.DefaultEventHandler

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, EventHandler, StateManagedComponent

@ComponentProfile(summary="Sends MessageLifecycleEvents to the specified location",
                  tag="base,events")
public class DefaultEventHandler
extends EventHandlerBase

Basic implementation of EventHandler.

In the adapter configuration file this class is aliased as default-event-handler which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.EventHandlerBase

EventHandlerBase.EventEmissary

Field Summary

Fields inherited from class com.adaptris.core.EventHandlerBase

eventProducerDelegate, log

Constructor Summary

Constructors

Constructor and Description
DefaultEventHandler()
DefaultEventHandler(AdaptrisConnection connection, AdaptrisMessageProducer producer)
DefaultEventHandler(AdaptrisMessageProducer producer)

Method Summary

Modifier and Type	Method and Description
protected void	eventHandlerClose()
protected void	eventHandlerInit()
protected void	eventHandlerStart()
protected void	eventHandlerStop()
AdaptrisConnection	getConnection() Returns the AdaptrisConnection to use.
AdaptrisMessageProducer	getProducer() Returns the AdaptrisMessageProducer to use.
void	prepare() Prepare for initialisation.
AdaptrisMessageSender	retrieveProducer()
void	setConnection(AdaptrisConnection c) Sets the AdaptrisConnection to use.
void	setProducer(AdaptrisMessageProducer p) Sets the AdaptrisMessageProducer to use.

Methods inherited from class com.adaptris.core.EventHandlerBase

changeState, close, currentMarshaller, currentMessageFactory, getLogAllExceptions, getMarshaller, getMessageFactory, getShutdownWaitSeconds, getUniqueId, init, registerSourceId, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveSourceId, send, send, setLogAllExceptions, setMarshaller, setMessageFactory, setShutdownWaitSeconds, setUniqueId, shutdownWaitSeconds, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEventHandler

public DefaultEventHandler()

DefaultEventHandler

public DefaultEventHandler(AdaptrisMessageProducer producer)

DefaultEventHandler

public DefaultEventHandler(AdaptrisConnection connection,
                           AdaptrisMessageProducer producer)

Method Detail

retrieveProducer

public AdaptrisMessageSender retrieveProducer()

Specified by:

retrieveProducer in class EventHandlerBase

eventHandlerInit

protected void eventHandlerInit()
                         throws CoreException

Specified by:

eventHandlerInit in class EventHandlerBase

Throws:

CoreException

See Also:

ComponentLifecycle.init()

eventHandlerStart

protected void eventHandlerStart()
                          throws CoreException

Specified by:

eventHandlerStart in class EventHandlerBase

Throws:

CoreException

See Also:

ComponentLifecycle.start()

eventHandlerStop

protected void eventHandlerStop()

Specified by:

eventHandlerStop in class EventHandlerBase

See Also:

ComponentLifecycle.stop()

eventHandlerClose

protected void eventHandlerClose()

Specified by:

eventHandlerClose in class EventHandlerBase

See Also:

ComponentLifecycle.close()

setConnection

public void setConnection(AdaptrisConnection c)

Sets the AdaptrisConnection to use. May not be null.

Parameters:

c - the AdaptrisConnection to use

getConnection

public AdaptrisConnection getConnection()

Returns the AdaptrisConnection to use.

Returns:

the AdaptrisConnection to use

setProducer

public void setProducer(AdaptrisMessageProducer p)

Sets the AdaptrisMessageProducer to use. May not be null.

Parameters:

p - the AdaptrisMessageProducer to use

getProducer

public AdaptrisMessageProducer getProducer()

Returns the AdaptrisMessageProducer to use.

Returns:

the AdaptrisMessageProducer to use

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException