com.nt.udc.util

Class FileUtils

java.lang.Object

com.nt.udc.util.FileUtils

public class FileUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	basename(java.lang.String filename) Returns the filename portion of a specific file string.
static java.lang.String	basename(java.lang.String filename, java.lang.String suffix) Returns the filename portion of a specific file string.
static void	copyDirectory(java.io.File sourceDirectory, java.io.File destDirectory) Copy file from source directory to destination directory.
static void	copyDirectory(java.lang.String sourceDirectory, java.lang.String destDirectory) Copy file from source directory to destination directory.
static void	copyFile(java.io.File sourceFile, java.io.File destFile) Copy file from source to destination.
static void	copyFile(java.lang.String sourceFile, java.lang.String destFile) Copy file from source to destination.
static void	copyFileToDirectory(java.io.File sourceFile, java.io.File destDirectory) Copy file from source to destination.
static void	copyFileToDirectory(java.lang.String sourceFile, java.lang.String destDirectory) Copy file from source to destination.
static java.lang.String	dirname(java.lang.String filename) Returns the directory path portion of a specific file string.
static java.lang.String	extension(java.lang.String filename) Returns the extension portion of a specific file string.
static java.lang.String	filename(java.lang.String filename) Returns the filename portion of a specific file string.
static java.util.Set	getAllFiles(java.io.File dir) Given a directory, return the set of files in that directory.
static java.lang.String	getExtension(java.lang.String filename) Get extension from filename.
static java.lang.String	getPath(java.lang.String filepath) Get path from filename.
static java.lang.String	getPath(java.lang.String filepath, char fileSeparatorChar) Get path from filename.
static java.io.File	getRelativeFile(java.io.File dir, java.io.File file) Returns a file whose path is the relative path to that of the given directory.
static java.util.Set	getRelativeFiles(java.util.Set files, java.io.File dir)
static boolean	isValidDirectory(java.lang.String dirName) Validates directory name.
static boolean	isValidFileAndPath(java.lang.String fileNameAndPath) Validates filename with wildcard and path
static boolean	isValidFileName(java.lang.String fileName) Validates file name.
static java.lang.String	removeExtension(java.lang.String filename) Remove extension from filename.
static java.lang.String	removePath(java.lang.String filepath) Remove path from filename.
static java.lang.String	removePath(java.lang.String filepath, char fileSeparatorChar) Remove path from filename.
static boolean	unZipFiles(java.lang.String fileName, java.lang.String destFolder, java.lang.String osaHome) Extracts contents a compressed file into the specified folder.
static void	uploadFile(byte[] data, java.lang.String uploadLocation, java.lang.String fileName) Uploads the file with given file name to the given upload location.
static boolean	zipFiles(java.lang.String[] fileNames, java.lang.String zipFile, java.lang.String destFolder, boolean storePath, java.lang.String osaHome) Creates compressed archive of files passed to it and stores the archive into the specified folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtils

public FileUtils()

Method Detail

getRelativeFile

public static java.io.File getRelativeFile(java.io.File dir,
                                           java.io.File file)
                                    throws java.io.FileNotFoundException

Returns a file whose path is the relative path to that of the given directory.

Throws:

java.io.FileNotFoundException

getAllFiles

public static java.util.Set getAllFiles(java.io.File dir)

Given a directory, return the set of files in that directory.

getRelativeFiles

public static java.util.Set getRelativeFiles(java.util.Set files,
                                             java.io.File dir)

dirname

public static java.lang.String dirname(java.lang.String filename)

Returns the directory path portion of a specific file string. e.g. test.txt --> "" /tmp/dir1/test.txt --> /tmp/dir1

Parameters:

filename -

Returns:

the directory portion excluding the ending file separator.

filename

public static java.lang.String filename(java.lang.String filename)

Returns the filename portion of a specific file string. e.g. test.txt, .txt --> test.txt /tmp/dir1/test.txt, .txt --> test.txt

Parameters:

filename -

Returns:

the filename string with extension.

basename

public static java.lang.String basename(java.lang.String filename)

Returns the filename portion of a specific file string. e.g. test.txt, .txt --> test. /tmp/dir1/test.txt --> test.

Parameters:

filename -

Returns:

The filename string without extension

basename

public static java.lang.String basename(java.lang.String filename,
                                        java.lang.String suffix)

Returns the filename portion of a specific file string. e.g. test.txt, .txt --> test /tmp/dir1/test.txt --> test

Parameters:

filename -

suffix -

Returns:

the filename portion (no path and no extension) of a specific file string .

extension

public static java.lang.String extension(java.lang.String filename)

Returns the extension portion of a specific file string. e.g. test.txt --> txt /tmp/dir1/test.txt --> txt

Parameters:

filename -

Returns:

the extension portion of a specific file string.

removeExtension

public static java.lang.String removeExtension(java.lang.String filename)

Remove extension from filename. e.g. test.txt --> test /tmp/test.txt --> /tmp/test /tmp/dir1/dir2 --> /tmp/dir1/dir2 /tmp/dir1/dir2/ --> /tmp/dir1/dir2/

Parameters:

filename - the filename

Returns:

the filename minus extension

getExtension

public static java.lang.String getExtension(java.lang.String filename)

