nl.nn.adapterframework.pipes

Class UnzipPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.UnzipPipe

All Implemented Interfaces:

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

@ElementType(value=TRANSLATOR)
public class UnzipPipe
extends FixedForwardPipe

Assumes input to be the file name of a ZIP archive, and unzips it to a directory and/or an XML message.
The output of each unzipped item is returned in XML as follows when collectFileContents is false:

  <results count="num_of_items">
    <result item="1">
      <zipEntry>name in ZIP archive of first item</zipEntry>
      <fileName>filename of first item</fileName>
    </result>
    <result item="2">
      <zipEntry>name in ZIP archive of second item</zipEntry>
      <fileName>filename of second item</fileName>
    </result>
       ...
  </results>
 

The output of each unzipped item is returned in XML as follows when collectFileContents is true:

  <results count="num_of_items">
    <result item="1">
      <zipEntry>name in ZIP archive of first item</zipEntry>
      <fileContent>content of first item</fileContent>
    </result>
    <result item="2">
      <zipEntry>name in ZIP archive of second item</zipEntry>
      <fileContent>content of second item</fileContent>
    </result>
       ...
  </results>
 

By default, this pipe takes care to produce unique file names, as follows. When the filename within the archive is:

<basename> + "." + <extension>

then the extracted filename (path omitted) becomes

<basename> + <unique number> + "." + <extension>

Since:

4.9

Author:

Gerrit van Brakel

Field Summary

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
UnzipPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
protected InputStream	getInputStream(Message message, PipeLineSession session)
void	setAssumeDirectoryExists(boolean assumeDirectoryExists) If set true, validation of directory is ignored
void	setCheckDirectory(boolean checkDirectory) Deprecated.
void	setCollectFileContents(boolean b) If set true, the contents of the files in the zip are returned in the result xml message of this pipe.
void	setCollectFileContentsBase64Encoded(String string) Comma separated list of file extensions.
void	setCollectResults(boolean b) If set false, only a small summary (count of items in zip) is returned
void	setCreateSubDirectories(boolean b) Deprecated.
void	setDeleteOnExit(boolean b) If true, file is automatically deleted upon normal JVM termination
void	setDirectory(String string) Directory to extract the archive to
void	setDirectorySessionKey(String directorySessionKey) Sessionkey with a directory value to extract the archive to
void	setKeepOriginalFileName(boolean b) If set false, a suffix is added to the original filename to be sure it is unique
void	setKeepOriginalFilePath(boolean b) If set true, the path of the zip entry will be preserved.
void	setProcessFile(boolean b) Deprecated.

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

UnzipPipe

public UnzipPipe()

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 FixedForwardPipe

Throws:

ConfigurationException

getInputStream

protected InputStream getInputStream(Message message,
                                     PipeLineSession session)
                              throws PipeRunException

Throws:

PipeRunException

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

setDirectory

public void setDirectory(String string)

Directory to extract the archive to

setDirectorySessionKey

public void setDirectorySessionKey(String directorySessionKey)

Sessionkey with a directory value to extract the archive to

setDeleteOnExit

public void setDeleteOnExit(boolean b)

If true, file is automatically deleted upon normal JVM termination

Default value

true

setCollectResults

public void setCollectResults(boolean b)

If set false, only a small summary (count of items in zip) is returned

Default value

true

setCollectFileContents

public void setCollectFileContents(boolean b)

If set true, the contents of the files in the zip are returned in the result xml message of this pipe. Please note this can consume a lot of memory for large files or a large number of files

Default value

false

setCollectFileContentsBase64Encoded

public void setCollectFileContentsBase64Encoded(String string)

Comma separated list of file extensions. Files with an extension which is part of this list will be base64 encoded. All other files are assumed to have UTF-8 when reading it from the zip and are added as escaped xml with non-unicode-characters being replaced by inverted question mark appended with #, the character number and ;

Default value

false

setKeepOriginalFileName

public void setKeepOriginalFileName(boolean b)

If set false, a suffix is added to the original filename to be sure it is unique

Default value

false

setCreateSubDirectories

@Deprecated
 @ConfigurationWarning(value="the attribute \'createSubDirectories\' has been renamed to \'keepOriginalFilePath\'")
public void setCreateSubDirectories(boolean b)

Deprecated.

setKeepOriginalFilePath

public void setKeepOriginalFilePath(boolean b)

If set true, the path of the zip entry will be preserved. Otherwise, the zip entries will be extracted to the root folder

Default value

false

setAssumeDirectoryExists

public void setAssumeDirectoryExists(boolean assumeDirectoryExists)

If set true, validation of directory is ignored

Default value

false

setCheckDirectory

@Deprecated
 @ConfigurationWarning(value="the attribute \'checkDirectory\' has been renamed to \'assumeDirectoryExists\'")
public void setCheckDirectory(boolean checkDirectory)

Deprecated.

setProcessFile

@Deprecated
 @ConfigurationWarning(value="Please add a LocalFileSystemPipe with action=read in front of this pipe instead")
public void setProcessFile(boolean b)

Deprecated.

If set true, the input is assumed to be the name of a file to be processed. Otherwise, the input itself is used.

Default value

false