nl.nn.adapterframework.pipes

Class FixedResultPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.FixedResultPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

FixedResult

@Category(value="Basic")
 @ElementType(value=TRANSLATOR)
public class FixedResultPipe
extends FixedForwardPipe

Produces a fixed result that does not depend on the input message. It may return the contents of a file when filename or filenameSessionKey is specified. Otherwise the value of attribute returnString is returned.

Using parameters and the attributes of this pipe, it is possible to substitute values. This pipe performs the following steps:

1. During execution, this pipe first obtains a string based on attributes returnString, filename or filenameSessionKey.
2. The resulting string is transformed according to attributes replaceFrom and replaceTo if set. Please note that the plain value of attribute replaceFrom is matched, no ${...} here.
3. The resulting string is substituted based on the parameters of this pipe. This step depends on attribute replaceFixedParams. Assume that there is a parameter with name xyz. If replaceFixedParams is false, then each occurrence of ${xyz} is replaced by the parameter's value. Otherwise, the text xyz is substituted. See Parameter to see how parameter values are determined.
4. If attribute substituteVars is true, then expressions ${...} are substituted using system properties, pipelinesession variables and application properties. Please note that no ${...} patterns are left if the initial string came from attribute returnString, because any ${...} pattern in attribute returnString is substituted when the configuration is loaded.
5. If attribute styleSheetName is set, then the referenced XSLT stylesheet is applied to the resulting string.

Many attributes of this pipe reference file names. If a file is referenced by a relative path, the path is relative to the configuration's root directory.

Author:

Johan Verrips

Parameters

Used for substitution. For a parameter named xyz, the string ${xyz} or xyz (if replaceFixedParams is true) is substituted by the parameter's value.

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

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration, and translates the filename to a file, to check existence.
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
void	setFilename(String filename) Name of the file containing the result message.
void	setFileName(String fileName) Deprecated.
void	setFilenameSessionKey(String filenameSessionKey) Name of the session key containing the file name of the file containing the result message.
void	setFileNameSessionKey(String fileNameSessionKey) Deprecated.
void	setReplaceFixedParams(boolean b) When set true, parameter replacement matches name-of-parameter, not ${name-of-parameter}
void	setReplaceFrom(String replaceFrom) If set, every occurrence of this attribute's value is replaced by the value of replaceTo.
void	setReplaceTo(String replaceTo) See replaceFrom.
void	setReturnString(String returnString) Returned message.
void	setStyleSheetName(String styleSheetName) File name of XSLT stylesheet to apply.
void	setSubstituteVars(boolean substitute) Should values between ${ and } be resolved.

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

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

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

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, 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

FixedResultPipe

public FixedResultPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

checks for correct configuration, and translates the filename to a file, to check existence. If a filename or filenameSessionKey was specified, the contents of the file is put in the returnString, so that the returnString may always be returned.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

doPipe

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

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

setSubstituteVars

public void setSubstituteVars(boolean substitute)

Should values between ${ and } be resolved. If true, the search order of replacement values is: system properties (1), pipelinesession variables (2), application properties (3).

Default value

false

setFileName

@Deprecated
 @ConfigurationWarning(value="attribute \'fileName\' is replaced with \'filename\'")
public void setFileName(String fileName)

Deprecated.

setFilename

public void setFilename(String filename)

Name of the file containing the result message.

setFileNameSessionKey

@Deprecated
 @ConfigurationWarning(value="attribute \'fileNameSessionKey\' is replaced with \'filenameSessionKey\'")
public void setFileNameSessionKey(String fileNameSessionKey)

Deprecated.

setFilenameSessionKey

public void setFilenameSessionKey(String filenameSessionKey)

Name of the session key containing the file name of the file containing the result message.

setReturnString

public void setReturnString(String returnString)

Returned message.

setReplaceFrom

public void setReplaceFrom(String replaceFrom)

If set, every occurrence of this attribute's value is replaced by the value of replaceTo.

setReplaceTo

public void setReplaceTo(String replaceTo)

See replaceFrom.

setStyleSheetName

public void setStyleSheetName(String styleSheetName)

File name of XSLT stylesheet to apply.

setReplaceFixedParams

public void setReplaceFixedParams(boolean b)

When set true, parameter replacement matches name-of-parameter, not ${name-of-parameter}

Default value

false