org.identityconnectors.common

Class IOUtil

java.lang.Object

org.identityconnectors.common.IOUtil

public class IOUtil
extends Object

IO Utilities

Field Summary

Fields

Modifier and Type	Field and Description
static String	UTF8

Method Summary

Methods

Modifier and Type	Method and Description
static long	checksum(File file)
static long	checksum(String fileName) Calculates the CRC32 checksum of the specified file.
static boolean	copyFile(File src, File dest) Copies a file to a destination.
static long	copyFile(InputStream fis, OutputStream fos) Copies one file to another.
static void	delete(File f) Recursively delete all the files in a directory and the directory.
static void	extractResourceToFile(Class<?> clazz, String path, File file) Extracts the resource to a file.
static byte[]	getResourceAsBytes(Class<?> clazz, String res) Get the resource as a byte array.
static Properties	getResourceAsProperties(ClassLoader loader, String path) Loads the given resource as a properties object.
static InputStream	getResourceAsStream(Class<?> clazz, String res) Returns an input stream of the resource specified.
static String	getResourceAsString(Class<?> clazz, String res) Read the entire stream into a String and return it.
static String	getResourceAsString(Class<?> clazz, String res, Charset charset) Read the entire stream into a String and return it.
static String	getResourcePath(Class<?> c, String res) Get the path to a resource base on the package of given class.
static byte[]	inputStreamToBytes(InputStream ins) Takes a 'InputStream' and returns a byte array.
static Properties	loadPropertiesFile(File f) Loads the given file as a Properties file.
static Properties	loadPropertiesFile(String string) Attempt to load file based on a string base filename.
static URL	makeURL(File dir, String path) Make a URL from a directory and path.
static void	quietClose(InputStream stream) Quietly closes the stream.
static void	quietClose(OutputStream stream) Quietly closes the stream.
static void	quietClose(Reader reader) Quietly closes the reader.
static void	quietClose(Writer writer) Quietly closes the Writer.
static String	readerToString(Reader rdr) Takes a 'Reader' and returns the contents as a string.
static byte[]	readFileBytes(File file) Reads the given file as bytes
static String	readFileUTF8(File file) Reads the given file as UTF-8
static byte[]	readInputStreamBytes(InputStream is, boolean close) Reads an entire file and returns the bytes.
static void	storePropertiesFile(File f, Properties properties) Stores the given file as a Properties file.
static void	unjar(JarFile jarFile, File toDir) Unjars the given file to the given directory.
static void	writeFileUTF8(File file, String contents) Write the contents of the string out to a file in UTF-8 format.

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final String UTF8

See Also:

Constant Field Values

Method Detail

quietClose

public static void quietClose(Reader reader)

Quietly closes the reader. This avoids having to handle exceptions, and then inside of the exception handling have a try catch block to close the reader and catch any IOException which may be thrown and ignore it.

Parameters:

reader - - Reader to close

quietClose

public static void quietClose(InputStream stream)

Quietly closes the stream. This avoids having to handle exceptions, and then inside of the exception handling have a try catch block to close the stream and catch any IOException which may be thrown.

Parameters:

stream - - Stream to close

quietClose

public static void quietClose(Writer writer)

Quietly closes the Writer. This avoids having to handle exceptions, and then inside of the exception handling have a try catch block to close the Writer and catch any ioexceptions which may be thrown.

Parameters:

writer - - Writer to close

quietClose

public static void quietClose(OutputStream stream)

Quietly closes the stream. This avoids having to handle exceptions, and then inside of the exception handling have a try catch block to close the stream and catch any ioexceptions which may be thrown.

Parameters:

stream - - Stream to close

getResourcePath

public static String getResourcePath(Class<?> c,
                     String res)

Get the path to a resource base on the package of given class.

Parameters:

c - Class to get the package path too.

res - Name of the resource to get the path of.

Returns:

Returns the fully quilified path to a resource.

getResourceAsStream

public static InputStream getResourceAsStream(Class<?> clazz,
                              String res)

Returns an input stream of the resource specified.

Returns:

Returns an InputStream to the resource.

getResourceAsBytes

public static byte[] getResourceAsBytes(Class<?> clazz,
                        String res)

Get the resource as a byte array.

getResourceAsString

public static String getResourceAsString(Class<?> clazz,
                         String res,
                         Charset charset)

