Package org.frankframework.pipes

Class ExceptionPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.ExceptionPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@EnterpriseIntegrationPattern(ERRORHANDLING)
@Forward(name="success",
         description="success Forward is deprecated and will be removed. Invoked when {@literal throwException} is false")
public class ExceptionPipe
extends AbstractPipe

Pipe that throws an exception based on the input message.
Parameters that are set on the ExceptionPipe will be added to the error message that is produced by the ErrorMessageFormatter that has been configured on the Adapter and will also be copied into the PipeLineSession, so that they can be passed back to a calling adapter as returnedSessionKey.
The success forward is only used when the (deprecated) attribute throwException has been set to false. Otherwise, the (default) exception forward will be used.

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

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

Method Summary

Modifier and Type	Method	Description
void	configure()	configure() is called after the Pipeline is registered at the Adapter.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
boolean	isThrowException()
void	setThrowException(boolean b)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, 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.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

ExceptionPipe

public ExceptionPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: AbstractPipe

configure() is called after the Pipeline is registered at the Adapter. The purpose of this method is to reduce creating connections to databases, etc. in the doPipe() method. As much as possible, class instantiation should take place in the configure() method to improve performance.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

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.

Throws:

PipeRunException

setThrowException

@Deprecated(forRemoval=true,
            since="9.0")
@ConfigurationWarning("The {@literal success} forward and {@literal throwException} attribute should not be used anymore")
public void setThrowException(boolean b)

Deprecated, for removal: This API element is subject to removal in a future version.

If true, a PipeRunException is thrown. Otherwise, the output is only logged as an error, and no rollback is performed.

Default value

true

isThrowException

public boolean isThrowException()