nl.nn.adapterframework.pipes

Class UploadFilePipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.UploadFilePipe

All Implemented Interfaces:

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

Deprecated.

@Deprecated
 @ConfigurationWarning(value="Please replace with UnzipPipe. Configure UnzipPipe with getInputFromSessionKey=\'file\', directorySessionKey=\'destination\' and keepOriginalFileName=\'true\'.")
public class UploadFilePipe
extends FixedForwardPipe

Uploads a zip file (inputstream in a sessionKey) and unzips it to a directory.

Author:

Peter Leeuwenburgh

Field Summary

Fields

Modifier and Type	Field and Description
protected String	directorySessionKey Deprecated.

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
UploadFilePipe() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	configure() Deprecated. checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) Deprecated. This is where the action takes place.
String	getDirectory() Deprecated.
String	getDirectorySessionKey() Deprecated.
String	getSessionKey() Deprecated.
void	setDirectory(String string) Deprecated. base directory where files are unzipped to
void	setDirectorySessionKey(String string) Deprecated. the session key that contains the base directory where files are unzipped to
void	setSessionKey(String string) Deprecated. name of the key in the pipelinesession which contains the inputstream

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, 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, throwEvent

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

Field Detail

directorySessionKey

protected String directorySessionKey

Deprecated.

Constructor Detail

UploadFilePipe

public UploadFilePipe()

Deprecated.

Method Detail

configure

public void configure()
               throws ConfigurationException

Deprecated.

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

doPipe

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

Deprecated.

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 the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.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

setDirectory

public void setDirectory(String string)

Deprecated.

base directory where files are unzipped to

getDirectory

public String getDirectory()

Deprecated.

setDirectorySessionKey

public void setDirectorySessionKey(String string)

Deprecated.

the session key that contains the base directory where files are unzipped to

Default value

destination

getDirectorySessionKey

public String getDirectorySessionKey()

Deprecated.

getSessionKey

public String getSessionKey()

Deprecated.

setSessionKey

public void setSessionKey(String string)

Deprecated.

name of the key in the pipelinesession which contains the inputstream

Default value

file