com.adaptris.core.interceptor

Class LoggingContextWorkflowInterceptor

java.lang.Object

com.adaptris.core.interceptor.WorkflowInterceptorImpl

com.adaptris.core.interceptor.LoggingContextWorkflowInterceptor

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent, WorkflowInterceptor

@ComponentProfile(summary="Interceptor that adds Logging Context at the start of a workflow, removes it at the end",
                  tag="interceptor")
public class LoggingContextWorkflowInterceptor
extends WorkflowInterceptorImpl

WorkflowInterceptor implementation that adds a mapped diagnostic context via org.slf4j.MDC#put(String, String).

An alternative to this interceptor might be AddLoggingContext and RemoveLoggingContext as part of the service execution chain.

See Also:

AddLoggingContext, RemoveLoggingContext

In the adapter configuration file this class is aliased as logging-context-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 inherited from class com.adaptris.core.interceptor.WorkflowInterceptorImpl

log

Constructor Summary

Constructors

Constructor and Description
LoggingContextWorkflowInterceptor()
LoggingContextWorkflowInterceptor(java.lang.String uid)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
java.lang.Boolean	getAddDefaultKeysAsObjectMetadata() Return whether the default keys will be added to object metadata.
java.lang.String	getKey() Deprecated.
java.lang.Boolean	getUseDefaultKeys() Return whether the default keys will be populated
java.lang.String	getValue() Deprecated.
KeyValuePairList	getValuesToSet()
void	init() Initialises the component.
void	processingStart(AdaptrisMessage inputMsg) Mark the start of processing a message.
void	setAddDefaultKeysAsObjectMetadata(java.lang.Boolean addDefaultKeysAsObjectMetadata)
void	setKey(java.lang.String key) Deprecated.
void	setUseDefaultKeys(java.lang.Boolean useDefaultKeys) Sets whether to write channel, workflow and message id into the Mapped Diagnostic Context.
void	setValue(java.lang.String val) Deprecated.
void	setValuesToSet(KeyValuePairList values) Set the list of values to set
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

Constructor Detail

LoggingContextWorkflowInterceptor

public LoggingContextWorkflowInterceptor()

LoggingContextWorkflowInterceptor

public LoggingContextWorkflowInterceptor(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.

processingStart

public void processingStart(AdaptrisMessage inputMsg)

Description copied from interface: WorkflowInterceptor

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

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

getKey

@Deprecated
public java.lang.String getKey()

Deprecated.

setKey

@Deprecated
public void setKey(java.lang.String key)

Deprecated.

Set the context key.

If not specified then we will try to use one of the following values in order of preference provided they are not null/blank

• The interceptors unique id
• The parent workflow unique id
• The parent channel unique id
• A generated unique id

Parameters:

key - the contextKey to set.

getValue

@Deprecated
public java.lang.String getValue()

Deprecated.

setValue

@Deprecated
public void setValue(java.lang.String val)

Deprecated.

Set the context value.

If not specified then we will try to use one of the following values in order of preference provided they are not null/blank

• The interceptors unique id
• The parent workflow unique id
• The parent channel unique id
• A Generated unique id

Parameters:

val - the contextValue to set

getValuesToSet

public KeyValuePairList getValuesToSet()

setValuesToSet

public void setValuesToSet(KeyValuePairList values)

Set the list of values to set

Parameters:

values - the mapping to add

setUseDefaultKeys

public void setUseDefaultKeys(java.lang.Boolean useDefaultKeys)

Sets whether to write channel, workflow and message id into the Mapped Diagnostic Context. The following keys will be added for each message:

• channelid
• workflowid
• messageuniqueid

Parameters:

useDefaultKeys - whether to populate the Mapped Diagnostic Context

getUseDefaultKeys

public java.lang.Boolean getUseDefaultKeys()

Return whether the default keys will be populated

Returns:

whether the default keys will be populated

setAddDefaultKeysAsObjectMetadata

public void setAddDefaultKeysAsObjectMetadata(java.lang.Boolean addDefaultKeysAsObjectMetadata)

getAddDefaultKeysAsObjectMetadata

public java.lang.Boolean getAddDefaultKeysAsObjectMetadata()

Return whether the default keys will be added to object metadata.

Returns:

whether the default keys will be added to object metadata