nl.nn.adapterframework.core

Interface IExtendedPipe

All Superinterfaces:

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

All Known Implementing Classes:

AbstractPipe, Adios2XmlPipe, AmountOfPagesPipe, ApiPrincipalPipe, ApiSoapWrapperPipe, ApiStreamPipe, ApiWsdlXmlValidator, Base64Pipe, BatchBlobTransformerPipe, BatchClobTransformerPipe, BatchFileTransformerPipe, BatchTransformerPipeBase, BisWrapperPipe, BlobLineIteratingPipe, BytesOutputPipe, ChecksumPipe, CleanupOldFilesPipe, ClobLineIteratingPipe, CollectorPipe, CompareIntegerPipe, CompareStringPipe, CompressPipe, CoolGenWrapperPipe, CounterSwitchPipe, CreateRestViewPipe, CredentialCheckingPipe, CrlPipe, CsvParserPipe, DelayPipe, DirectWrapperPipe, DomainTransformerPipe, EchoPipe, EsbSoapValidator, EsbSoapWrapperPipe, EscapePipe, EtagHandlerPipe, ExceptionPipe, FileLineIteratorPipe, FilenameSwitch, FilePipe, FileSystemPipe, FixedForwardPipe, FixedResult, FixedResultPipe, ForEachAttachmentPipe, ForEachChildElementPipe, FtpFileRetrieverPipe, FxfWrapperPipe, FxfXmlValidator, GenericMessageSendingPipe, GetFromSession, GetLtpaTokenPipe, GetPrincipalPipe, GetTibcoQueues, HashPipe, IfMultipart, IncreaseIntegerPipe, IsUserInRolePipe, IsXmlIfPipe, IteratingPipe, JdbcIteratingPipeBase, Json2XmlValidator, JsonPipe, JsonValidator, JsonWellFormedChecker, JsonXsltPipe, LabelFormat, LadybugPipe, LarvaPipe, LdapChallengePipe, LdapFindGroupMembershipsPipe, LdapFindMemberPipe, LdapQueryPipeBase, LobLineIteratingPipeBase, LocalFileSystemPipe, LogContextPipe, MailSenderPipe, MdcPipe, MessageSendingPipe, MoveFilePipe, PasswordGeneratorPipe, PasswordHashPipe, PdfPipe, PGPPipe, PostboxRetrieverPipe, PutInSession, PutParametersInSession, PutSystemDateInSession, RekenBoxCaller, RemoveCacheKeyPipe, RemoveFromSession, ReplacerPipe, ResultSetIteratingPipe, RhinoPipe, Samba1Pipe, Samba2Pipe, SambaPipe, SapLUWManager, ScanTibcoSolutionPipe, SenderPipe, SendTibcoMessage, SignaturePipe, SizePipe, SkipPipe, SoapValidator, SoapWrapperPipe, Stream2StringPipe, StreamingPipe, StreamLineIteratorPipe, StreamPipe, StreamTransformerPipe, StringIteratorPipe, Text2XmlPipe, TextSplitterPipe, TimeoutGuardPipe, UnzipPipe, UploadFilePipe, UUIDGeneratorPipe, ValidatorBase, WsdlGeneratorPipe, WsdlGeneratorPipe, WsdlXmlValidator, XmlBuilderPipe, XmlFileElementIteratorPipe, XmlIf, XmlSwitch, XmlValidator, XmlWellFormedChecker, XQueryPipe, XsltPipe, ZipIteratorPipe, ZipWriterPipe

public interface IExtendedPipe
extends IPipe

extra attributes to do logging and use sessionvariables.

Since:

4.3

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
static String	LONG_DURATION_MONITORING_EVENT
static String	MESSAGE_SIZE_MONITORING_EVENT
static String	PIPE_EXCEPTION_MONITORING_EVENT

Method Summary

Modifier and Type	Method and Description
String	getChompCharSize()
long	getDurationThreshold()
String	getElementToMove()
String	getElementToMoveChain()
String	getElementToMoveSessionKey()
String	getEmptyInputReplacement()
String	getGetInputFromFixedValue()
String	getGetInputFromSessionKey()
Locker	getLocker()
String	getSecLogSessionKeys()
String	getStoreResultInSessionKey()
boolean	hasSizeStatistics()
boolean	isPreserveInput()
boolean	isRemoveCompactMsgNamespaces()
boolean	isRestoreMovedElements()
boolean	isWriteToSecLog()
void	registerEvent(String description) Register an event for flexible monitoring.
void	setChompCharSize(String string) If set (>=0) and the character data length inside a xml element exceeds this size, the character data is chomped (with a clear comment)
void	setDurationThreshold(long maxDuration) If durationThreshold >=0 and the duration of the message processing exceeded the value specified (in milliseconds) the message is logged informatory to be analyzed
void	setElementToMove(String string) If set, the character data in this element is stored under a session key and in the message replaced by a reference to this session key: {sessionkey: + elementToMoveSessionKey + }
void	setElementToMoveChain(String string) Like elementToMove but element is preceded with all ancestor elements and separated by semicolons (e.g.
void	setElementToMoveSessionKey(String string) (Only used when elementToMove is set) Name of the session key under which the character data is stored
void	setEmptyInputReplacement(String string) If set and the input is empty, this fixed value is taken as input
void	setGetInputFromFixedValue(String string) If set, this fixed value is taken as input, instead of regular input
void	setGetInputFromSessionKey(String string) If set, input is taken from this session key, instead of regular input
void	setLocker(Locker locker) Optional Locker, to avoid parallel execution of the Pipe by multiple threads or servers.
void	setPipeLine(PipeLine pipeline) Extension, allowing Pipes to register things with the PipeLine at Configuration time.
void	setPreserveInput(boolean preserveInput) If set true, the result of the pipe is replaced with the original input (i.e.
void	setRemoveCompactMsgNamespaces(boolean b)
void	setRestoreMovedElements(boolean restoreMovedElements) If set true, compacted messages in the result are restored to their original format (see also setElementToMove(java.lang.String))
void	setSecLogSessionKeys(String string) (Only used when writetoseclog=true) Comma separated list of keys of session variables that is appended to the security log record
void	setStoreResultInSessionKey(String string) If set, the result (before replacing when true) is stored under this session key
void	setWriteToSecLog(boolean b)
void	throwEvent(String event) Throw an event for flexible monitoring.

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

configure, consumesSessionVariable, doPipe, getForwards, getMaxThreads, registerForward, start, stop

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

getName, setName

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 org.springframework.context.ApplicationContextAware

setApplicationContext

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

getName

Field Detail

LONG_DURATION_MONITORING_EVENT

static final String LONG_DURATION_MONITORING_EVENT

See Also:

Constant Field Values

PIPE_EXCEPTION_MONITORING_EVENT

static final String PIPE_EXCEPTION_MONITORING_EVENT

See Also:

Constant Field Values

MESSAGE_SIZE_MONITORING_EVENT

static final String MESSAGE_SIZE_MONITORING_EVENT

See Also:

Constant Field Values

Method Detail

setPipeLine

void setPipeLine(PipeLine pipeline)

Extension, allowing Pipes to register things with the PipeLine at Configuration time. Must be set before calling configure()

setGetInputFromSessionKey

void setGetInputFromSessionKey(String string)

If set, input is taken from this session key, instead of regular input

getGetInputFromSessionKey

String getGetInputFromSessionKey()

setGetInputFromFixedValue

void setGetInputFromFixedValue(String string)

If set, this fixed value is taken as input, instead of regular input

getGetInputFromFixedValue

String getGetInputFromFixedValue()

setEmptyInputReplacement

void setEmptyInputReplacement(String string)

If set and the input is empty, this fixed value is taken as input

getEmptyInputReplacement

String getEmptyInputReplacement()

setPreserveInput

void setPreserveInput(boolean preserveInput)

If set true, the result of the pipe is replaced with the original input (i.e. the input before configured replacements of getInputFromSessionKey, getInputFromFixedValue or emptyInputReplacement)

isPreserveInput

boolean isPreserveInput()

setStoreResultInSessionKey

void setStoreResultInSessionKey(String string)

If set, the result (before replacing when true) is stored under this session key

getStoreResultInSessionKey

String getStoreResultInSessionKey()

setChompCharSize

void setChompCharSize(String string)

If set (>=0) and the character data length inside a xml element exceeds this size, the character data is chomped (with a clear comment)

getChompCharSize

String getChompCharSize()

setElementToMove

void setElementToMove(String string)

If set, the character data in this element is stored under a session key and in the message replaced by a reference to this session key: {sessionkey: + elementToMoveSessionKey + }

getElementToMove

String getElementToMove()

setElementToMoveSessionKey

void setElementToMoveSessionKey(String string)

(Only used when elementToMove is set) Name of the session key under which the character data is stored

Default value

ref_ + the name of the element

getElementToMoveSessionKey

String getElementToMoveSessionKey()

setElementToMoveChain

void setElementToMoveChain(String string)

Like elementToMove but element is preceded with all ancestor elements and separated by semicolons (e.g. 'adapter;pipeline;pipe')

getElementToMoveChain

String getElementToMoveChain()

setRemoveCompactMsgNamespaces

void setRemoveCompactMsgNamespaces(boolean b)

isRemoveCompactMsgNamespaces

boolean isRemoveCompactMsgNamespaces()

setRestoreMovedElements

void setRestoreMovedElements(boolean restoreMovedElements)

If set true, compacted messages in the result are restored to their original format (see also setElementToMove(java.lang.String))

isRestoreMovedElements

boolean isRestoreMovedElements()

setDurationThreshold

void setDurationThreshold(long maxDuration)

If durationThreshold >=0 and the duration of the message processing exceeded the value specified (in milliseconds) the message is logged informatory to be analyzed

Default value

-1

getDurationThreshold

long getDurationThreshold()

setLocker

void setLocker(Locker locker)

Optional Locker, to avoid parallel execution of the Pipe by multiple threads or servers. An exception is thrown when the lock cannot be obtained, e.g. in case another thread, may be in another server, holds the lock and does not release it in a timely manner.

getLocker

Locker getLocker()

setWriteToSecLog

void setWriteToSecLog(boolean b)

isWriteToSecLog

boolean isWriteToSecLog()

setSecLogSessionKeys

void setSecLogSessionKeys(String string)

(Only used when writetoseclog=true) Comma separated list of keys of session variables that is appended to the security log record

getSecLogSessionKeys

String getSecLogSessionKeys()

registerEvent

void registerEvent(String description)

Register an event for flexible monitoring.

throwEvent

void throwEvent(String event)

Throw an event for flexible monitoring.

hasSizeStatistics

boolean hasSizeStatistics()