nl.nn.adapterframework.pipes

Class CompressPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.CompressPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class CompressPipe
extends StreamingPipe

Pipe to zip or unzip a message or file.

Author:

John Dekker, Jaco de Groot (***@dynasol.nl)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompressPipe.FileFormat

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
CompressPipe()

Method Summary

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

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

canStreamToNextPipe, getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, provideOutputStream, setStreamingActive, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

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

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

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

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

CompressPipe

public CompressPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class StreamingPipe

Throws:

ConfigurationException

doPipe

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

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

canProvideOutputStream

protected boolean canProvideOutputStream()

Description copied from class: StreamingPipe

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. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)

Overrides:

canProvideOutputStream in class StreamingPipe

setCompress

public void setCompress(boolean b)

if true the pipe compresses, otherwise it decompress

Default value

false

setFilenamePattern

public void setFilenamePattern(String string)

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

public void setOutputDirectory(String string)

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

false

setZipEntryPattern

public void setZipEntryPattern(String string)

the pattern for the zipentry name in case a zipfile is read or written

setConvert2String

@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)

Deprecated.

setFileFormat

public void setFileFormat(CompressPipe.FileFormat format)