Class EscapePipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.EscapePipe

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

@EnterpriseIntegrationPattern(TRANSLATOR)
public class EscapePipe
extends FixedForwardPipe

Pipe that performs translations between special characters and their XML equivalents.

When direction=cdata2text, all CDATA nodes are converted to text nodes without any other translations.

Author:

Peter Leeuwenburgh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EscapePipe.Direction

Field Summary

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
EscapePipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
@NonNull 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 to 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.

Methods inherited from class FixedForwardPipe

getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

EscapePipe

public EscapePipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class FixedForwardPipe

Throws:

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

doPipe

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

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.

Throws:

PipeRunException

setSubstringStart

public void setSubstringStart(String substringStart)

Substring to start translation.

setSubstringEnd

public void setSubstringEnd(String substringEnd)

Substring to end translation.

setDirection

public void setDirection(EscapePipe.Direction direction)

isEncodeSubstring

public boolean isEncodeSubstring()

setEncodeSubstring

public void setEncodeSubstring(boolean b)

When set to true, special characters in substringstart and substringend are first translated to their XML equivalents.

Default value

false