Package com.dtolabs.rundeck.core.execution.service

Interface FileCopier

All Known Subinterfaces:

DestinationFileCopier, MultiFileCopier

All Known Implementing Classes:

LocalFileCopier, ScriptPluginFileCopier

public interface FileCopier

FileCopier copies a file or its contents to a local or remote node. The destination on the node is not predetermined, but some utility methods of BaseFileCopier can be used to generate a destination file path.

See Also:

MultiFileCopier

Method Summary

Modifier and Type	Method	Description
java.lang.String	copyFile(ExecutionContext context, java.io.File file, INodeEntry node, java.lang.String destination)	Copy the contents of an input stream to the node
java.lang.String	copyFileStream(ExecutionContext context, java.io.InputStream input, INodeEntry node, java.lang.String destination)	Copy the contents of an input stream to the node
java.lang.String	copyScriptContent(ExecutionContext context, java.lang.String script, INodeEntry node, java.lang.String destination)	Copy the contents of an input stream to the node

Method Detail

copyFileStream

java.lang.String copyFileStream(ExecutionContext context,
                                java.io.InputStream input,
                                INodeEntry node,
                                java.lang.String destination)
                         throws FileCopierException

Copy the contents of an input stream to the node

Parameters:

context - context

input - the input stream

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs

copyFile

java.lang.String copyFile(ExecutionContext context,
                          java.io.File file,
                          INodeEntry node,
                          java.lang.String destination)
                   throws FileCopierException

Copy the contents of an input stream to the node

Parameters:

context - context

file - local file tocopy

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs

copyScriptContent

java.lang.String copyScriptContent(ExecutionContext context,
                                   java.lang.String script,
                                   INodeEntry node,
                                   java.lang.String destination)
                            throws FileCopierException

Copy the contents of an input stream to the node

Parameters:

context - context

script - file content string

node - node

destination - the full path destination for the file

Returns:

File path of the file after copying to the node

Throws:

FileCopierException - if an error occurs