nl.nn.adapterframework.pipes

Class FixedForwardPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

Adios2XmlPipe, AmountOfPagesPipe, ApiPrincipalPipe, BytesOutputPipe, CleanupOldFilesPipe, CoolGenWrapperPipe, CounterSwitchPipe, CredentialCheckingPipe, CrlPipe, DelayPipe, DomainTransformerPipe, EscapePipe, EtagHandlerPipe, ExceptionPipe, FilePipe, FixedResultPipe, FtpFileRetrieverPipe, GetFromSession, GetLtpaTokenPipe, GetPrincipalPipe, HashPipe, IncreaseIntegerPipe, IsUserInRolePipe, JsonPipe, JsonWellFormedChecker, LabelFormat, LadybugPipe, LarvaPipe, LdapChallengePipe, LdapQueryPipeBase, MdcPipe, MoveFilePipe, PasswordGeneratorPipe, PasswordHashPipe, PdfPipe, PostboxRetrieverPipe, PutInSession, PutParametersInSession, PutSystemDateInSession, RekenBoxCaller, RemoveCacheKeyPipe, RemoveFromSession, ReplacerPipe, RhinoPipe, SapLUWManager, ScanTibcoSolutionPipe, SignaturePipe, SizePipe, SkipPipe, SoapWrapperPipe, Stream2StringPipe, StreamingPipe, StreamPipe, StreamTransformerPipe, TimeoutGuardPipe, UnzipPipe, UploadFilePipe, UUIDGeneratorPipe, ValidatorBase, WsdlGeneratorPipe, WsdlGeneratorPipe, XmlBuilderPipe, XmlWellFormedChecker, XQueryPipe, ZipWriterPipe

public abstract class FixedForwardPipe
extends AbstractPipe

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

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
FixedForwardPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
PipeRunResult	doInitialPipe(Message input, PipeLineSession session) called by InputOutputPipeProcessor to check if the pipe needs to be skipped.
protected String	getParameterValue(ParameterValueList pvl, String parameterName)
void	setIfParam(String string)
void	setIfValue(String string)
void	setSkipOnEmptyInput(boolean b)

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, doPipe, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getLogPrefix, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

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

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

FixedForwardPipe

public FixedForwardPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class AbstractPipe

Throws:

ConfigurationException

doInitialPipe

public PipeRunResult doInitialPipe(Message input,
                                   PipeLineSession session)
                            throws PipeRunException

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

Throws:

PipeRunException

getParameterValue

protected String getParameterValue(ParameterValueList pvl,
                                   String parameterName)

setSkipOnEmptyInput

@IbisDoc(value={"If set, the processing continues directly at the forward of this pipe, without executing the pipe itself, if the input is empty","false"})
public void setSkipOnEmptyInput(boolean b)

setIfParam

@IbisDoc(value={"If set, this pipe is only executed when the value of parameter with name <code>ifparam</code> equals <code>ifvalue</code> (otherwise this pipe is skipped)",""})
public void setIfParam(String string)

setIfValue

@IbisDoc(value={"See <code>ifparam</code>",""})
public void setIfValue(String string)