Package org.frankframework.pipes

Class LogContextPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.LogContextPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ElementType(SESSION)
public class LogContextPipe
extends FixedForwardPipe

Pipe that stores all its parameter values in the ThreadContext, formerly known as Mapped Diagnostic Context (MDC), to be used in logging. The input is passed through to the output.

Author:

Gerrit van Brakel

Parameters

every parameter value is stored in the ThreadContext under its name.

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
LogContextPipe()

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
boolean	isContinueOnError()	If set true the pipe will never forward to the ExceptionForward even if an error occurred during execution.
boolean	isExport()	If set to true the ThreadContext parameters will be exported from the current PipeLine up in the call tree.
void	setContinueOnError(boolean continueOnError)	If set true the pipe will never forward to the ExceptionForward even if an error occurred during execution.
void	setExport(boolean export)	If set to true the ThreadContext parameters will be exported from the current PipeLine up in the call tree.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

configure, getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Constructor Details

LogContextPipe

public LogContextPipe()

Method Details

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

isExport

public boolean isExport()

If set to true the ThreadContext parameters will be exported from the current PipeLine up in the call tree.

Default value

false

setExport

public void setExport(boolean export)

If set to true the ThreadContext parameters will be exported from the current PipeLine up in the call tree.

Default value

false

isContinueOnError

public boolean isContinueOnError()

If set true the pipe will never forward to the ExceptionForward even if an error occurred during execution.

Default value

false

setContinueOnError

public void setContinueOnError(boolean continueOnError)

If set true the pipe will never forward to the ExceptionForward even if an error occurred during execution.

Default value

false