org.waarp.openr66.client

Class TransferArgs

java.lang.Object

org.waarp.openr66.client.TransferArgs

public class TransferArgs
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_ARG
static String	CSV_ARG
static String	DELAY_ARG
static String	FILE_ARG
static String	FOLLOW_JSON_KEY
static String	HASH_ARG
static String	ID_ARG
static String	INFO_ARG
static String	JSON_ARG
static String	LOGWARN_ARG
static String	NO_FOLLOW_ARG
static String	NOTLOG_ARG
static String	NOTLOGWARN_ARG
static String	PROPERTY_ARG
static String	QUIET_ARG
static String	RULE_ARG
static String	SEPARATOR_SEND
static String	START_ARG
static String	TO_ARG
static String	XML_ARG

Constructor Summary

Constructors

Constructor and Description
TransferArgs() Empty constructor

Method Summary

Modifier and Type	Method and Description
static void	analyzeFollow(TransferArgs transferArgs1) Analyze Follow option: fill it if Follow is "" (do not if null).
static void	forceAnalyzeFollow(AbstractTransfer abstractTransfer) Mainly Junit, but also special command where Follow Id might be lost or not set
static void	getAllInfo(TransferArgs transferArgs, int rank, String[] args, String copiedInfo) Get all Info in case of last argument
int	getBlockSize()
String	getFilename()
String	getFollowId()
long	getId()
static TransferArgs	getParamsInternal(int rank, String[] args, boolean analyseFollow) Analyze the parameters according to TransferArgs options 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
String	getRemoteHost()
String	getRulename()
Timestamp	getStartTime()
String	getTransferInfo()
boolean	isMD5()
boolean	isNolog()
boolean	isNormalInfoAsWarn()
static void	printHelp() Print to standard output the help of this command
TransferArgs	setBlockSize(int blocksize)
TransferArgs	setFilename(String filename)
TransferArgs	setFollowId(String followId)
TransferArgs	setId(long id)
TransferArgs	setMD5(boolean md5)
TransferArgs	setNolog(boolean nolog)
TransferArgs	setNormalInfoAsWarn(boolean normalInfoAsWarn)
TransferArgs	setRemoteHost(String remoteHost)
TransferArgs	setRulename(String rulename)
TransferArgs	setStartTime(Timestamp startTime)
TransferArgs	setTransferInfo(String transferInfo)

Methods inherited from class java.lang.Object

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

Field Detail

FILE_ARG

public static final String FILE_ARG

See Also:

Constant Field Values

TO_ARG

public static final String TO_ARG

See Also:

Constant Field Values

RULE_ARG

public static final String RULE_ARG

See Also:

Constant Field Values

ID_ARG

public static final String ID_ARG

See Also:

Constant Field Values

NO_FOLLOW_ARG

public static final String NO_FOLLOW_ARG

See Also:

Constant Field Values

FOLLOW_JSON_KEY

public static final String FOLLOW_JSON_KEY

See Also:

Constant Field Values

INFO_ARG

public static final String INFO_ARG

See Also:

Constant Field Values

HASH_ARG

public static final String HASH_ARG

See Also:

Constant Field Values

BLOCK_ARG

public static final String BLOCK_ARG

See Also:

Constant Field Values

START_ARG

public static final String START_ARG

See Also:

Constant Field Values

DELAY_ARG

public static final String DELAY_ARG

See Also:

Constant Field Values

LOGWARN_ARG

public static final String LOGWARN_ARG

See Also:

Constant Field Values

NOTLOGWARN_ARG

public static final String NOTLOGWARN_ARG

See Also:

Constant Field Values

NOTLOG_ARG

public static final String NOTLOG_ARG

See Also:

Constant Field Values

QUIET_ARG

public static final String QUIET_ARG

See Also:

Constant Field Values

CSV_ARG

public static final String CSV_ARG

See Also:

Constant Field Values

XML_ARG

public static final String XML_ARG

See Also:

Constant Field Values

JSON_ARG

public static final String JSON_ARG

See Also:

Constant Field Values

PROPERTY_ARG

public static final String PROPERTY_ARG

See Also:

Constant Field Values

SEPARATOR_SEND

public static final String SEPARATOR_SEND

See Also:

Constant Field Values

Constructor Detail

TransferArgs

public TransferArgs()

Empty constructor

Method Detail

printHelp

public static void printHelp()

Print to standard output the help of this command

getParamsInternal

public static TransferArgs getParamsInternal(int rank,
                                             String[] args,
                                             boolean analyseFollow)

Analyze the parameters according to TransferArgs options

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:

rank - the rank to analyze from

args - the argument to analyze

analyseFollow - if True, will check follow possible argument in info

Returns:

the TransferArgs or null if an error occurs

getAllInfo

public static void getAllInfo(TransferArgs transferArgs,
                              int rank,
                              String[] args,
                              String copiedInfo)

Get all Info in case of last argument

Parameters:

transferArgs - the original TransferArgs

rank - the rank to start from in args array

args - the original arguments

copiedInfo - might be null, original information to copy

forceAnalyzeFollow

public static void forceAnalyzeFollow(AbstractTransfer abstractTransfer)

Mainly Junit, but also special command where Follow Id might be lost or not set

Parameters:

abstractTransfer -

analyzeFollow

public static void analyzeFollow(TransferArgs transferArgs1)

Analyze Follow option: fill it if Follow is "" (do not if null). It corrects argument of information if needed.

Parameters:

transferArgs1 - the current TransferArgs

getFilename

public final String getFilename()

setFilename

public final TransferArgs setFilename(String filename)

getRulename

public final String getRulename()

setRulename

public final TransferArgs setRulename(String rulename)

getTransferInfo

public final String getTransferInfo()

setTransferInfo

public final TransferArgs setTransferInfo(String transferInfo)

isMD5

public final boolean isMD5()

setMD5

public final TransferArgs setMD5(boolean md5)

getRemoteHost

public final String getRemoteHost()

setRemoteHost

public final TransferArgs setRemoteHost(String remoteHost)

getBlockSize

public final int getBlockSize()

setBlockSize

public final TransferArgs setBlockSize(int blocksize)

getId

public final long getId()

setId

public final TransferArgs setId(long id)

getStartTime

public final Timestamp getStartTime()

setStartTime

public final TransferArgs setStartTime(Timestamp startTime)

getFollowId

public final String getFollowId()

setFollowId

public final TransferArgs setFollowId(String followId)

isNormalInfoAsWarn

public final boolean isNormalInfoAsWarn()

setNormalInfoAsWarn

public final TransferArgs setNormalInfoAsWarn(boolean normalInfoAsWarn)

isNolog

public final boolean isNolog()

setNolog

public final TransferArgs setNolog(boolean nolog)