org.owasp.dependencycheck.utils

Class FileUtils

java.lang.Object

org.owasp.dependencycheck.utils.FileUtils

public final class FileUtils
extends Object

A collection of utilities for processing information about files.

Author:

Jeremy Long

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	delete(File file) Deletes a file.
static String	getBitBucket() Return the bit bucket for the OS.
static File	getDataDirectory(String configuredFilePath, Class clazz) Deprecated. This method should no longer be used. See the implementation in dependency-check-cli/App.java to see how the data directory should be set.
static String	getFileExtension(String fileName) Returns the (lowercase) file extension for a specified file.
static File	getPathToJar(Class clazz) Deprecated. this should no longer be used.
static File	getTempFile(String prefix, String extension) Generates a new temporary file name that is guaranteed to be unique.

Methods inherited from class java.lang.Object

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

Method Detail

getFileExtension

public static String getFileExtension(String fileName)

Returns the (lowercase) file extension for a specified file.

Parameters:

fileName - the file name to retrieve the file extension from.

Returns:

the file extension.

delete

public static boolean delete(File file)

Deletes a file. If the File is a directory it will recursively delete the contents.

Parameters:

file - the File to delete

Returns:

true if the file was deleted successfully, otherwise false

getTempFile

public static File getTempFile(String prefix,
               String extension)
                        throws IOException

Generates a new temporary file name that is guaranteed to be unique.

Parameters:

prefix - the prefix for the file name to generate

extension - the extension of the generated file name

Returns:

a temporary File

Throws:

IOException - thrown if the temporary folder could not be created

getDataDirectory

@Deprecated
public static File getDataDirectory(String configuredFilePath,
                               Class clazz)
                             throws IOException

Deprecated. This method should no longer be used. See the implementation in dependency-check-cli/App.java to see how the data directory should be set.

Returns the data directory. If a path was specified in dependencycheck.properties or was specified using the Settings object, and the path exists, that path will be returned as a File object. If it does not exist, then a File object will be created based on the file location of the JAR containing the specified class.

Parameters:

configuredFilePath - the configured relative or absolute path

clazz - the class to resolve the path

Returns:

a File object

Throws:

IOException - is thrown if the path could not be decoded

getPathToJar

@Deprecated
public static File getPathToJar(Class clazz)
                         throws UnsupportedEncodingException

Deprecated. this should no longer be used.

Retrieves the physical path to the parent directory containing the provided class. For example, if a JAR file contained a class org.something.clazz this method would return the parent directory of the JAR file.

Parameters:

clazz - the class to determine the parent directory of

Returns:

the parent directory of the file containing the specified class.

Throws:

UnsupportedEncodingException - thrown if UTF-8 is not supported.

getBitBucket

public static String getBitBucket()

Return the bit bucket for the OS. '/dev/null' for Unix and 'NUL' for Windows

Returns:

a String containing the bit bucket