com.adaptris.core.triggered

Class TriggeredChannel

java.lang.Object

com.adaptris.core.Channel

com.adaptris.core.triggered.TriggeredChannel

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageListener, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, EventHandlerAware, LicensedComponent, StateManagedComponent, StateManagedComponentContainer

public final class TriggeredChannel
extends Channel
implements AdaptrisMessageListener, LicensedComponent

A Channel whose lifecycle is determined by an external configurable trigger.

Workflows configured as part of a TriggeredChannel do not participate in the normal adapter lifecycle until such time as its trigger consumer consumes a message. At that point, the underlying connections and workflows are initialised, and started.

After starting the workflows, the channel blocks and waits for the workflows to terminate, so that it can accept the next trigger. As a result of this behaviour, it only makes sense for the workflows to contain consumers that actively poll the back-end system such as AdaptrisPollingConsumer, rather than consumers that passively wait for activity. Failure to follow these guidelines may lead to undefined behaviour.

Even when using an AdaptrisPollingConsumer implementation the Poller mechanism that should be used should have a finite lifespan such as OneTimePoller so that the workflows terminate as expected. If you opt not to use a poller with a finite lifespan then behaviour may be undefined.

This type of channel also handles errors and events differently. A specific EventHandler may be specified to physically handle MessageLifecycleEvents that are created within the channel. If this is unspecified then the Adapter's EventHandler is used. The rationale behind this behaviour is to treat events as standard AdaptrisMessage objects which then allows message error handling logic to take place.

Any ProcessingExceptionHandler implementation that is used with this Channel implementation must also implement the TriggeredProcessor interface, which simply allows this Channel to interrogate whether processing has been completed by the component or not. This ensures that the channel is not stopped prior to any messages that need to be retried from being retried, thus failing the messages before their time.

See Also:

OneTimePoller, AdaptrisPollingConsumer, TriggeredProcessor

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

License Required: STANDARD

Field Summary

Fields inherited from class com.adaptris.core.Channel

eventHandler, log, startTime, stopTime

Constructor Summary

Constructors

Constructor and Description
TriggeredChannel() Default Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.String	friendlyName()
EventHandler	getEventHandlerForMessages()
AdaptrisMessageFactory	getMessageFactory()
Trigger	getTrigger()
void	init()
boolean	isEnabled(License license)
void	onAdaptrisMessage(AdaptrisMessage msg)
void	prepare()
void	setEventHandlerForMessages(EventHandler eh)
void	setMessageFactory(AdaptrisMessageFactory f) Set the message factory used when creating AdaptrisMessage.
void	setTrigger(Trigger t)
void	start()
void	stop()

Methods inherited from class com.adaptris.core.Channel

changeState, getAutoStart, getComments, getConsumeConnection, getMessageErrorHandler, getProduceConnection, getUniqueId, getWorkflowList, hasUniqueId, isAvailable, lastStartTime, lastStopTime, registerActiveMsgErrorHandler, registerEventHandler, requestChildClose, requestChildInit, requestChildStart, requestChildStop, requestClose, requestInit, requestStart, requestStop, retrieveActiveMsgErrorHandler, retrieveComponentState, setAutoStart, setComments, setConsumeConnection, setMessageErrorHandler, setProduceConnection, setUniqueId, setWorkflowList, shouldStart, toggleAvailability

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggeredChannel

public TriggeredChannel()

Default Constructor.

1. message-error-handler is RetryMessageErrorHandler

Method Detail

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Overrides:

init in class Channel

Throws:

CoreException

See Also:

ChannelList.init()

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class Channel

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class Channel

Throws:

CoreException

See Also:

ChannelList.start()

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class Channel

See Also:

ChannelList.stop()

close

public void close()

Specified by:

close in interface ComponentLifecycle

Overrides:

close in class Channel

See Also:

ChannelList.close()

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent

onAdaptrisMessage

public void onAdaptrisMessage(AdaptrisMessage msg)

Specified by:

onAdaptrisMessage in interface AdaptrisMessageListener

See Also:

AdaptrisMessageListener.onAdaptrisMessage(AdaptrisMessage)

getTrigger

public Trigger getTrigger()

Returns:

the triggerComponent

setTrigger

public void setTrigger(Trigger t)

Parameters:

t - the triggerComponent

getMessageFactory

public AdaptrisMessageFactory getMessageFactory()

Returns:

the messageFactory

setMessageFactory

public void setMessageFactory(AdaptrisMessageFactory f)

Set the message factory used when creating AdaptrisMessage.

Parameters:

f - the messageFactory to set

getEventHandlerForMessages

public EventHandler getEventHandlerForMessages()

Returns:

the eventHandlerForMessages

setEventHandlerForMessages

public void setEventHandlerForMessages(EventHandler eh)

Parameters:

eh - the eventHandlerForMessages to set

friendlyName

public java.lang.String friendlyName()

Specified by:

friendlyName in interface AdaptrisMessageListener