org.xmlactions.common.io

Class ResourceUtils

java.lang.Object

org.xmlactions.common.io.ResourceUtils

public class ResourceUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ISO

Constructor Summary

Constructors

Constructor and Description
ResourceUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	appendFile(java.lang.String fileName1, java.lang.String fileName2) Appends file2 to file1
static boolean	appendFileWithSize(java.lang.String fileName1, java.lang.String fileName2) Appends file2 to file1 and stores the size of file1 at the end as an 10 byte ascii number.
static void	backupFile(java.lang.String sourceFileName, java.lang.String destFileName, boolean forceOverwrite) backup a file.
static byte[]	blockReadInputStream(java.io.InputStream inputStream, int sizeToRead)
static void	copyFile(java.io.File sourceFile, java.io.File destFile) copy a file.
static void	copyFile(java.lang.String sourceFileName, java.io.File destFile) copy a file.
static void	copyFile(java.lang.String sourceFileName, java.lang.String destFileName) copy a file.
static void	copyFileStreams(java.io.FileInputStream fis, java.io.FileOutputStream fos) Copy a FileInputStream to a FileOutputStream.
static java.io.File	createTempFile(java.lang.String prefix, java.lang.String suffix, java.lang.String path) Creates a new file
static void	delete(java.lang.String fileName)
static boolean	deleteDir(java.io.File dir) Deletes all files and subdirectories under dir.
static java.io.File	getFile(java.lang.String resource) Gets a URL(String) getFile replacing all %20 characters with spaces
static java.io.File	getFile(java.net.URL resource) Gets a URL getFile replacing all %20 characters with spaces
static java.io.File[]	getFileList(java.lang.String fileLocation)
static java.io.File[]	getFileList(java.lang.String fileLocation, java.lang.String filter)
static java.io.InputStream	getInputStream(java.lang.String resourceFileName) Gets an InputStream from a File or from a Resource
static java.net.URL	getResourceURL(org.springframework.context.ApplicationContext appContext, java.lang.String resourceName, java.lang.Class<?> clas) Get a URL for a given resource.
static java.net.URL	getResourceURL(java.lang.String resourceName) Get a URL for a giver resource.
static java.io.File	getTempFolder(java.lang.String appendFolderName) Returns a tempory folder where tempory files can be stored.
static byte[]	loadBinaryFile(java.lang.String fileName)
static java.lang.String	loadFile(java.lang.String fileName)
static java.lang.String	loadFileWithISO(java.lang.String fileName, java.lang.String iso) Load a file and apply the iso value when doing the byte to String conversion
static java.util.Properties	loadProperties(java.lang.String fileName)
static java.lang.String	loadXMLFileWithISO(java.lang.String fileName) This will load a file assuming it's an XML file, then look for an ISO declaration and if found will convert the string using that ISO value.
static int	mkdir(java.io.File folder) mkdir for folderName and set the lastModifiedDate to lastModifiedDate
static int	mkdir(java.lang.String folderName, long lastModifiedDate) mkdir for folderName and set the lastModifiedDate to lastModifiedDate
static int	mkdirs(java.io.File folder) mkdirs for folderName
static java.lang.String	mkdirsToday(java.lang.String pathName) creates a new folder named "yyyy-MM-dd" and appends this onto the pathName, then creates the folder.
static byte[]	readInputStream(java.io.InputStream inputStream)
static boolean	renameFile(java.lang.String fileNameAndPath, java.lang.String newFileNameAndPath, boolean overWrite) Rename a file to a new file name and path
static void	saveBinaryFile(java.lang.String fileName, byte[] buffer)
static void	saveFile(java.lang.String fileName, java.lang.String buffer)
static void	setLastModified(java.lang.String fileName, long modifiedTime)
static void	sortFiles(java.io.File[] files)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ISO

public static final java.lang.String DEFAULT_ISO

See Also:

Constant Field Values

Constructor Detail

ResourceUtils

public ResourceUtils()

Method Detail

loadFile

