public class StreamPipe extends FixedForwardPipe
Modifier and Type | Field and Description |
---|---|
static String |
ANTIVIRUS_FAILED_FORWARD |
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
StreamPipe() |
Modifier and Type | Method and Description |
---|---|
protected String |
adjustFirstStringPart(String firstStringPart,
PipeLineSession session) |
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
boolean |
getAntiVirusFailureAsSoapFault() |
String |
getAntiVirusFailureReasonSessionKey() |
String |
getAntiVirusMessagePartName() |
String |
getAntiVirusPartName() |
String |
getAntiVirusPassedMessage() |
String |
getMultipartXmlSessionKey() |
boolean |
isCheckAntiVirus() |
boolean |
isExtractFirstStringPart() |
void |
setAntiVirusFailureAsSoapFault(boolean b)
(only used for parameter
httprequest and when checkantivirus=true ) when true and the antivirusfailed forward is specified and the antivirus scan did not pass, a soap fault is returned instead of only a plain error message |
void |
setAntiVirusFailureReasonSessionKey(String antiVirusFailureReasonSessionKey)
(only used for parameter
httprequest and when checkantivirus=true ) if not empty and the antivirusfailed forward is specified and the antivirus scan did not pass, the error message (or soap fault) is stored in this session key and the first string part is returned to the pipeline |
void |
setAntiVirusMessagePartName(String antiVirusMessagePartName)
(only used for parameter
httprequest and when checkantivirus=true ) name of antivirus scan message parts |
void |
setAntiVirusPartName(String antiVirusPartName)
(only used for parameter
httprequest and when checkantivirus=true ) name of antivirus scan status parts |
void |
setAntiVirusPassedMessage(String antiVirusPassedMessage)
(only used for parameter
httprequest and when checkantivirus=true ) message of antivirus scan parts which indicates the antivirus scan passed |
void |
setCheckAntiVirus(boolean b)
(only used for parameter
httprequest ) when true parts are checked for antivirus scan returncode. |
void |
setExtractFirstStringPart(boolean b)
(only used for parameter
httprequest ) when true the first part is not put in a session key but returned to the pipeline (as the result of this pipe) |
void |
setMultipartXmlSessionKey(String multipartXmlSessionKey)
(only used when
extractfirststringpart=true ) the session key to put the xml in with info about the stored parts |
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 static final String ANTIVIRUS_FAILED_FORWARD
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
protected String adjustFirstStringPart(String firstStringPart, PipeLineSession session) throws PipeRunException
PipeRunException
public void setExtractFirstStringPart(boolean b)
httprequest
) when true the first part is not put in a session key but returned to the pipeline (as the result of this pipe)public boolean isExtractFirstStringPart()
public String getMultipartXmlSessionKey()
public void setMultipartXmlSessionKey(String multipartXmlSessionKey)
extractfirststringpart=true
) the session key to put the xml in with info about the stored partsmultipartxml
public void setCheckAntiVirus(boolean b)
httprequest
) when true parts are checked for antivirus scan returncode. these antivirus scan parts have been added by another application (so the antivirus scan is not performed in this pipe). for each file part an antivirus scan part have been added by this other application (directly after this file part)public boolean isCheckAntiVirus()
public String getAntiVirusPartName()
public void setAntiVirusPartName(String antiVirusPartName)
httprequest
and when checkantivirus=true
) name of antivirus scan status partsantivirus_rc
public String getAntiVirusMessagePartName()
public void setAntiVirusMessagePartName(String antiVirusMessagePartName)
httprequest
and when checkantivirus=true
) name of antivirus scan message partsantivirus_msg
public String getAntiVirusPassedMessage()
public void setAntiVirusPassedMessage(String antiVirusPassedMessage)
httprequest
and when checkantivirus=true
) message of antivirus scan parts which indicates the antivirus scan passedpass
public void setAntiVirusFailureAsSoapFault(boolean b)
httprequest
and when checkantivirus=true
) when true and the antivirusfailed forward is specified and the antivirus scan did not pass, a soap fault is returned instead of only a plain error messagepublic boolean getAntiVirusFailureAsSoapFault()
public void setAntiVirusFailureReasonSessionKey(String antiVirusFailureReasonSessionKey)
httprequest
and when checkantivirus=true
) if not empty and the antivirusfailed forward is specified and the antivirus scan did not pass, the error message (or soap fault) is stored in this session key and the first string part is returned to the pipelinepublic String getAntiVirusFailureReasonSessionKey()
Copyright © 2023 Frank!Framework. All rights reserved.