@SupportsOutputStreaming public class ChecksumPipe extends StreamingPipe
Modifier and Type | Class and Description |
---|---|
protected static interface |
ChecksumPipe.ChecksumGenerator |
static class |
ChecksumPipe.ChecksumType |
protected static class |
ChecksumPipe.MessageDigestChecksumGenerator |
protected static class |
ChecksumPipe.ZipChecksumGenerator |
AUTOMATIC_STREAMING
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
ChecksumPipe() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canProvideOutputStream()
returns true when:
a) the pipe might be able to accept an input by providing an OutputStream, and
b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
|
protected ChecksumPipe.ChecksumGenerator |
createChecksumGenerator() |
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
protected MessageOutputStream |
provideOutputStream(PipeLineSession session)
provide the outputstream, or null if a stream cannot be provided.
|
void |
setCharset(String string)
Character encoding to be used to encode message before calculating checksum.
|
void |
setInputIsFile(boolean b)
Deprecated.
|
void |
setType(ChecksumPipe.ChecksumType value)
Type of checksum to be calculated
|
canStreamToNextPipe, configure, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough
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
protected ChecksumPipe.ChecksumGenerator createChecksumGenerator() throws NoSuchAlgorithmException
NoSuchAlgorithmException
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 boolean canProvideOutputStream()
StreamingPipe
canProvideOutputStream
in class StreamingPipe
protected MessageOutputStream provideOutputStream(PipeLineSession session) throws StreamingException
StreamingPipe
StreamingPipe.getNextPipe()
.provideOutputStream
in class StreamingPipe
StreamingException
public void setCharset(String string)
public void setType(ChecksumPipe.ChecksumType value)
@Deprecated @ConfigurationWarning(value="Please use fileSystemPipe to read the file first.") public void setInputIsFile(boolean b)
true
, the input is assumed to be a filename; otherwise the input itself is used in the calculations.Copyright © 2023 Frank!Framework. All rights reserved.