Package org.frankframework.pipes

Class FixedForwardPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

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

Direct Known Subclasses:

AbstractCollectorPipe, AbstractFileSystemPipe, AbstractLdapQueryPipe, AbstractValidator, Adios2XmlPipe, AmountOfPagesPipe, ApiPrincipalPipe, Base64Pipe, BytesOutputPipe, CompressPipe, CounterSwitchPipe, CredentialCheckingPipe, CrlPipe, CsvParserPipe, DataSonnetPipe, DelayPipe, DirectWrapperPipe, DomainTransformerPipe, EchoPipe, EscapePipe, EtagHandlerPipe, FixedResultPipe, GetFromSessionPipe, GetPrincipalPipe, HashPipe, IncreaseIntegerPipe, IsUserInRolePipe, JsonPathPipe, JsonPipe, JsonWellFormedCheckerPipe, JwtPipe, LabelFormat, LadybugPipe, LarvaPipe, LogContextPipe, MessageSendingPipe, ObfuscatePipe, PasswordGeneratorPipe, PasswordHashPipe, PdfPipe, PGPPipe, PutInSessionPipe, PutSystemDateInSession, RekenBoxCallerPipe, RemoveCacheKeyPipe, RemoveFromSessionPipe, ReplacerPipe, SapLUWManagerPipe, ScanTibcoSolutionPipe, SignaturePipe, SizePipe, SkipPipe, SoapWrapperPipe, StreamPipe, StreamTransformerPipe, Text2XmlPipe, TextSplitterPipe, TimeoutGuardPipe, UnzipPipe, UUIDGeneratorPipe, WsdlGeneratorPipe, WsdlGeneratorPipe, XmlWellFormedCheckerPipe, XQueryPipe, XsltPipe

@Forward(name="success",
         description="successful processing of the message of the pipe")
public abstract class FixedForwardPipe
extends AbstractPipe

Provides a base class for a Pipe that always has the same forward. Subclasses should call super.configure() in their configure() methods.

Author:

Gerrit van Brakel

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

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
protected String	getParameterValue(ParameterValueList pvl, String parameterName)
void	setIfParam(String string)	If set, this pipe is only executed when the value of the parameter with the name ifParam equals ifValue.
void	setIfValue(String string)	See ifParam
void	setOnlyIfSessionKey(String onlyIfSessionKey)	Key of the session variable to check if the action must be executed.
void	setOnlyIfValue(String onlyIfValue)	Value of session variable 'onlyIfSessionKey' to check if the action must be executed.
void	setSkipOnEmptyInput(boolean b)	If true, the processing continues directly at the forward of this pipe, without executing the pipe itself, if the input is empty.
void	setUnlessSessionKey(String unlessSessionKey)	Key of the session variable to check if the action must be executed.
void	setUnlessValue(String unlessValue)	Value of session variable 'unlessSessionKey' to check if the action must be executed.
boolean	skipPipe(Message input, PipeLineSession session)	Called by InputOutputPipeProcessor to check if the pipe needs to be skipped.

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

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

Constructor Details

FixedForwardPipe

public FixedForwardPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractPipe

Throws:

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

skipPipe

public boolean skipPipe(Message input,
 PipeLineSession session)
                 throws PipeRunException

Called by InputOutputPipeProcessor to check if the pipe needs to be skipped.

Throws:

PipeRunException

getParameterValue

@Nullable
protected String getParameterValue(@Nonnull
 ParameterValueList pvl,
 String parameterName)

setSkipOnEmptyInput

public void setSkipOnEmptyInput(boolean b)

If true, the processing continues directly at the forward of this pipe, without executing the pipe itself, if the input is empty.

Default value

false

setIfParam

public void setIfParam(String string)

If set, this pipe is only executed when the value of the parameter with the name ifParam equals ifValue. Otherwise, this pipe is skipped.

setIfValue

public void setIfValue(String string)

See ifParam

setOnlyIfSessionKey

public void setOnlyIfSessionKey(String onlyIfSessionKey)

Key of the session variable to check if the action must be executed. The pipe is only executed if the session variable exists and is not null.

setOnlyIfValue

public void setOnlyIfValue(String onlyIfValue)

Value of session variable 'onlyIfSessionKey' to check if the action must be executed. The pipe is only executed if the session variable has the specified value.

setUnlessSessionKey

public void setUnlessSessionKey(String unlessSessionKey)

Key of the session variable to check if the action must be executed. The pipe is not executed if the session variable exists and is not null.

setUnlessValue

public void setUnlessValue(String unlessValue)

Value of session variable 'unlessSessionKey' to check if the action must be executed. The pipe is not executed if the session variable has the specified value.