Package com.adaptris.core

Class StandardWorkflow

java.lang.Object

com.adaptris.core.WorkflowImp

com.adaptris.core.StandardWorkflowImpl

com.adaptris.core.StandardWorkflow

All Implemented Interfaces:

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

Direct Known Subclasses:

JmsTransactedWorkflow, LargeMessageWorkflow, MultiProducerWorkflow, RequestReplyWorkflow

@ComponentProfile(summary="Basic Single Threaded Workflow",
                  tag="workflow,base")
public class StandardWorkflow
extends StandardWorkflowImpl

Standard implementation of Workflow. Links specific destinations in a Channel. Consumes AdaptrisMessages from a single ConsumeDestination, processes these messages using a ServiceCollection, then produces the processed message using a AdaptrisMessageProducer. In the event of an Exception processing a message, passes the problem message to a configured AdaptrisMessageListener.

In the adapter configuration file this class is aliased as standard-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	Description
StandardWorkflow()
StandardWorkflow(AdaptrisMessageConsumer consumer, AdaptrisMessageProducer producer)
StandardWorkflow(AdaptrisMessageConsumer consumer, ServiceCollection services, AdaptrisMessageProducer producer)

Method Summary

Modifier and Type	Method	Description
void	onAdaptrisMessage(AdaptrisMessage msg, java.util.function.Consumer<AdaptrisMessage> success, java.util.function.Consumer<AdaptrisMessage> failure)	Handle a message with call back actions if a message is successful or failed.

Methods inherited from class com.adaptris.core.StandardWorkflowImpl

closeWorkflow, handleMessage, initialiseWorkflow, prepareWorkflow, resubmitMessage, startWorkflow, stopWorkflow

Methods inherited from class com.adaptris.core.WorkflowImp

addConsumeLocation, addInterceptor, changeState, channelUnavailableWait, close, copyExceptionHeaders, disableMessageCount, doProduce, friendlyName, getChannelUnavailableWaitInterval, getComments, getConsumer, getDisableDefaultMessageCount, getInterceptors, getMessageErrorHandler, getMessageLogger, getProduceExceptionHandler, getProducer, getSendEvents, getServiceCollection, getUniqueId, handleBadMessage, handleBadMessage, handleChannelUnavailable, handleProduceException, init, lastStartTime, lastStopTime, logSuccess, messageLogger, obtainChannel, obtainWorkflowId, prepare, processingStart, registerActiveMsgErrorHandler, registerChannel, registerEventHandler, requestClose, requestInit, requestStart, requestStop, retrieveActiveMsgErrorHandler, retrieveComponentState, sendEvents, sendMessageLifecycleEvent, setChannelUnavailableWaitInterval, setComments, setConsumer, setDisableDefaultMessageCount, setInterceptors, 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

Methods inherited from interface com.adaptris.core.AdaptrisMessageListener

onAdaptrisMessage, onAdaptrisMessage

Constructor Detail

StandardWorkflow

public StandardWorkflow()

StandardWorkflow

public StandardWorkflow(AdaptrisMessageConsumer consumer,
                        AdaptrisMessageProducer producer)

StandardWorkflow

public StandardWorkflow(AdaptrisMessageConsumer consumer,
                        ServiceCollection services,
                        AdaptrisMessageProducer producer)

Method Detail

onAdaptrisMessage

public void onAdaptrisMessage(AdaptrisMessage msg,
                              java.util.function.Consumer<AdaptrisMessage> success,
                              java.util.function.Consumer<AdaptrisMessage> failure)

Description copied from interface: AdaptrisMessageListener

Handle a message with call back actions if a message is successful or failed.

Specified by:

onAdaptrisMessage in interface AdaptrisMessageListener

Overrides:

onAdaptrisMessage in class StandardWorkflowImpl

Parameters:

msg - the message

success - called on success

failure - called on failure