Package com.adaptris.core.interceptor

Class InFlightWorkflowInterceptor

java.lang.Object

com.adaptris.core.interceptor.WorkflowInterceptorImpl

com.adaptris.core.interceptor.InFlightWorkflowInterceptor

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent, WorkflowInterceptor

@ComponentProfile(summary="Interceptor that reports on whether there are in flight messages on this workflow",
                  tag="interceptor")
public class InFlightWorkflowInterceptor
extends WorkflowInterceptorImpl

WorkflowInterceptor implementation that exposes acts as the source for MessageInFlightMBean.

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

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

WorkflowInterceptorImpl.WorkflowInterceptorException

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	UID_SUFFIX

Fields inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

log

Constructor Summary

Constructors

Constructor	Description
InFlightWorkflowInterceptor()
InFlightWorkflowInterceptor(java.lang.String uid)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the component.
void	init()	Initialises the component.
void	start()	Starts the component.
void	stop()	Stop the component
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 class com.adaptris.core.interceptor.WorkflowInterceptorImpl

changeState, getUniqueId, parentChannel, parentWorkflow, prepare, registerParentChannel, registerParentWorkflow, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setUniqueId, wasSuccessful

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.WorkflowInterceptor

processingStart

Field Detail

UID_SUFFIX

public static final java.lang.String UID_SUFFIX

See Also:

Constant Field Values

Constructor Detail

InFlightWorkflowInterceptor

public InFlightWorkflowInterceptor()

InFlightWorkflowInterceptor

public InFlightWorkflowInterceptor(java.lang.String uid)

Method Detail

workflowStart

public void workflowStart(AdaptrisMessage inputMsg)

Description copied from interface: WorkflowInterceptor

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.

workflowEnd

public void workflowEnd(AdaptrisMessage inputMsg,
                        AdaptrisMessage outputMsg)

Description copied from interface: WorkflowInterceptor

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

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Throws:

CoreException - wrapping any underlying Exceptions

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences