@ElementType(value=TRANSLATOR) public class EscapePipe extends FixedForwardPipe
When direction=cdata2text all cdata nodes are converted to text nodes without any other translations.
Modifier and Type | Class and Description |
---|---|
static class |
EscapePipe.Direction |
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
EscapePipe() |
Modifier and Type | Method and Description |
---|---|
void |
configure()
checks for correct configuration of forward
|
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
boolean |
isEncodeSubstring() |
void |
setDirection(EscapePipe.Direction direction) |
void |
setEncodeSubstring(boolean b)
when set
true special characters in substringstart and substringend are first translated to their xml equivalents |
void |
setSubstringEnd(String substringEnd)
substring to end translation
|
void |
setSubstringStart(String substringStart)
substring to start translation
|
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, 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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class FixedForwardPipe
ConfigurationException
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
IPipe
FixedResultPipe
, the Pipe
can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String)
This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open
until the message was consumed. Doing so avoids connections leaking from pools, while it enables
efficient streaming processing of data while it is being read from a stream.PipeRunException
public void setSubstringStart(String substringStart)
public void setSubstringEnd(String substringEnd)
public void setDirection(EscapePipe.Direction direction)
public boolean isEncodeSubstring()
public void setEncodeSubstring(boolean b)
true
special characters in substringstart
and substringend
are first translated to their xml equivalentsCopyright © 2023 Frank!Framework. All rights reserved.