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:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class CompressPipe
extends FixedForwardPipe

Pipe to zip or unzip a message or file.

Author:

John Dekker, Jaco de Groot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CompressPipe.FileFormat

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

Constructors

Constructor	Description
CompressPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
boolean	isResultIsContent()
void	setCompress(boolean b)	If true, the pipe compresses; otherwise, it decompresses.
void	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)	A flag that indicates whether the message is the content or the path to a file with the contents.
void	setOutputDirectory(String string)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setResultIsContent(boolean b)	A flag that 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

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, 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.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

CompressPipe

public CompressPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

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.

Throws:

PipeRunException

setCompress

public void setCompress(boolean b)

If true, the pipe compresses; otherwise, it decompresses.

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)

A flag that indicates whether the message is the content or the path to a file with the contents. For multiple files, use ';' as a 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 the result is a file. The directory in which to store the result file.

setResultIsContent

public void setResultIsContent(boolean b)

A flag that 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 zip entry name in case a zip file is read or written.

setFileFormat

public void setFileFormat(CompressPipe.FileFormat format)