com.adaptris.core

Class StandardWorkflowImpl

java.lang.Object

com.adaptris.core.WorkflowImp

com.adaptris.core.StandardWorkflowImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

StandardWorkflow

public abstract class StandardWorkflowImpl
extends WorkflowImp

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

Method Summary

Modifier and Type	Method and Description
protected void	closeWorkflow() Close the workflow.
protected void	handleMessage(AdaptrisMessage msg, boolean clone)
protected void	initialiseWorkflow() Initialise the workflow.
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.
protected void	prepareWorkflow()
protected void	resubmitMessage(AdaptrisMessage msg) Resubmit a message upon the channel becoming available again.
protected void	startWorkflow() Start the workflow.
protected void	stopWorkflow() Stop the workflow.

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

StandardWorkflowImpl

public StandardWorkflowImpl()

Method Detail

initialiseWorkflow

protected void initialiseWorkflow()
                           throws CoreException

Description copied from class: WorkflowImp

Initialise the workflow.

Specified by:

initialiseWorkflow in class WorkflowImp

Throws:

CoreException - encapsulating any underlying Exception

See Also:

WorkflowImp.initialiseWorkflow()

startWorkflow

protected void startWorkflow()
                      throws CoreException

Description copied from class: WorkflowImp

Start the workflow.

Specified by:

startWorkflow in class WorkflowImp

Throws:

CoreException - encapsulating any underlying Exception

See Also:

WorkflowImp.startWorkflow()

stopWorkflow

protected void stopWorkflow()

Description copied from class: WorkflowImp

Stop the workflow.

Specified by:

stopWorkflow in class WorkflowImp

See Also:

WorkflowImp.stopWorkflow()

closeWorkflow

protected void closeWorkflow()

Description copied from class: WorkflowImp

Close the workflow.

Specified by:

closeWorkflow in class WorkflowImp

See Also:

WorkflowImp.closeWorkflow()

prepareWorkflow

protected void prepareWorkflow()
                        throws CoreException

Specified by:

prepareWorkflow in class WorkflowImp

Throws:

CoreException

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.

Parameters:

msg - the message

success - called on success

failure - called on failure

resubmitMessage

protected void resubmitMessage(AdaptrisMessage msg)

Description copied from class: WorkflowImp

Resubmit a message upon the channel becoming available again.

Specified by:

resubmitMessage in class WorkflowImp

Parameters:

msg - the AdaptrisMessage.

See Also:

WorkflowImp.resubmitMessage(com.adaptris.core.AdaptrisMessage)

handleMessage

protected void handleMessage(AdaptrisMessage msg,
                             boolean clone)