com.adaptris.core.jms

Class JmsTransactedWorkflow

java.lang.Object

com.adaptris.core.WorkflowImp

com.adaptris.core.StandardWorkflowImpl

com.adaptris.core.StandardWorkflow

com.adaptris.core.jms.JmsTransactedWorkflow

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageListener, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, EventHandlerAware, StateManagedComponent, Workflow

@ComponentProfile(summary="JMS specific workflow that supports rollback of messages",
                  tag="workflow,jms")
public final class JmsTransactedWorkflow
extends StandardWorkflow

Subclass of StandardWorkflow for use with JMS consumers.

This differs from a StandardWorkflow as it assumes that the configured JMS Consumer has a transacted session which needs to informed of any failures so the messages can be rolled back.

Additionally, this workflow may not be configured with any ProduceExceptionHandler as this will not allow the transaction to rolled back correctly. In order to get behaviour similiar to ProduceExceptionHandler, you should use StandaloneProducer as part of the service collection in order to produce the payload to the required destination.

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

Field Summary

Fields inherited from class com.adaptris.core.WorkflowImp

eventHandler, log, startTime, stopTime

Fields inherited from interface com.adaptris.core.Workflow

PREVIOUS_GUID_KEY, WORKFLOW_ID_KEY

Constructor Summary

Constructors

Constructor and Description
JmsTransactedWorkflow()

Method Summary

Modifier and Type	Method and Description
void	doProduce(AdaptrisMessage msg) This method contains the behaviour that varies between standard and request -reply workflows.
java.lang.Boolean	getStrict()
TimeInterval	getWaitPeriodAfterRollback()
protected void	handleBadMessage(java.lang.String logMsg, java.lang.Exception e, AdaptrisMessage msg)
protected void	initialiseWorkflow() Initialise the workflow.
void	setStrict(java.lang.Boolean strict) Set the behaviour of this workflow with regards to failures.
void	setWaitPeriodAfterRollback(TimeInterval interval) set the amount of time to wait after issue a Session.rollback() before continuing processing.
long	waitPeriodAfterRollbackMs()

Methods inherited from class com.adaptris.core.StandardWorkflow

handleMessage, onAdaptrisMessage, resubmitMessage

Methods inherited from class com.adaptris.core.StandardWorkflowImpl

closeWorkflow, prepareWorkflow, startWorkflow, stopWorkflow

Methods inherited from class com.adaptris.core.WorkflowImp

addConsumeLocation, addInterceptor, changeState, channelUnavailableWait, close, copyExceptionHeaders, disableMessageCount, friendlyName, getChannelUnavailableWaitInterval, getComments, getConsumer, getDisableDefaultMessageCount, getInterceptors, getLogPayload, getMessageErrorHandler, getMessageLogger, getProduceExceptionHandler, getProducer, getSendEvents, getServiceCollection, getUniqueId, handleBadMessage, handleChannelUnavailable, handleProduceException, init, lastStartTime, lastStopTime, logSuccess, messageLogger, obtainChannel, obtainWorkflowId, prepare, processingStart, registerActiveMsgErrorHandler, registerChannel, registerEventHandler, requestClose, requestInit, requestStart, requestStop, retrieveActiveMsgErrorHandler, retrieveComponentState, sendMessageLifecycleEvent, setChannelUnavailableWaitInterval, setComments, setConsumer, setDisableDefaultMessageCount, setInterceptors, setLogPayload, setMessageErrorHandler, setMessageLogger, setProduceExceptionHandler, setProducer, setSendEvents, setServiceCollection, setUniqueId, start, stop, workflowEnd, workflowStart

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsTransactedWorkflow

public JmsTransactedWorkflow()

Method Detail

initialiseWorkflow

protected void initialiseWorkflow()
                           throws CoreException

Description copied from class: WorkflowImp

Initialise the workflow.

Overrides:

initialiseWorkflow in class StandardWorkflowImpl

Throws:

CoreException - encapsulating any underlying Exception

See Also:

WorkflowImp.initialiseWorkflow()

doProduce

public void doProduce(AdaptrisMessage msg)
               throws ServiceException,
                      ProduceException

Description copied from class: WorkflowImp

This method contains the behaviour that varies between standard and request -reply workflows. It is overridden in RequestReplyWorkflow.

Specified by:

doProduce in interface Workflow

Overrides:

doProduce in class WorkflowImp

Parameters:

msg - the message to process

Throws:

ServiceException - not thrown by this implementation

ProduceException - if any occur

handleBadMessage

protected void handleBadMessage(java.lang.String logMsg,
                                java.lang.Exception e,
                                AdaptrisMessage msg)

Overrides:

handleBadMessage in class WorkflowImp

getStrict

public java.lang.Boolean getStrict()

setStrict

public void setStrict(java.lang.Boolean strict)

Set the behaviour of this workflow with regards to failures.

When strict mode is enabled, then any exception will cause a rollback on the session; when strict is false, then if a ProcessingExceptionHandler is configured that is not NullProcessingExceptionHandler, the session will not be rolled back.

Parameters:

strict - true or false (default true)

getWaitPeriodAfterRollback

public TimeInterval getWaitPeriodAfterRollback()

waitPeriodAfterRollbackMs

public long waitPeriodAfterRollbackMs()

setWaitPeriodAfterRollback

public void setWaitPeriodAfterRollback(TimeInterval interval)

set the amount of time to wait after issue a Session.rollback() before continuing processing.

Parameters:

interval - the interval, default if not set is 30 seconds.