Package com.veracode.jenkins.plugin.utils

Class FileUtil

java.lang.Object

com.veracode.jenkins.plugin.utils.FileUtil

public final class FileUtil
extends Object

The FileUtil is a utility class for working with files and directories.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileUtil.FileCallableImpl	Implements FileCallable's invoke method, which is executed on the machine containing the file whose file path is represented by the FilePath object on which the act method is called.

Method Summary

Modifier and Type	Method	Description
static boolean	cleanUpBuildProperties(Run<?,?> run, TaskListener listener)	Deletes the properties file of the specified build.
static boolean	copyJarFiles(AbstractBuild<?,?> build, FilePath local, FilePath remote, PrintStream ps)	Copies the Veracode API Wrapper to the remote location.
static boolean	createBuildPropertiesFile(Run<?,?> run, Properties properties, TaskListener listener)	Creates a properties file for the specified build with the given properties.
static boolean	deleteDirectory(File file)	Deletes the file represented by the specified File object.
static FilePath	getLocalWorkspaceFilepath()	Returns the Veracode API Wrapper location situated in master.
static String	getStringFilePath(FilePath filePath)	Returns a String that corresponds to the textual representation of the file path of the file represented by the specified FilePath object.
static String[]	getStringFilePaths(FilePath[] filePaths)	Returns a String array whose elements correspond to the textual representation of the file paths of the files represented by the elements of the specified FilePath array.
static Properties	readBuildPropertiesFile(Run<?,?> run, TaskListener listener)	Returns the properties of the specified build.

Methods inherited from class java.lang.Object

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

Method Detail

deleteDirectory

public static boolean deleteDirectory(File file)

Deletes the file represented by the specified File object. If file represents a directory it also recursively deletes its contents.

Parameters:

file - a File object.

Returns:

a boolean.

getStringFilePaths

public static String[] getStringFilePaths(FilePath[] filePaths)
                                   throws IOException,
                                          InterruptedException

Returns a String array whose elements correspond to the textual representation of the file paths of the files represented by the elements of the specified FilePath array.

Parameters:

filePaths - an array of FilePath objects.

Returns:

an array of String objects.

Throws:

IOException - if any.

InterruptedException - if any.

getStringFilePath

public static String getStringFilePath(FilePath filePath)
                                throws IOException,
                                       InterruptedException

Returns a String that corresponds to the textual representation of the file path of the file represented by the specified FilePath object.

Parameters:

filePath - a FilePath object.

Returns:

a String object.

Throws:

IOException - if any.

InterruptedException - if any.

copyJarFiles

public static boolean copyJarFiles(AbstractBuild<?,?> build,
                                   FilePath local,
                                   FilePath remote,
                                   PrintStream ps)
                            throws Exception

Copies the Veracode API Wrapper to the remote location.

Parameters:

build - a AbstractBuild object.

local - a FilePath object.

remote - a FilePath object.

ps - a PrintStream object.

Returns:

a boolean.

Throws:

Exception - if any.

getLocalWorkspaceFilepath

public static FilePath getLocalWorkspaceFilepath()
                                          throws URISyntaxException

Returns the Veracode API Wrapper location situated in master.

Returns:

a FilePath object.

Throws:

URISyntaxException - if any.

cleanUpBuildProperties

public static boolean cleanUpBuildProperties(Run<?,?> run,
                                             TaskListener listener)

Deletes the properties file of the specified build.

Parameters:

run - a Run object.

listener - a TaskListener object.

Returns:

a boolean.

createBuildPropertiesFile

public static boolean createBuildPropertiesFile(Run<?,?> run,
                                                Properties properties,
                                                TaskListener listener)
                                         throws IOException

Creates a properties file for the specified build with the given properties.

Parameters:

run - a Run object.

properties - a Properties object.

listener - a TaskListener object.

Returns:

a boolean.

Throws:

IOException - if any.

readBuildPropertiesFile

public static Properties readBuildPropertiesFile(Run<?,?> run,
                                                 TaskListener listener)
                                          throws IOException

Returns the properties of the specified build.

Parameters:

run - a Run object.

listener - a TaskListener object.

Returns:

a Properties object.

Throws:

IOException - if any.