Package org.waarp.openr66.context.task

Classes implementing Tasks for pre, post or error operations Several kind of tasks exist in OpenR66:
LOG, MOVE, MOVERENAME, COPY, COPYRENAME, EXEC, EXECMOVE, LINKRENAME, TRANSFER, VALIDFILEPATH, DELETE



Several tasks are possible to run before a transfer starts (pre action), after a transfer is finished correctly (post action) or after an error occurs (either in pre or post action or during transfer: error action).

See: Description

Interface Summary

Interface	Description
R66Runnable	Runnable interface for internal R66 tasks (through Rule EXECJAVA, or through message BusinessRequestPacket)

Class Summary

Class	Description
AbstractExecJavaTask	Dummy Runnable Task that only logs
AbstractExecTask	Execute an external command It provides some common functionnalities.
AbstractTask	Abstract implementation of task
ChModTask	This task allows to change the mode of the file (as in Unix CHMOD command) according to the following argument: - the full path is get from the current file - the arg path is transformed as usual (static and dynamic from information transfer) - this final path arg should be of the form [ua][+-=][rwx] where multiple elements could be specified, separated by blank character - u/a meaning user(Waarp system user)/all (group and other do not exist in Java), +/-/= meaning add/remove/set (set means all other values are removed), r/w/x meaning Read/Write/Execute For instance, the final path arg could be: u=rwx a=r ua+rw u=rw a-wx a+rw Current access mode for the application will be applied as default "user" access mode, and no access mode (-rwx) will be the default for "all" access mode.
CopyRenameTask	Copy and Rename task
CopyTask	Copy task
DeleteTask	Delete the file.
ExecBusinessTask	Business Execution of a Java Task Fullarg = First argument is the Java class name, Last argument is the delay.
ExecJavaTask	Execute a Java command through Class.forName call
ExecMoveTask	Execute an external command and Rename the file (using the new name from the result).
ExecOutputTask	Execute an external command and Use the output if an error occurs.
ExecTask	Execute an external command
FileCheckTask	This task checks some properties relative to the File according to the following argument: - SIZE LT/GT/LTE/GTE/EQ number : to check the file size according to a limit (less than, greater than, less than or equal, greater than or equal, equal) - DFCHECK : to check if the future received file size is compatible with the space left on both working and received directories (from general configuration or rule configuration) For instance "SIZE LT 10000000 SIZE GT 1000 DFCHECK" will test that the current file size is less than 10 MB (base 10), and greater than 1000 bytes, and that the working and received directories have enough space to receive the file.
FtpArgs	Class to parse arguments for FTP command
FtpTransferTask	Ftp Transfer task: synchronous Result of arguments will be as FTP command.
LinkRenameTask	Create a link of the current file and make the file pointing to it.
LogTask	This class is for logging or write to an external file some info: - if delay is 0, no echo at all will be done - if delay is 1, will echo some information in the normal log - if delay is 2, will echo some information in the file (last deduced argument will be the full path for the file output) - if delay is 3, will echo both in the normal log and in the file (last deduced argument will be the full path for the file output) If first word for logging is one of debug, info, warn, error, then the corresponding level of log will be used.
MoveRenameTask	Move and Rename the current file
MoveTask	Move the file (without renaming it)
RenameTask	Rename the current file (no move, move or creation should be done elsewhere)
RescheduleTransferTask	Reschedule Transfer task to a time delayed by the specified number of milliseconds, if the error code is one of the specified codes and the optional intervals of date are compatible with the new time schedule Result of arguments will be as following options (the two first are mandatory): "-delay ms" where ms is the added number of ms on current time before retry on schedule "-case errorCode,errorCode,..." where errorCode is one of the following error of the current transfer (either literal or code in 1 character: ConnectionImpossible(C), ServerOverloaded(l), BadAuthent(A), ExternalOp(E), TransferError(T), MD5Error(M), Disconnection(D), RemoteShutdown(r), FinalOp(F), Unimplemented(U), Shutdown(S), RemoteError(R), Internal(I), StoppedTransfer(H), CanceledTransfer(K), Warning(W), Unknown(-), QueryAlreadyFinished(Q), QueryStillRunning(s), NotKnownHost(N), QueryRemotelyUnknown(u), FileNotFound(f), CommandNotFound(c), PassThroughMode(p) "-between start;end" and/or "-notbetween start;end" (multiple times are allowed, start or end can be not set) and where start and stop are in the following format: Yn:Mn:Dn:Hn:mn:Sn where n is a number for each time specification, each specification is optional, as Y=Year, M=Month, D=Day, H=Hour, m=minute, s=second.
RestartServerTask	Command to Restart the R66 server (for instance after upgrade of jar sent by administrative operations, unzipped in the library directory)
SnmpTask	This class is for sending a SNMP trap/info (according to snmp configuration): - if delay is 0, only a warning will be send with the message accordingly - if delay is 1, a notification with the current task and the current message will be send
SpooledInformTask	Java Task for SpooledDirectory information to the Waarp Server
SpooledInformTask.SpooledInformation
TarTask	TAR task
TranscodeTask	Transcode the current file from one Charset to another Charset as specified Arguments are: -dos2unix or -unix2dos (only one) ; optional argument, but if present -from and -to might be omitted; -from charset -to charset -newfile newfilename ; optional argument ; if not used, will be current filename.extension ; if used, extension is ignored -extension extension ; optional argument ; if not used, will be filename.transcode A convenient method (from Waarp Common) allows to list in html (-html), csv (-csv) or text format (-text) all the supported Charsets from your JVM.
TransferTask	Transfer task: Result of arguments will be as r66send command.
UnzeroedFileTask	This task add 1 byte to empty file if the current file is empty (0 length).
ValidFilePathTask	This task validate the File Path according to the following argument: - the full path is get from the current file - the arg path is transformed as usual (static and dynamic from information transfer) and should be the beginning of the correct valid path - the full path should begin with one of the result of the transformation (blank separated) For instance "#OUTPATH# #INPATH# #WORKPATH# #ARHCPATH#" will test that the current file is in one of the standard path.
ZipTask	TAR task

Enum Summary

Enum	Description
TaskType	This enum class references all available tasks.

Package org.waarp.openr66.context.task Description

Classes implementing Tasks for pre, post or error operations

Several kind of tasks exist in OpenR66:
LOG, MOVE, MOVERENAME, COPY, COPYRENAME, EXEC, EXECMOVE, LINKRENAME, TRANSFER, VALIDFILEPATH, DELETE

Several tasks are possible to run before a transfer starts (pre action), after a transfer is finished correctly (post action) or after an error occurs (either in pre or post action or during transfer: error action).

Those actions are defined in one rule. Each rule contains 2 parts:

• Sender actions: A host is a Sender if it is the requester on a SEND rule or if it is the requested on a RECV rule.
• Receiver actions: A host is a Sender if it is the requester on a RECV rule or if it is the requested on a SEND rule.

Each action could be on pre, post or error step, each step can have several actions.

It is defined with a unified form of XML:

<tasks> <task> <type>NAME</type> <path>path</path> <delay>x</delay> </task> <task> <type>NAME</type> <path>path</path> <delay>x</delay> </task> </tasks>
Where

• Type is the type of task to execute (see below the supported types)
• Path is a fixed argument for the task to execute. On this argument, string replacements are done when the following patterns are found:
  • #TRUEFULLPATH# : Current full path of current FILENAME
  • #TRUEFILENAME# : Current FILENAME (basename) (change in retrieval part)
  • #ORIGINALFULLPATH# : Original full path FILENAME (before changing in retrieval part)
  • #ORIGINALFILENAME# : Original FILENAME (basename) (before changing in retrieval part)
  • #FILESIZE# : File size if it exists
  • #INPATH# : In (Receive) path
  • #OUTPATH# : Out (Send) path
  • #WORKPATH# : Working (while receiving) path
  • #ARCHPATH# : Archive path (for export Log)
  • #HOMEPATH# : Home path (to enable for instance relative path commands)
  • #RULE# : Rule used during transfer
  • #DATE# : Current Date in yyyyMMdd format
  • #HOUR# : Current Hour in HHmmss format
  • #REMOTEHOST# : Remote host Id (if not the initiator of the call)
  • #LOCALHOST# : Local host Id
  • #TRANSFERID# : Transfer Id
  • #REQUESTERHOST# : Requester host Id
  • #REQUESTEDHOST# : Requested host Id
  • #FULLTRANSFERID# : Full Transfer Id as TRANSFERID_REQUESTERHOST_REQUESTEDHOST
  • #RANKTRANSFER# : Current or final RANK of block
  • #BLOCKSIZE# : Block size used
• Delay is generally the delay (if any) for execution before the execution becomes out of time.
• Additionnaly, a task will use also the argument from the transfer itself (Transfer Information).

The different kinds of TASK are:

• LOG
This task logs or writes to an external file some info:
- if delay is 0, no echo at all will be done
- if delay is 1, will echo some information in the normal log
- if delay is 2, will echo some information in the file (last deduced argument will be the full path for the file output)
- if delay is 3, will echo both in the normal log and in the file (last deduced argument will be the full path for the file output)
• MOVE
Move the file to the path designed by Path and Transfer Information arguments without renaming the filename (same basename). Delay is ignored. The file is marked as moved.
• MOVERENAME
Move the file to the path designed by Path and Transfer Information arguments. Delay is ignored. After Path is transformed according to above dynamic replacements, it is then used as a String Format where Transfer Information is used as input (String.format(Path,Info)). The file is marked as moved.
• COPY
Copy the file to the path designed by Path argument without renaming the filename (same basename). Delay and Transfer Information are ignored. The file is not marked as moved.
• COPYRENAME
Copy the file to the path designed by Path and Transfer Information arguments. Delay is ignored. After Path is transformed according to above dynamic replacements, it is then used as a String Format where Transfer Information is used as input (String.format(Path,Info)). The file is not marked as moved.
• EXEC
Execute an external command given by Path and Transfer Information arguments. The Delay is the maximum amount of time in milliseconds before the task should be considered as over time and so in error.
The command path is obtained from Path transformed according to above dynamic replacements, and after a String Format where Transfer Information is used as input (String.format(Path,Info)).
• EXECMOVE
Execute an external command given by Path and Transfer Information arguments. The Delay is the maximum amount of time in milliseconds before the task should be considered as over time and so in error.
The command path is obtained from Path transformed according to above dynamic replacements, and after a String Format where Transfer Information is used as input (String.format(Path,Info)).
The last line returned by the external command is interpreted as the new full file path. The external command is responsible to really move the previous file to the new one. The file is marked as moved.
• TRANSFER
Submit a new transfer based on the Path and Transfer Information arguments. The transfer arguments are obtained from Path transformed according to above dynamic replacements, and after a String Format where Transfer Information is used as input (String.format(Path,Info)). The result should be as r66send except that "-info" must be the last entry:
"-file filepath -to requestedHost -rule rule [-md5] -info transferInformation" where each field is separated by blank character. Last field (transferInformation) may contain however blank character. Delay is ignored. The file is not marked as moved.
• VALIDFILEPATH
Test if the current file is under one of the paths based on the Path and Transfer Information arguments. The paths arguments are obtained from Path transformed according to above dynamic replacements, and after a String Format where Transfer Information is used as input (String.format(Path,Info)). The result should be as: "path1 path2 ..." where each path is separated by blank character. If Delay is not 0, a log is printed out. The file is not marked as moved.
• DELETE
This task deletes the current file.The current file is no more valid. No arguments are taken into account.
• LINKRENAME
Create a link of the current file and make the file pointing to it. The link first tries to be a hard link, then a soft link, and if it is really not possible (not supported by the filesystem), it does a copy and rename task.
Delay is ignored. After Path is transformed according to above dynamic replacements, it is then used as a String Format where Transfer Information is used as input (String.format(Path,Info)). The file is not marked as moved.