org.waarp.openr66.client

Class AbstractTransfer

java.lang.Object

org.waarp.openr66.client.AbstractTransfer

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DirectTransfer, ProgressBarTransfer, RecvThroughClient, SendThroughClient, SubmitTransfer

public abstract class AbstractTransfer
extends Object
implements Runnable

Abstract class for Transfer operation

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	block
protected R66Future	future
protected static long	idt
protected static String	INFO_ARGS
protected static boolean	ismd5
protected static String	localFilename
protected static WaarpLogger	logger Internal Logger
protected static String	NO_INFO_ARGS
protected static boolean	nolog
protected boolean	normalInfoAsWarn
protected static String	rhost
protected static String	rule
protected static String	sFollowId
protected static boolean	snormalInfoAsWarn
static String	TIMESTAMP_FORMAT
protected TransferArgs	transferArgs
protected static String	transferInfo
protected static Timestamp	ttimestart

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTransfer(Class<?> clasz, R66Future future, String filename, String rulename, String transferInfo, boolean isMD5, String remoteHost, int blocksize, long id, Timestamp timestart)
protected	AbstractTransfer(Class<?> clasz, R66Future future, TransferArgs transferArgs)

Method Summary

Modifier and Type	Method and Description
protected static void	clear()
protected void	finalizeInErrorTransferRequest(ClientRunner runner, DbTaskRunner taskRunner, ErrorCode code) Shared code for finalize one Transfer request in error
List<String>	getLocalFiles(DbRule dbrule, String[] localfilenames)
protected static boolean	getParams(String[] args, boolean submitOnly) Parse the parameter and set current values
static TransferArgs	getParamsInternal(int rank, String[] args) Internal getParams without configuration initialization, but still as first argument 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
List<String>	getRemoteFiles(String[] localfilenames, String requested, NetworkTransaction networkTransaction)
protected DbTaskRunner	initRequest() Initiate the Request and return a potential DbTaskRunner
protected static void	prepareKoOutputFormat(R66Future future, OutputFormat outputFormat)
protected static void	prepareKoOutputFormat(R66Future future, R66Result result, OutputFormat outputFormat)
protected static void	prepareOkOutputFormat(long delay, R66Result result, OutputFormat outputFormat)
static void	prepareSubmitKoOutputFormat(R66Future future, DbTaskRunner runner, OutputFormat outputFormat)
static void	prepareSubmitOkOutputFormat(DbTaskRunner runner, OutputFormat outputFormat)
static boolean	sendValidPacket(DbHostAuth host, LocalChannelReference localChannelReference, AbstractLocalPacket packet, R66Future future)
void	setNormalInfoAsWarn(boolean normalInfoAsWarn1)
static LocalChannelReference	tryConnect(DbHostAuth host, R66Future future, NetworkTransaction networkTransaction) Helper to connect

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

TIMESTAMP_FORMAT

public static final String TIMESTAMP_FORMAT

See Also:

Constant Field Values

logger

protected static WaarpLogger logger

Internal Logger

INFO_ARGS

protected static final String INFO_ARGS

NO_INFO_ARGS

protected static final String NO_INFO_ARGS

See Also:

Constant Field Values

transferArgs

protected final TransferArgs transferArgs

future

protected final R66Future future

normalInfoAsWarn

protected boolean normalInfoAsWarn

rhost

protected static String rhost

localFilename

protected static String localFilename

rule

protected static String rule

transferInfo

protected static String transferInfo

ismd5

protected static boolean ismd5

block

protected static int block

nolog

protected static boolean nolog

idt

protected static long idt

ttimestart

protected static Timestamp ttimestart

snormalInfoAsWarn

protected static boolean snormalInfoAsWarn

sFollowId

protected static String sFollowId

Constructor Detail

AbstractTransfer

protected AbstractTransfer(Class<?> clasz,
                           R66Future future,
                           TransferArgs transferArgs)

Parameters:

clasz - Class of Client Transfer

future -

transferArgs -

AbstractTransfer

protected AbstractTransfer(Class<?> clasz,
                           R66Future future,
                           String filename,
                           String rulename,
                           String transferInfo,
                           boolean isMD5,
                           String remoteHost,
                           int blocksize,
                           long id,
                           Timestamp timestart)

Parameters:

clasz - Class of Client Transfer

future -

filename -

rulename -

transferInfo -

isMD5 -

remoteHost -

blocksize -

id -

Method Detail

sendValidPacket

public static boolean sendValidPacket(DbHostAuth host,
                                      LocalChannelReference localChannelReference,
                                      AbstractLocalPacket packet,
                                      R66Future future)

Parameters:

host -

localChannelReference -

packet -

future -

Returns:

True if OK

initRequest

protected final DbTaskRunner initRequest()

Initiate the Request and return a potential DbTaskRunner

Returns:

null if an error occurs or a DbTaskRunner

clear

protected static final void clear()

getParams

protected static boolean getParams(String[] args,
                                   boolean submitOnly)

Parse the parameter and set current values

Parameters:

args -

submitOnly - True if the client is only a submitter (through database)

Returns:

True if all parameters were found and correct

getParamsInternal

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

Internal getParams without configuration initialization, but still as first argument

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 - which rank to start on args

args -

Returns:

TransferArgs if OK, null if wrong initialization

finalizeInErrorTransferRequest

protected final void finalizeInErrorTransferRequest(ClientRunner runner,
                                                    DbTaskRunner taskRunner,
                                                    ErrorCode code)

Shared code for finalize one Transfer request in error

Parameters:

runner -

taskRunner -

setNormalInfoAsWarn

public final void setNormalInfoAsWarn(boolean normalInfoAsWarn1)

getRemoteFiles

public final List<String> getRemoteFiles(String[] localfilenames,
                                         String requested,
                                         NetworkTransaction networkTransaction)

getLocalFiles

public final List<String> getLocalFiles(DbRule dbrule,
                                        String[] localfilenames)

tryConnect

public static LocalChannelReference tryConnect(DbHostAuth host,
                                               R66Future future,
                                               NetworkTransaction networkTransaction)

Helper to connect

Parameters:

host -

future -

networkTransaction -

Returns:

localChannelReference not null if ok

prepareKoOutputFormat

protected static void prepareKoOutputFormat(R66Future future,
                                            R66Result result,
                                            OutputFormat outputFormat)

prepareKoOutputFormat

protected static void prepareKoOutputFormat(R66Future future,
                                            OutputFormat outputFormat)

prepareOkOutputFormat

protected static void prepareOkOutputFormat(long delay,
                                            R66Result result,
                                            OutputFormat outputFormat)

prepareSubmitKoOutputFormat

public static void prepareSubmitKoOutputFormat(R66Future future,
                                               DbTaskRunner runner,
                                               OutputFormat outputFormat)

prepareSubmitOkOutputFormat

public static void prepareSubmitOkOutputFormat(DbTaskRunner runner,
                                               OutputFormat outputFormat)