public static java.lang.String loadFile(java.lang.String fileName)
                                 throws java.io.IOException

Throws:

java.io.IOException

loadFileWithISO

public static java.lang.String loadFileWithISO(java.lang.String fileName,
                                               java.lang.String iso)
                                        throws java.io.IOException

Load a file and apply the iso value when doing the byte to String conversion

Throws:

java.io.IOException

loadXMLFileWithISO

public static java.lang.String loadXMLFileWithISO(java.lang.String fileName)
                                           throws java.io.IOException

This will load a file assuming it's an XML file, then look for an ISO declaration and if found will convert the string using that ISO value. i.e. <?xml version="1.0" encoding="ISO-8859-1"?> will find ISO-9959-1 and convert the binary data to a String using this iso.

Throws:

java.io.IOException

loadBinaryFile

public static byte[] loadBinaryFile(java.lang.String fileName)
                             throws java.io.IOException

Throws:

java.io.IOException

saveFile

public static void saveFile(java.lang.String fileName,
                            java.lang.String buffer)
                     throws java.io.IOException

Throws:

java.io.IOException

saveBinaryFile

public static void saveBinaryFile(java.lang.String fileName,
                                  byte[] buffer)
                           throws java.io.IOException

Throws:

java.io.IOException

delete

public static void delete(java.lang.String fileName)
                   throws java.lang.Exception

Throws:

java.lang.Exception

deleteDir

public static boolean deleteDir(java.io.File dir)

Deletes all files and subdirectories under dir.

Returns:

true if all deletions were successful. If a deletion fails, the method stops attempting to delete and returns false.

getFileList

public static java.io.File[] getFileList(java.lang.String fileLocation,
                                         java.lang.String filter)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getFileList

public static java.io.File[] getFileList(java.lang.String fileLocation)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

setLastModified

public static void setLastModified(java.lang.String fileName,
                                   long modifiedTime)
                            throws java.lang.Exception

Throws:

java.lang.Exception

renameFile

public static boolean renameFile(java.lang.String fileNameAndPath,
                                 java.lang.String newFileNameAndPath,
                                 boolean overWrite)

Rename a file to a new file name and path

Parameters:

fileNameAndPath - is the existing file

newFileNameAndPath - is what we rename it to

overWrite - if set true will overwrite an existing file, false wont.

Returns:

true if successfull or false if not

appendFile

public static boolean appendFile(java.lang.String fileName1,
                                 java.lang.String fileName2)
                          throws java.lang.Exception

Appends file2 to file1

Parameters:

fileName1 - is the name of the file to append file2 onto. If file1 does not exist it is created.

fileName2 - is the name of an existing file to append to file1. if file2 does not exist an exception is thrown

Returns:

true if successfull or false if not

Throws:

java.lang.Exception

appendFileWithSize

public static boolean appendFileWithSize(java.lang.String fileName1,
                                         java.lang.String fileName2)
                                  throws java.lang.Exception

Appends file2 to file1 and stores the size of file1 at the end as an 10 byte ascii number. i.e. "0000000234"

Parameters:

fileName1 - is the name of an existing file to append to file2

fileName2 - is the name of the file to append file1 onto. If file2 does not exist it is created.

Returns:

true if successfull or false if not

Throws:

java.lang.Exception

loadProperties

public static java.util.Properties loadProperties(java.lang.String fileName)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

readInputStream

public static byte[] readInputStream(java.io.InputStream inputStream)
                              throws java.io.IOException

Throws:

java.io.IOException

blockReadInputStream

public static byte[] blockReadInputStream(java.io.InputStream inputStream,
                                          int sizeToRead)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

backupFile

public static void backupFile(java.lang.String sourceFileName,
                              java.lang.String destFileName,
                              boolean forceOverwrite)
                       throws java.lang.Exception

backup a file.

Parameters:

sourceFileName - is the file we want to backup.

destFileName - is the new name of the file, can contain a new path also.

forceOverwrite - if set true will backup the source file over an existing destination file.

Throws:

java.lang.Exception

