org.waarp.gateway.ftp.exec

Class AbstractExecutor

java.lang.Object

org.waarp.gateway.ftp.exec.AbstractExecutor

Direct Known Subclasses:

ExecuteExecutor, JavaExecutor, NoTaskExecutor, R66PreparedTransferExecutor

public abstract class AbstractExecutor
extends Object

Abstract Executor 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.
If the command starts with "EXECUTE", the following will be a command to be executed.
If the command starts with "JAVAEXECUTE", the following will be a command through Java class to be executed.
If the command starts with "R66PREPARETRANSFER", the following will be a r66 prepare transfer execution (asynchronous operation only).

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#)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractExecutor.CommandExecutor

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACCOUNT
protected static String	BASEPATH
protected static Pattern	BLANK
protected static String	COMMAND
protected static AbstractExecutor.CommandExecutor	commandExecutor
protected static String	EXECUTE
protected static String	FILE
protected static String	JAVAEXECUTE
protected static String	NONE
protected static String	R66PREPARETRANSFER
protected static String	REFUSED
protected static String	S_UUID
protected static String	SPECIALID
protected static int	T_EXECUTE
protected static int	T_JAVAEXECUTE
protected static int	T_NONE
protected static int	T_R_66_PREPARETRANSFER
protected static int	T_REFUSED
static boolean	useDatabase For OpenR66 access
static boolean	useLocalExec Local Exec Daemon is used or not for execution of external commands
protected static String	USER

Constructor Summary

Constructors

Constructor and Description
AbstractExecutor()

Method Summary

Modifier and Type	Method and Description
static AbstractExecutor	createAbstractExecutor(HttpAuthInterface auth, String[] args, boolean isStore, WaarpFuture futureCompletion)
static AbstractExecutor.CommandExecutor	getCommandExecutor()
static String	getPreparedCommand(String command, String[] args)
static void	initializeExecutor(String retrieve, long retrDelay, String store, long storDelay) Initialize the Executor with the correct command and delay
static boolean	isValidOperation(boolean isStore) Check if the given operation is allowed Globally
static boolean	replace(StringBuilder builder, String find, String replace) Make a replacement of first "find" string by "replace" string into the StringBuilder
static void	replaceAll(StringBuilder builder, String find, String replace) Make replacement of all "find" string by "replace" string into the StringBuilder
abstract void	run()

Methods inherited from class java.lang.Object

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

Field Detail

BLANK

protected static final Pattern BLANK

USER

protected static final String USER

See Also:

Constant Field Values

ACCOUNT

protected static final String ACCOUNT

See Also:

Constant Field Values

BASEPATH

protected static final String BASEPATH

See Also:

Constant Field Values

FILE

protected static final String FILE

See Also:

Constant Field Values

COMMAND

protected static final String COMMAND

See Also:

Constant Field Values

SPECIALID

protected static final String SPECIALID

See Also:

Constant Field Values

S_UUID

protected static final String S_UUID

See Also:

Constant Field Values

REFUSED

protected static final String REFUSED

See Also:

Constant Field Values

NONE

protected static final String NONE

See Also:

Constant Field Values

EXECUTE

protected static final String EXECUTE

See Also:

Constant Field Values

JAVAEXECUTE

protected static final String JAVAEXECUTE

See Also:

Constant Field Values

R66PREPARETRANSFER

protected static final String R66PREPARETRANSFER

See Also:

Constant Field Values

T_REFUSED

protected static final int T_REFUSED

See Also:

Constant Field Values

T_NONE

protected static final int T_NONE

See Also:

Constant Field Values

T_EXECUTE

protected static final int T_EXECUTE

See Also:

Constant Field Values

T_R_66_PREPARETRANSFER

protected static final int T_R_66_PREPARETRANSFER

See Also:

Constant Field Values

T_JAVAEXECUTE

protected static final int T_JAVAEXECUTE

See Also:

Constant Field Values

commandExecutor

protected static AbstractExecutor.CommandExecutor commandExecutor

useDatabase

public static boolean useDatabase

For OpenR66 access

useLocalExec

public static boolean useLocalExec

Local Exec Daemon is used or not for execution of external commands

Constructor Detail

AbstractExecutor

public AbstractExecutor()

Method Detail

initializeExecutor

public static void initializeExecutor(String retrieve,
                                      long retrDelay,
                                      String store,
                                      long storDelay)

Initialize the Executor with the correct command and delay

Parameters:

retrieve -

retrDelay -

store -

storDelay -

isValidOperation

public static boolean isValidOperation(boolean isStore)

Check if the given operation is allowed Globally

Parameters:

isStore -

Returns:

True if allowed, else False

createAbstractExecutor

public static AbstractExecutor createAbstractExecutor(HttpAuthInterface auth,
                                                      String[] args,
                                                      boolean isStore,
                                                      WaarpFuture futureCompletion)

Parameters:

auth - the current Authentication

args - containing in that order "User Account BaseDir FilePath(relative to BaseDir) Command"

isStore - True for a STORE like operation, else False

futureCompletion -

getPreparedCommand

public static String getPreparedCommand(String command,
                                        String[] args)

Parameters:

command -

args - as {User, Account, BaseDir, FilePath(relative to BaseDir), Command}

Returns:

the prepared command

replace

public static boolean replace(StringBuilder builder,
                              String find,
                              String replace)

Make a replacement of first "find" string by "replace" string into the StringBuilder

Parameters:

builder -

find -

replace -

replaceAll

public static void replaceAll(StringBuilder builder,
                              String find,
                              String replace)

Make replacement of all "find" string by "replace" string into the StringBuilder

Parameters:

builder -

find -

replace -

getCommandExecutor

public static AbstractExecutor.CommandExecutor getCommandExecutor()

run

public abstract void run()
                  throws CommandAbstractException

Throws:

CommandAbstractException