com.adaptris.core

Interface WorkflowInterceptor

All Superinterfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension

All Known Implementing Classes:

InFlightWorkflowInterceptor, JettyAsyncWorkflowInterceptor, JettyNoBacklogInterceptor, JettyPoolingWorkflowInterceptor, JettyWorkflowInterceptorImpl, JmxSubmitMessageInterceptor, LoggingContextWorkflowInterceptor, MessageCountNotification, MessageMetricsInterceptor, MessageMetricsInterceptorByMetadata, MessageMetricsInterceptorImpl, MessageThresholdNotification, MetadataCountInterceptor, MetadataMetricsInterceptorImpl, MetadataTotalsInterceptor, MetricsInterceptorImpl, NotifyingInterceptor, NotifyingInterceptorByCount, SlowMessageNotification, ThrottlingInterceptor, WorkflowInterceptorImpl

public interface WorkflowInterceptor
extends AdaptrisComponent, ComponentLifecycleExtension

Interface for intercepting messages as they enter and exit a workflow.

Method Summary

Modifier and Type	Method and Description
default void	processingStart(AdaptrisMessage inputMsg) Mark the start of processing a message.
void	registerParentChannel(Channel c) Register the parent channel for this WorkflowInterceptor.
void	registerParentWorkflow(Workflow w) Register the parent workflow for this WorkflowInterceptor.
void	workflowEnd(AdaptrisMessage inputMsg, AdaptrisMessage outputMsg) Mark the end of a workflow.
void	workflowStart(AdaptrisMessage inputMsg) Mark the start of a workflow.

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension

prepare

Method Detail

workflowStart

void workflowStart(AdaptrisMessage inputMsg)

Mark the start of a workflow. This doesn't mean the message has started processing but only that the message will - at some point - be processed by the workflow.

Parameters:

inputMsg - the message that will be processed by this workflow.

processingStart

default void processingStart(AdaptrisMessage inputMsg)

Mark the start of processing a message. This method may be called on a different thread from #workflowStart

Parameters:

inputMsg -

workflowEnd

void workflowEnd(AdaptrisMessage inputMsg,
                 AdaptrisMessage outputMsg)

Mark the end of a workflow.

Parameters:

inputMsg - the original message that was originally submitted to the workflow; in the event of an exception during processing, the exception will be stored in object metadata in the inputMsg

outputMsg - the message contaning any changes that may have been applied by the services within the workflow.

See Also:

CoreConstants.OBJ_METADATA_EXCEPTION

registerParentChannel

void registerParentChannel(Channel c)

Register the parent channel for this WorkflowInterceptor.

Parameters:

c - the channel

registerParentWorkflow

void registerParentWorkflow(Workflow w)

Register the parent workflow for this WorkflowInterceptor.

Parameters:

w - the workflow.