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

Interface MultiFileCopier

All Superinterfaces:

FileCopier

public interface MultiFileCopier
extends FileCopier

An optional extension of FileCopier that provides a way to copy multiple files at once, the method copyFiles(ExecutionContext, File, List, String, INodeEntry) can be overridden to perform a more efficient multi file copy. Otherwise the FileCopier.copyFile(ExecutionContext, File, INodeEntry, String) is called repeatedly.

Since:

3/30/17

Method Summary

Modifier and Type	Method	Description
default java.lang.String[]	copyFiles(ExecutionContext context, java.io.File basedir, java.util.List<java.io.File> files, java.lang.String remotePath, INodeEntry node)	Copy multiple files to the node, the default implementation will use MultiFileCopierUtil.copyMultipleFiles(FileCopier, ExecutionContext, File, List, String, INodeEntry)

Methods inherited from interface com.dtolabs.rundeck.core.execution.service.FileCopier

copyFile, copyFileStream, copyScriptContent

Method Detail

copyFiles

default java.lang.String[] copyFiles(ExecutionContext context,
                                     java.io.File basedir,
                                     java.util.List<java.io.File> files,
                                     java.lang.String remotePath,
                                     INodeEntry node)
                              throws FileCopierException

Copy multiple files to the node, the default implementation will use MultiFileCopierUtil.copyMultipleFiles(FileCopier, ExecutionContext, File, List, String, INodeEntry)

Parameters:

context - context

basedir - local base directory to determine relative paths of copied files

files - list of local files to copy, must all be somewhere within the basedir

remotePath - remote directory path to copy file(s) to, using relative paths from the basedir as subpaths appended to the remote path

node - node

Returns:

File paths of the files after copying to the node

Throws:

FileCopierException - if an error occurs