Read the entire stream into a String and return it.

getResourceAsString

public static String getResourceAsString(Class<?> clazz,
                         String res)

Read the entire stream into a String and return it.

inputStreamToBytes

public static byte[] inputStreamToBytes(InputStream ins)

Takes a 'InputStream' and returns a byte array.

readerToString

public static String readerToString(Reader rdr)

Takes a 'Reader' and returns the contents as a string.

Parameters:

rdr - Producer for the string data.

Returns:

Null if the 'Reader' is broken or empty otherwise the contents as a string.

copyFile

public static boolean copyFile(File src,
               File dest)
                        throws IOException

Copies a file to a destination.

Parameters:

src - The source must be a file

dest - This can be a directory or a file.

Returns:

True if succeeded otherwise false.

Throws:

IOException

copyFile

public static long copyFile(InputStream fis,
            OutputStream fos)
                     throws IOException

Copies one file to another.

NOTE: does not close streams.

Returns:

total bytes copied.

Throws:

IOException

checksum

public static long checksum(String fileName)
                     throws IOException,
                            FileNotFoundException

Calculates the CRC32 checksum of the specified file.

Parameters:

fileName - - the path to the file on which to calculate the checksum

Throws:

IOException

FileNotFoundException

checksum

public static long checksum(File file)
                     throws IOException,
                            FileNotFoundException

Throws:

IOException

FileNotFoundException

readInputStreamBytes

public static byte[] readInputStreamBytes(InputStream is,
                          boolean close)
                                   throws IOException

Reads an entire file and returns the bytes.

Parameters:

close - if true, close when finished reading.

Returns:

file bytes.

Throws:

IOException

delete

public static void delete(File f)
                   throws IOException

Recursively delete all the files in a directory and the directory.

Throws:

RuntimeException - iff there is file that can not be deleted.

IOException

loadPropertiesFile

public static Properties loadPropertiesFile(File f)
                                     throws IOException

Loads the given file as a Properties file.

Throws:

IOException

storePropertiesFile

public static void storePropertiesFile(File f,
                       Properties properties)
                                throws IOException

Stores the given file as a Properties file.

Throws:

IOException

getResourceAsProperties

public static Properties getResourceAsProperties(ClassLoader loader,
                                 String path)
                                          throws IOException

Loads the given resource as a properties object.

Parameters:

loader - The class loader

path - The path to the resource

Returns:

The properties or null if not found

Throws:

IOException - If an error occurs reading it

extractResourceToFile

public static void extractResourceToFile(Class<?> clazz,
                         String path,
                         File file)
                                  throws IOException

Extracts the resource to a file.

Parameters:

clazz - The class, relative to which path is resolved

path - The path to the resource

file - The file to extract to

Throws:

IOException - If an error occurs reading it

unjar

public static void unjar(JarFile jarFile,
         File toDir)
                  throws IOException

Unjars the given file to the given directory. Does not close the JarFile when finished.

Parameters:

jarFile - The file to unjar.

toDir - The directory to unjar to.

Throws:

IOException

readFileUTF8

public static String readFileUTF8(File file)
                           throws IOException

Reads the given file as UTF-8

Parameters:

file - The file to read

Returns:

The contents of the file

Throws:

IOException - iff there is an issue reading the file.

readFileBytes

public static byte[] readFileBytes(File file)
                            throws IOException

Reads the given file as bytes

Parameters:

file - The file to read

Returns:

The contents of the file

Throws:

IOException - iff there is an issue reading the file.

writeFileUTF8

public static void writeFileUTF8(File file,
                 String contents)
                          throws IOException

Write the contents of the string out to a file in UTF-8 format.

Parameters:

file - the file to write to.

contents - the contents of the file to write to.

Throws:

IOException - iff there is an issue writing the file.

NullPointerException - iff the file parameter is null.

makeURL

public static URL makeURL(File dir,
          String path)
                   throws IOException

Make a URL from a directory and path.

Parameters:

dir - directory to start from.

path - file or path to create the url.

Returns:

URL based on the parameter provided.

Throws:

IOException - iff the URL create from the parameters does not specify a file.

loadPropertiesFile

public static Properties loadPropertiesFile(String string)
                                     throws IOException

Attempt to load file based on a string base filename.

Parameters:

string - represents the file.

Returns:

a loaded properties file.

Throws:

IOException - if there is an issue.