copyFileStreams

public static void copyFileStreams(java.io.FileInputStream fis,
                                   java.io.FileOutputStream fos)
                            throws java.lang.Exception

Copy a FileInputStream to a FileOutputStream.

Parameters:

fis - is the FileInputStream to copy from.

fos - is the FileOutputStream to copy to.

Throws:

java.lang.Exception - if something goes wrong.

copyFile

public static void copyFile(java.lang.String sourceFileName,
                            java.lang.String destFileName)
                     throws java.lang.Exception

copy a file.

Parameters:

sourceFileName - is the file we want to copy.

destFileName - is the name of the copy to file, can contain a new path also.

Throws:

java.lang.Exception

copyFile

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

copy a file.

Parameters:

sourceFileName - is the file we want to copy.

destFile - is the destination file 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 a file.

Parameters:

sourceFile - is the file we want to copy.

destFile - is the destination file to copy to.

Throws:

java.lang.Exception

mkdir

public static int mkdir(java.lang.String folderName,
                        long lastModifiedDate)

mkdir for folderName and set the lastModifiedDate to lastModifiedDate

Returns:

-1 if unable to mkdir, -2 if unable to setLastModified, 0 if ok

mkdir

public static int mkdir(java.io.File folder)

mkdir for folderName and set the lastModifiedDate to lastModifiedDate

Returns:

-1 if unable to mkdir, -2 if unable to setLastModified, 0 if ok

mkdirs

public static int mkdirs(java.io.File folder)

mkdirs for folderName

Returns:

-1 if unable to mkdir, -2 if unable to setLastModified, 0 if ok

mkdirsToday

public static java.lang.String mkdirsToday(java.lang.String pathName)

creates a new folder named "yyyy-MM-dd" and appends this onto the pathName, then creates the folder.

Parameters:

pathName - is the path to the folder.

Returns:

null if unable to create the folder else the fill path including new folder name

sortFiles

public static void sortFiles(java.io.File[] files)

getTempFolder

public static java.io.File getTempFolder(java.lang.String appendFolderName)

Returns a tempory folder where tempory files can be stored. This folder will be marked for deletion when system exits. If the system doesn;t exit cleanly then the folder will not be deleted. The tempory folder is created inside the user home

Parameters:

appendFolderName - is the folder to be created inside the tempory folder location.

createTempFile

public static java.io.File createTempFile(java.lang.String prefix,
                                          java.lang.String suffix,
                                          java.lang.String path)
                                   throws java.lang.Exception

Creates a new file

Parameters:

prefix - is the prefix used for the file name must be at least 3 characters

suffix - is the file extension and may be null in which case '.tmp' is used

path - is the folder path where the file will be created

Returns:

the new file

Throws:

java.lang.Exception - if something goes wrong.

getResourceURL

public static java.net.URL getResourceURL(java.lang.String resourceName)

Get a URL for a giver resource. The resource must exist or an exception is caused. 2020-06-16 - if getResource fails try again with / in front of name - this fixes loading from a war or jar file. Will not retru if resourceName contains ':'

Parameters:

resourceName -

Returns:

the URL of the resource.

getResourceURL

public static java.net.URL getResourceURL(org.springframework.context.ApplicationContext appContext,
                                          java.lang.String resourceName,
                                          java.lang.Class<?> clas)

Get a URL for a given resource. The resource must exist or an exception is caused.

Parameters:

resourceName -

Returns:

the URL of the resource.

getFile

public static java.io.File getFile(java.net.URL resource)

Gets a URL getFile replacing all %20 characters with spaces

getFile

public static java.io.File getFile(java.lang.String resource)

Gets a URL(String) getFile replacing all %20 characters with spaces

getInputStream

public static java.io.InputStream getInputStream(java.lang.String resourceFileName)
                                          throws java.io.IOException

Gets an InputStream from a File or from a Resource

Parameters:

resourceFileName - a reference to the file or resource.

Returns:

an Open InputStream, you close this when your done.

Throws:

java.io.IOException