@Deprecated @ConfigurationWarning(value="Please replace with LocalFileSystemPipe and action=\"move\"") public class MoveFilePipe extends FixedForwardPipe
Modifier and Type | Field and Description |
---|---|
protected String |
move2fileSessionKey
Deprecated.
|
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
MoveFilePipe()
Deprecated.
|
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)
|
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
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
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
protected String move2fileSessionKey
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class FixedForwardPipe
ConfigurationException
public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
IPipe
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.PipeRunException
public void setFilename(String filename)
public String getFilename()
public void setDirectory(String string)
public String getDirectory()
public void setWildcardSessionKey(String string)
public String getWildcardSessionKey()
public void setWildcard(String string)
public String getWildcard()
public void setMove2dir(String string)
public String getMove2dir()
public void setMove2file(String string)
public String getMove2file()
public void setMove2fileSessionKey(String move2fileSessionKey)
public String getMove2fileSessionKey()
public void setNumberOfAttempts(int i)
public int getNumberOfAttempts()
public void setWaitBeforeRetry(long l)
public long getWaitBeforeRetry()
public void setNumberOfBackups(int i)
public int getNumberOfBackups()
public void setOverwrite(boolean b)
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')public boolean isOverwrite()
public void setAppend(boolean b)
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
public boolean isAppend()
public void setDeleteEmptyDirectory(boolean b)
true
, the directory from which a file is moved is deleted when it contains no other filespublic boolean isDeleteEmptyDirectory()
public void setCreateDirectory(boolean b)
true
, the directory to move to is created if it does not existpublic boolean isCreateDirectory()
public void setPrefix(String string)
public String getPrefix()
public void setSuffix(String string)
public String getSuffix()
public void setThrowException(boolean b)
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)public boolean isThrowException()
Copyright © 2023 Frank!Framework. All rights reserved.