public class CompressPipe extends StreamingPipe
Modifier and Type | Class and Description |
---|---|
static class |
CompressPipe.FileFormat |
AUTOMATIC_STREAMING
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
CompressPipe() |
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.
|
void |
configure()
checks for correct configuration of forward
|
PipeRunResult |
doPipe(Message message,
PipeLineSession session)
This is where the action takes place.
|
void |
setCompress(boolean b)
if
true the pipe compresses, otherwise it decompress |
void |
setConvert2String(boolean b)
Deprecated.
|
void |
setFileFormat(CompressPipe.FileFormat format) |
void |
setFilenamePattern(String string)
required if result is a file, the pattern for the result filename.
|
void |
setMessageIsContent(boolean b)
flag indicates whether the message is the content or the path to a file with the contents.
|
void |
setOutputDirectory(String string)
required if result is a file, the directory in which to store the result file
|
void |
setResultIsContent(boolean b)
flag indicates whether the result must be written to the message or to a file (filename = message)
|
void |
setZipEntryPattern(String string)
the pattern for the zipentry name in case a zipfile is read or written
|
canStreamToNextPipe, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, 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
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 StreamingPipe
ConfigurationException
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
AbstractPipe
doPipe
in interface IPipe
doPipe
in class AbstractPipe
PipeRunException
protected boolean canProvideOutputStream()
StreamingPipe
canProvideOutputStream
in class StreamingPipe
public void setCompress(boolean b)
true
the pipe compresses, otherwise it decompresspublic void setFilenamePattern(String string)
public void setMessageIsContent(boolean b)
public void setOutputDirectory(String string)
public void setResultIsContent(boolean b)
public void setZipEntryPattern(String string)
@Deprecated @ConfigurationWarning(value="It should not be necessary to specify convert2String. If you encounter a situation where it is, please report to Frank!Framework Core Team") public void setConvert2String(boolean b)
public void setFileFormat(CompressPipe.FileFormat format)
Copyright © 2023 Frank!Framework. All rights reserved.