@ElementType(value=SESSION) public class GetFromSession extends FixedForwardPipe
pipeLineSession
by a key specified by
sessionKey
.PipeLineSession
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
GetFromSession() |
Modifier and Type | Method and Description |
---|---|
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
String |
getSessionKey()
Returns the name of the key in the
pipeLineSession to retrieve the input from |
Parameter.ParameterType |
getType() |
void |
setSessionKey(String sessionKey)
Key of the session variable to retrieve the output message from.
|
void |
setType(Parameter.ParameterType type)
string : renders the contentsmap : converts a Map<String, String> object to a xml-string (<items><item name='...'>...</item><item name='...'>...</item></items>) |
configure, 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 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 String getSessionKey()
pipeLineSession
to retrieve the input frompublic void setSessionKey(String sessionKey)
public void setType(Parameter.ParameterType type)
string
: renders the contentsmap
: converts a Map<String, String> object to a xml-string (<items><item name='...'>...</item><item name='...'>...</item></items>)public Parameter.ParameterType getType()
Copyright © 2023 Frank!Framework. All rights reserved.