Get extension from filename. e.g. test.txt --> txt /tmp/test.txt --> txt /tmp/dir1/dir2 --> ""

Parameters:

filename - the filename

Returns:

the extension of filename or "" if none

removePath

public static java.lang.String removePath(java.lang.String filepath)

Remove path from filename. e.g. test.txt --> test.txt /tmp/dir1/test.txt --> test.txt

Parameters:

filepath - the filepath

Returns:

the filename minus path

removePath

public static java.lang.String removePath(java.lang.String filepath,
                                          char fileSeparatorChar)

Remove path from filename. e.g. test.txt --> test.txt /tmp/dir1/test.txt --> test.txt

Parameters:

filepath - - the file path

Returns:

the filename minus path

getPath

public static java.lang.String getPath(java.lang.String filepath)

Get path from filename. ie. a/b/c.txt --> a/b a.txt --> ""

Parameters:

filepath - the filepath

Returns:

the filename minus path

getPath

public static java.lang.String getPath(java.lang.String filepath,
                                       char fileSeparatorChar)

Get path from filename. ie. test.txt --> "" /tmp/dir1/test.txt --> /tmp/dir1

Parameters:

filepath - the filepath

Returns:

the filename minus path

copyFileToDirectory

public static void copyFileToDirectory(java.lang.String sourceFile,
                                       java.lang.String destDirectory)
                                throws java.lang.Exception

Copy file from source to destination.

Parameters:

sourceFile - - the source file to been copy.

destDirectory - - the destination directory to copy to.

Throws:

java.lang.Exception

copyFileToDirectory

public static void copyFileToDirectory(java.io.File sourceFile,
                                       java.io.File destDirectory)
                                throws java.lang.Exception

Copy file from source to destination.

Parameters:

sourceFile - - the source file to been copy.

destDirectory - - the destination directory to copy to.

Throws:

java.lang.Exception

copyDirectory

public static void copyDirectory(java.io.File sourceDirectory,
                                 java.io.File destDirectory)
                          throws java.lang.Exception

Copy file from source directory to destination directory.

Parameters:

sourceDirectory - - source directory to copy from.

destDirectory - - destination directory to copy to.

Throws:

java.lang.Exception

copyDirectory

public static void copyDirectory(java.lang.String sourceDirectory,
                                 java.lang.String destDirectory)
                          throws java.lang.Exception

Copy file from source directory to destination directory.

Parameters:

sourceDirectory - - source directory to copy from.

destDirectory - - destination directory to copy to.

Throws:

java.lang.Exception

copyFile

public static void copyFile(java.io.File sourceFile,
                            java.io.File destFile)
                     throws java.lang.Exception

Copy file from source to destination.

Parameters:

sourceFile - - the source file to copy.

destFile - - the destination file to copy to.

Throws:

java.lang.Exception

copyFile

public static void copyFile(java.lang.String sourceFile,
                            java.lang.String destFile)
                     throws java.lang.Exception

Copy file from source to destination.

Parameters:

sourceFile - - the source file to copy.

destFile - - the destination file to copy to.

Throws:

java.lang.Exception

isValidFileName

public static boolean isValidFileName(java.lang.String fileName)

Validates file name.

Parameters:

fileName - - the file name to be validated

Returns:

result of file name validation - true if valid filename otherwise false will be returned

isValidDirectory

public static boolean isValidDirectory(java.lang.String dirName)

Validates directory name.

Parameters:

dirName - - the directory name to be validated

Returns:

result of directory name validation - true if valid directory otherwise false will be returned

isValidFileAndPath

public static boolean isValidFileAndPath(java.lang.String fileNameAndPath)

Validates filename with wildcard and path

Parameters:

fileNameAndPath - - the filename with wildcard and path to be validated

Returns:

result of filename with path validation - true if valid otherwise false will be returned

zipFiles

public static boolean zipFiles(java.lang.String[] fileNames,
                               java.lang.String zipFile,
                               java.lang.String destFolder,
                               boolean storePath,
                               java.lang.String osaHome)

Creates compressed archive of files passed to it and stores the archive into the specified folder.

Parameters:

fileNames - array of filenames or folder names which need to compressed.

zipFile - the name of file in which the compressed archive will be stored.

destFolder - the folder name where the compressed archive will be stored.

storePath - true if file path should be stored in the archive otherwise false.

osaHome - the path where Network Mediation is installed.

Returns:

boolean returns true if all files are compressed and archived successfully otherwise returns false

unZipFiles

public static boolean unZipFiles(java.lang.String fileName,
                                 java.lang.String destFolder,
                                 java.lang.String osaHome)

Extracts contents a compressed file into the specified folder.

Parameters:

fileName - the compressed file

destFolder - the folder where the compressed file should be extracted.

Returns:

boolean true if all contents are extracted successfully. otherwise false.

uploadFile

public static void uploadFile(byte[] data,
                              java.lang.String uploadLocation,
                              java.lang.String fileName)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Uploads the file with given file name to the given upload location.

Parameters:

data - File's data

uploadLocation - Location where file needs to be uploaded

fileName - File's name

Throws:

java.io.FileNotFoundException - Exception thrown when file is not found

java.io.IOException - Exception thrown while writing to the file