org.forgerock.openam.utils

Class IOUtils

java.lang.Object

org.forgerock.openam.utils.IOUtils

public final class IOUtils
extends Object

Utility class for handling I/O streams.

Method Summary

Modifier and Type	Method and Description
static void	closeIfNotNull(Closeable... o) Closes all of the provided Closeables and swallows any exceptions.
static void	closeIfNotNull(Closeable closeable) Closes the passed in resource if not null.
static long	copyStream(InputStream in, OutputStream out) Copies the whole input stream to the given output stream.
static <T> T	deserialise(byte[] bytes, boolean compressed) Deserialises an object from a byte array to an object of a specified type.
static <T> T	deserialise(byte[] bytes, boolean compressed, ClassLoader classLoader) Deserialises an object from a byte array to an object of a specified type.
static String	getFileContent(String path) Reads the file content at the given path, and returns its UTF-8 content in String format.
static String	getFileContent(String path, String encoding) Reads the file content at the given path, and returns its content in String format using the given encoding.
static String	getFileContentFromClassPath(Class classInSameModule, String path) Reads a files content from the classpath using UTF-8 encoding.
static String	getFileContentFromClassPath(Class classInSameModule, String path, String encoding) Reads a files content from the classpath using the given encoding.
static String	readStream(InputStream is) Reads the InputStream and tries to interpret its content as String using UTF-8 encoding.
static String	readStream(InputStream is, String encoding) Reads the InputStream and tries to interpret its content as String using the given encoding.
static void	writeToFile(String fileName, String content) Writes the provided content to a file with the provided name.

Methods inherited from class java.lang.Object

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

Method Detail

getFileContent

public static String getFileContent(String path)
                             throws IOException

Reads the file content at the given path, and returns its UTF-8 content in String format.

Parameters:

path - The path to the file

Returns:

content of the file at the given path

Throws:

IOException - if an error occurs while reading the file

IllegalArgumentException - if the file does not exists at the given path

getFileContent

public static String getFileContent(String path,
                                    String encoding)
                             throws IOException

Reads the file content at the given path, and returns its content in String format using the given encoding.

Parameters:

path - The path to the file

encoding - encoding of the file

Returns:

content of the file at the given path

Throws:

IOException - if an error occurs while reading the file

IllegalArgumentException - if the file does not exists at the given path

getFileContentFromClassPath

public static String getFileContentFromClassPath(Class classInSameModule,
                                                 String path)
                                          throws IOException

Reads a files content from the classpath using UTF-8 encoding.

Parameters:

classInSameModule - A class that is in the same module than the resource.

path - the path to the file on the classpath

Returns:

the content of the file

Throws:

IOException - if an error occured while reading

IllegalArgumentException - if the file does not exists

getFileContentFromClassPath

public static String getFileContentFromClassPath(Class classInSameModule,
                                                 String path,
                                                 String encoding)
                                          throws IOException

Reads a files content from the classpath using the given encoding.

Parameters:

classInSameModule - A class that is in the same module than the resource.

path - the path to the file on the classpath

encoding - encoding of the file

Returns:

the content of the file

Throws:

IOException - if an error occured while reading

IllegalArgumentException - if the file does not exists

readStream

public static String readStream(InputStream is)
                         throws IOException

Reads the InputStream and tries to interpret its content as String using UTF-8 encoding.

Parameters:

is - the inputstream to read

Returns:

The string representation of the inputstreams content

Throws:

IOException - if there was an error while reading the stream

readStream

public static String readStream(InputStream is,
                                String encoding)
                         throws IOException

Reads the InputStream and tries to interpret its content as String using the given encoding.

Parameters:

is - the inputstream to read

encoding - the encoding to be used

Returns:

The string representation of the inputstreams content

Throws:

IOException - if there was an error while reading the stream

writeToFile

public static void writeToFile(String fileName,
                               String content)
                        throws IOException

Writes the provided content to a file with the provided name.

Parameters:

fileName - The name of the file to write to.

content - The contents to write.

Throws:

IOException - If the file could be written to.

closeIfNotNull

public static void closeIfNotNull(Closeable closeable)

Closes the passed in resource if not null.

Parameters:

closeable - The resource that needs to be closed.

closeIfNotNull

public static void closeIfNotNull(Closeable... o)

Closes all of the provided Closeables and swallows any exceptions.

Also performs a null check on the Closeable.

Parameters:

o - The Closeables.

copyStream

public static long copyStream(InputStream in,
                              OutputStream out)
                       throws IOException

Copies the whole input stream to the given output stream. Neither stream is closed after the copy.

Parameters:

in - the stream to copy from.

out - the stream to copy to.

Returns:

the number of bytes copied.

Throws:

IOException - if an error occurs while copying the data.

deserialise

public static <T> T deserialise(byte[] bytes,
                                boolean compressed)
                         throws IOException,
                                ClassNotFoundException

Deserialises an object from a byte array to an object of a specified type.

Type Parameters:

T - The returned object type.

Parameters:

bytes - The bytes that represent the Object to be deserialized. The classes to be loaded must be from the set specified in the whitelist

compressed - If true, expect that the bytes are compressed.

Returns:

The Object T representing the deserialized bytes

Throws:

IOException - If there was a problem with the ObjectInputStream process.

ClassNotFoundException - If there was problem loading a class that makes up the bytes to be deserialized.

deserialise

public static <T> T deserialise(byte[] bytes,
                                boolean compressed,
                                ClassLoader classLoader)
                         throws IOException,
                                ClassNotFoundException

Deserialises an object from a byte array to an object of a specified type.

Type Parameters:

T - The returned object type.

Parameters:

bytes - The bytes that represent the Object to be deserialized. The classes to be loaded must be from the set specified in the whitelist maintained in the WhitelistObjectInputStream

compressed - If true, expect that the bytes are compressed.

classLoader - Used in place of the default ClassLoader, default will be used if null.

Returns:

The Object T representing the deserialized bytes

Throws:

IOException - If there was a problem with the ObjectInputStream process.

ClassNotFoundException - If there was problem loading a class that makes up the bytes to be deserialized.