nl.nn.adapterframework.pipes

Class MoveFilePipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.MoveFilePipe

All Implemented Interfaces:

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

Deprecated.

Please use LocalFileSystemPipe with action="move"

@Deprecated
 @ConfigurationWarning(value="Please replace with LocalFileSystemPipe and action=\"move\"")
public class MoveFilePipe
extends FixedForwardPipe

Pipe for moving files to another directory.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	move2fileSessionKey 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
MoveFilePipe() 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	getFilename() Deprecated.
String	getMove2dir() Deprecated.
String	getMove2file() Deprecated.
String	getMove2fileSessionKey() Deprecated.
int	getNumberOfAttempts() Deprecated.
int	getNumberOfBackups() Deprecated.
String	getPrefix() Deprecated.
String	getSuffix() Deprecated.
long	getWaitBeforeRetry() Deprecated.
String	getWildcard() Deprecated.
String	getWildcardSessionKey() Deprecated.
boolean	isAppend() Deprecated.
boolean	isCreateDirectory() Deprecated.
boolean	isDeleteEmptyDirectory() Deprecated.
boolean	isOverwrite() Deprecated.
boolean	isThrowException() Deprecated.
void	setAppend(boolean b) Deprecated. when set true and the destination file already exists, the content of the file to move is written to the end of the destination file.
void	setCreateDirectory(boolean b) Deprecated. when set to true, the directory to move to is created if it does not exist
void	setDeleteEmptyDirectory(boolean b) Deprecated. when set to true, the directory from which a file is moved is deleted when it contains no other files
void	setDirectory(String string) Deprecated. base directory where files are moved from
void	setFilename(String filename) Deprecated. name of the file to move (if not specified, the input for this pipe is assumed to be the name of the file
void	setMove2dir(String string) Deprecated. destination directory
void	setMove2file(String string) Deprecated. name of the destination file (if not specified, the name of the file to move is taken)
void	setMove2fileSessionKey(String move2fileSessionKey) Deprecated. session key that contains the name of the file to use (only used if move2file is not set)
void	setNumberOfAttempts(int i) Deprecated. maximum number of attempts before throwing an exception
void	setNumberOfBackups(int i) Deprecated. number of copies held of a file with the same name.
void	setOverwrite(boolean b) Deprecated. when set true, the destination file will be deleted if it already exists.
void	setPrefix(String string) Deprecated. string which is inserted at the start of the destination file
void	setSuffix(String string) Deprecated. string which is inserted at the end of the destination file (and replaces the extension if present)
void	setThrowException(boolean b) Deprecated. when true, numberofbackups is set to 0 and the destination file already exists a piperunexception is thrown (instead of adding a counter to the destination filename)
void	setWaitBeforeRetry(long l) Deprecated. Time in milliseconds between attempts
void	setWildcard(String string) Deprecated. filter of files to replace
void	setWildcardSessionKey(String string) Deprecated. session key that contains the name of the filter to use (only used if wildcard is not set)

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

move2fileSessionKey

protected String move2fileSessionKey

Deprecated.

Constructor Detail

MoveFilePipe

public MoveFilePipe()

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

setFilename

public void setFilename(String filename)

Deprecated.

name of the file to move (if not specified, the input for this pipe is assumed to be the name of the file

getFilename

public String getFilename()

Deprecated.

setDirectory

public void setDirectory(String string)

Deprecated.

base directory where files are moved from

getDirectory

public String getDirectory()

Deprecated.

setWildcardSessionKey

public void setWildcardSessionKey(String string)

Deprecated.

session key that contains the name of the filter to use (only used if wildcard is not set)

getWildcardSessionKey

public String getWildcardSessionKey()

Deprecated.

setWildcard

public void setWildcard(String string)

Deprecated.

filter of files to replace

getWildcard

public String getWildcard()

Deprecated.

setMove2dir

public void setMove2dir(String string)

Deprecated.

destination directory

getMove2dir

public String getMove2dir()

Deprecated.

setMove2file

public void setMove2file(String string)

Deprecated.

name of the destination file (if not specified, the name of the file to move is taken)

getMove2file

public String getMove2file()

Deprecated.

setMove2fileSessionKey

public void setMove2fileSessionKey(String move2fileSessionKey)

Deprecated.

session key that contains the name of the file to use (only used if move2file is not set)

getMove2fileSessionKey

public String getMove2fileSessionKey()

Deprecated.

setNumberOfAttempts

public void setNumberOfAttempts(int i)

Deprecated.

maximum number of attempts before throwing an exception

Default value

10

getNumberOfAttempts

public int getNumberOfAttempts()

Deprecated.

setWaitBeforeRetry

public void setWaitBeforeRetry(long l)

Deprecated.

Time in milliseconds between attempts

Default value

1000

getWaitBeforeRetry

public long getWaitBeforeRetry()

Deprecated.

setNumberOfBackups

public void setNumberOfBackups(int i)

Deprecated.

number of copies held of a file with the same name. backup files have a dot and a number suffixed to their name. if set to 0, no backups will be kept.

Default value

5

getNumberOfBackups

public int getNumberOfBackups()

Deprecated.

setOverwrite

public void setOverwrite(boolean b)

Deprecated.

when set true, the destination file will be deleted if it already exists. when set false and numberofbackups set to 0, a counter is added to the destination filename ('basename_###.ext')

Default value

false

isOverwrite

public boolean isOverwrite()

Deprecated.

setAppend

public void setAppend(boolean b)

Deprecated.

when set true and the destination file already exists, the content of the file to move is written to the end of the destination file. this implies overwrite=false

Default value

false

isAppend

public boolean isAppend()

Deprecated.

setDeleteEmptyDirectory

public void setDeleteEmptyDirectory(boolean b)

Deprecated.

when set to true, the directory from which a file is moved is deleted when it contains no other files

Default value

false

isDeleteEmptyDirectory

public boolean isDeleteEmptyDirectory()

Deprecated.

setCreateDirectory

public void setCreateDirectory(boolean b)

Deprecated.

when set to true, the directory to move to is created if it does not exist

Default value

false

isCreateDirectory

public boolean isCreateDirectory()

Deprecated.

setPrefix

public void setPrefix(String string)

Deprecated.

string which is inserted at the start of the destination file

getPrefix

public String getPrefix()

Deprecated.

setSuffix

public void setSuffix(String string)

Deprecated.

string which is inserted at the end of the destination file (and replaces the extension if present)

getSuffix

public String getSuffix()

Deprecated.

setThrowException

public void setThrowException(boolean b)

Deprecated.

when true, numberofbackups is set to 0 and the destination file already exists a piperunexception is thrown (instead of adding a counter to the destination filename)

Default value

false

isThrowException

public boolean isThrowException()

Deprecated.