flux.file
Interface FileCopyAction

All Superinterfaces:

Action, AgentAction, java.lang.Cloneable, DoubleFileParameter, RenameableDoubleFileParameter, RuntimeDataMap, java.io.Serializable, SingleFileParameter

public interface FileCopyAction
extends Action, RenameableDoubleFileParameter, AgentAction

Copies a group of source files and directories to a group of targets. At flow chart execution time, if at least one error occurs, a FileActionException is thrown.

The File Copy Action returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Field	Java Type	Description
RESULT	filenames	java.util.Map<java.lang.String, java.lang.String>	A map of file sources to destinations for files that were successfully copied. The keys of the map are the original filenames for the source file that was copied. The values of the map are the filenames of the files as stored at the destination location. This result contains file names only and does not include file path / directory information.
RESULT	url_objects	java.util.Map<java.net.URL, java.net.URL>	A map of file sources to destinations for files that were successfully copied. The keys of the map are URL objects containing the location of the source file that was copied. The values of the map are URL objects with the location of the files at the destination location. This field contains the same information as the "url_strings" field, except file names are stored as URL objects, not strings. For all non-file protocols, this map contains the same information as the "url_strings" field.
RESULT	url_strings	java.util.Map<java.lang.String, java.lang.String>	URLs of files for which the file action was carried out successfully. This field contains the same information as the "url_objects" field, except file names are stored as strings, not URL objects.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Methods inherited from interface flux.file.RenameableDoubleFileParameter

getRenamer, setRenamer

Methods inherited from interface flux.file.DoubleFileParameter

addTarget, getTargets, isPreserveDirectoryStructure, setPreserveDirectoryStructure

Methods inherited from interface flux.file.SingleFileParameter

addSource, clear, getSources

Methods inherited from interface flux.agent.AgentAction

getAgentPool, setAgentPool