org.waarp.gateway.ftp.exec

Class R66PreparedTransferExecutor

java.lang.Object

org.waarp.gateway.ftp.exec.AbstractExecutor

org.waarp.gateway.ftp.exec.R66PreparedTransferExecutor

public class R66PreparedTransferExecutor
extends AbstractExecutor

R66PreparedTransferExecutor class. If the command starts with "REFUSED", the command will be refused for execution. If "REFUSED" is set, the command "RETR" or "STOR" like operations will be stopped at starting of command.

Format is like r66send command in any order except "-info" which should be the last item:
"-to Host -file FILE -rule RULE [-md5] [-nolog] [-start yyyyMMddHHmmss or -delay (delay or +delay)] [-info INFO]"

INFO is the only one field that can contains blank character and MUST be the last argument.

The following replacement are done dynamically before the command is executed:
- #BASEPATH# is replaced by the full path for the root of FTP Directory
- #FILE# is replaced by the current file path relative to FTP Directory (so #BASEPATH##FILE# is the full path of the file)
- #USER# is replaced by the username
- #ACCOUNT# is replaced by the account
- #COMMAND# is replaced by the command issued for the file
- #SPECIALID# is replaced by the FTP id of the transfer (whatever in or out)
- #UUID# is replaced by a special UUID globally unique for the transfer, in general to be placed in -info part (for instance ##UUID## giving #uuid#)

So for instance "-to Host -file #BASEPATH##FILE# -rule RULE [-md5] [-nolog] [-delay +delay] [-info ##UUID## #USER# #ACCOUNT# #COMMAND# INFO]"
will be a standard use of this function.

Nested Class Summary

Nested classes/interfaces inherited from class org.waarp.gateway.ftp.exec.AbstractExecutor

AbstractExecutor.CommandExecutor

Field Summary

Fields

Modifier and Type	Field and Description
protected WaarpFuture	future
protected boolean	nolog
protected TransferArgs	transferArgs

Fields inherited from class org.waarp.gateway.ftp.exec.AbstractExecutor

ACCOUNT, BASEPATH, BLANK, COMMAND, commandExecutor, EXECUTE, FILE, JAVAEXECUTE, NONE, R66PREPARETRANSFER, REFUSED, S_UUID, SPECIALID, T_EXECUTE, T_JAVAEXECUTE, T_NONE, T_R_66_PREPARETRANSFER, T_REFUSED, useDatabase, useLocalExec, USER

Constructor Summary

Constructors

Constructor and Description

R66PreparedTransferExecutor(String command, long delay, WaarpFuture futureCompletion) Transfer arguments: -to Specify the requested Host (-id | Specify the id of transfer (-file Specify the file path to operate on -rule )) Specify the Rule [-block ] Specify the block size [-nofollow] Specify the transfer should not integrate a FOLLOW id [-md5] Specify the option to have a hash computed for the transfer [-delay ] Specify the delay time as an epoch time or '+' a delay in ms [-start ] Specify the start time as yyyyMMddHHmmss [-info ) Specify the transfer information (generally in last position) [-nolog] Specify to not log anything included database once the transfer is done [-notlogWarn | Specify to log final result as Info if OK -logWarn] Specify to log final result as Warn if OK

Method Summary

Modifier and Type	Method and Description
void	run()

Methods inherited from class org.waarp.gateway.ftp.exec.AbstractExecutor

createAbstractExecutor, getCommandExecutor, getPreparedCommand, initializeExecutor, isValidOperation, replace, replaceAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

future

protected final WaarpFuture future

transferArgs

protected final TransferArgs transferArgs

nolog

protected boolean nolog

Constructor Detail

R66PreparedTransferExecutor

public R66PreparedTransferExecutor(String command,
                                   long delay,
                                   WaarpFuture futureCompletion)

Transfer arguments:

-to Specify the requested Host
(-id | Specify the id of transfer
(-file Specify the file path to operate on
-rule )) Specify the Rule
[-block ] Specify the block size
[-nofollow] Specify the transfer should not integrate a FOLLOW id
[-md5] Specify the option to have a hash computed for the transfer
[-delay ] Specify the delay time as an epoch time or '+' a delay in ms
[-start ] Specify the start time as yyyyMMddHHmmss
[-info ) Specify the transfer information (generally in last position)
[-nolog] Specify to not log anything included database once the transfer is done
[-notlogWarn | Specify to log final result as Info if OK
-logWarn] Specify to log final result as Warn if OK

Parameters:

command - transfer arguments

delay - delay

futureCompletion - future for completion

Method Detail

run

public final void run()
               throws CommandAbstractException

Specified by:

run in class AbstractExecutor

Throws:

CommandAbstractException