Package org.frankframework.pipes
Class CompressPipe
java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.pipes.CompressPipe
- All Implemented Interfaces:
HasTransactionAttribute
,IConfigurable
,IConfigurationAware
,IForwardTarget
,INamedObject
,IPipe
,IScopeProvider
,IWithParameters
,EventThrowing
,HasStatistics
,org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationContextAware
Pipe to zip or unzip a message or file.
- Author:
- John Dekker, Jaco de Groot
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.frankframework.pipes.AbstractPipe
parameterNamesMustBeUnique
Fields inherited from class org.frankframework.core.TransactionAttributes
log
Fields inherited from interface org.frankframework.core.IPipe
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
checks for correct configuration of forwarddoPipe
(Message message, PipeLineSession session) This is where the action takes place.boolean
boolean
boolean
void
setCompress
(boolean b) iftrue
the pipe compresses, otherwise it decompressvoid
setFileFormat
(CompressPipe.FileFormat format) void
setFilenamePattern
(String string) Deprecated, for removal: This API element is subject to removal in a future version.void
setMessageIsContent
(boolean b) flag indicates whether the message is the content or the path to a file with the contents. for multiple files use ';' as delimitervoid
setOutputDirectory
(String string) Deprecated, for removal: This API element is subject to removal in a future version.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) Deprecated, for removal: This API element is subject to removal in a future version.Methods inherited from class org.frankframework.pipes.FixedForwardPipe
getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
Methods inherited from class org.frankframework.pipes.AbstractPipe
addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent
Methods inherited from class org.frankframework.core.TransactionAttributes
configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.frankframework.core.IPipe
throwEvent
-
Constructor Details
-
CompressPipe
public CompressPipe()
-
-
Method Details
-
configure
Description copied from class:FixedForwardPipe
checks for correct configuration of forward- Specified by:
configure
in interfaceIConfigurable
- Specified by:
configure
in interfaceIPipe
- Overrides:
configure
in classFixedForwardPipe
- Throws:
ConfigurationException
-
doPipe
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. If the result of the Pipe does not depend on the input, like for theFixedResultPipe
, the Pipe can schedule the input to be closed at session exit, by callingMessage.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.- Throws:
PipeRunException
-
setCompress
public void setCompress(boolean b) iftrue
the pipe compresses, otherwise it decompress- Default value
- false
-
setFilenamePattern
@Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use a LocalFileSystemPipe with filename parameter (and optionally a pattern)") public void setFilenamePattern(String string) Deprecated, for removal: This API element is subject to removal in a future version.required if result is a file, the pattern for the result filename. Can be set with variables e.g. {file}.{ext}.zip in this example the {file} and {ext} variables are resolved with sessionKeys with the same name -
setMessageIsContent
public void setMessageIsContent(boolean b) flag indicates whether the message is the content or the path to a file with the contents. for multiple files use ';' as delimiter- Default value
- false
-
setOutputDirectory
@Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use resultIsContent=true in combination with a LocalFileSystemPipe") public void setOutputDirectory(String string) Deprecated, for removal: This API element is subject to removal in a future version.required if result is a file, the directory in which to store the result file -
setResultIsContent
public void setResultIsContent(boolean b) flag indicates whether the result must be written to the message or to a file (filename = message)- Default value
- true when outputDirectory is not set.
-
isResultIsContent
public boolean isResultIsContent() -
setZipEntryPattern
@Deprecated(forRemoval=true, since="8.1") @ConfigurationWarning("Please use parameter zipEntryPattern (in combination with the pattern attribute)") public void setZipEntryPattern(String string) Deprecated, for removal: This API element is subject to removal in a future version.the pattern for the zipentry name in case a zipfile is read or written -
setFileFormat
-
isMessageIsContent
public boolean isMessageIsContent() -
getOutputDirectory
-
getFilenamePattern
-
getZipEntryPattern
-
isCompress
public boolean isCompress() -
getFileFormat
-