org.mule.runtime.core.api.util

Class IOUtils

java.lang.Object

org.mule.runtime.core.api.util.IOUtils

public class IOUtils
extends Object

Mule input/output utilities.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	bufferSize

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(Closeable closeable) Closes a {#link Closable} instance catching any exceptions
static long	copyLarge(InputStream input, OutputStream output) Re-implement copy method to allow buffer size to be configured.
static long	copyLarge(Reader input, Writer output) Re-implement copy method to allow buffer size to be configured.
static InputStream	getResourceAsStream(String resourceName, Class callingClass) Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.
static InputStream	getResourceAsStream(String resourceName, Class callingClass, boolean tryAsFile, boolean tryAsUrl) Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.
static String	getResourceAsString(String resourceName, Class callingClass) Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.
static URL	getResourceAsUrl(String resourceName, Class callingClass) Attempts to load a resource from the file system or from the classpath, in that order.
static URL	getResourceAsUrl(String resourceName, Class callingClass, boolean tryAsFile, boolean tryAsUrl) Attempts to load a resource from the file system or from the classpath, in that order.
static void	ifInputStream(Object value, CheckedConsumer<InputStream> consumer)
static <T> T	ifInputStream(Object value, CheckedFunction<InputStream,T> function)
static byte[]	toByteArray(org.mule.runtime.api.streaming.bytes.CursorStreamProvider cursorStreamProvider) This method wraps IOUtils' toByteArray(InputStream) method but catches any IOException and wraps it into a RuntimeException.
static byte[]	toByteArray(InputStream input) This method wraps IOUtils' toByteArray(InputStream) method but catches any IOException and wraps it into a RuntimeException.
static DataHandler	toDataHandler(String name, Object object, org.mule.runtime.api.metadata.MediaType contentType) Transforms an Object into a DataHandler of its corresponding type.
static org.mule.runtime.api.message.Message	toMuleMessagePart(String name, Object object, org.mule.runtime.api.metadata.MediaType contentType) Transforms an Object into a Message to be used in a MultiPartPayload.
static String	toString(org.mule.runtime.api.streaming.bytes.CursorStreamProvider cursorStreamProvider) Similar to toByteArray(InputStream) but obtaining the stream from the given cursorStreamProvider
static String	toString(InputStream input) This method wraps IOUtils' toString(InputStream) method but catches any IOException and wraps it into a RuntimeException.
static String	toString(InputStream input, Charset encoding) This method wraps IOUtils' toString(InputStream, Charset) method but catches any IOException and wraps it into a RuntimeException.

Methods inherited from class java.lang.Object

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

Field Detail

bufferSize

protected static int bufferSize

Constructor Detail

IOUtils

public IOUtils()

Method Detail

getResourceAsString

public static String getResourceAsString(String resourceName,
                                         Class callingClass)
                                  throws IOException

Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

the requested resource as a string

Throws:

IOException - IO error

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName,
                                              Class callingClass)
                                       throws IOException

Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

an InputStream to the resource or null if resource not found

Throws:

IOException - IO error

getResourceAsStream

public static InputStream getResourceAsStream(String resourceName,
                                              Class callingClass,
                                              boolean tryAsFile,
                                              boolean tryAsUrl)
                                       throws IOException

Attempts to load a resource from the file system, from a URL, or from the classpath, in that order.

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

tryAsFile - - try to load the resource from the local file system

tryAsUrl - - try to load the resource as a URL

Returns:

an InputStream to the resource or null if resource not found

Throws:

IOException - IO error

getResourceAsUrl

public static URL getResourceAsUrl(String resourceName,
                                   Class callingClass)

Attempts to load a resource from the file system or from the classpath, in that order.

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

Returns:

an URL to the resource or null if resource not found

getResourceAsUrl

public static URL getResourceAsUrl(String resourceName,
                                   Class callingClass,
                                   boolean tryAsFile,
                                   boolean tryAsUrl)

Attempts to load a resource from the file system or from the classpath, in that order.

Parameters:

resourceName - The name of the resource to load

callingClass - The Class object of the calling object

tryAsFile - - try to load the resource from the local file system

tryAsUrl - - try to load the resource as a Url string

Returns:

an URL to the resource or null if resource not found

toString

public static String toString(InputStream input)

This method wraps IOUtils' toString(InputStream) method but catches any IOException and wraps it into a RuntimeException.

toString

public static String toString(InputStream input,
                              Charset encoding)

This method wraps IOUtils' toString(InputStream, Charset) method but catches any IOException and wraps it into a RuntimeException.

toString

public static String toString(org.mule.runtime.api.streaming.bytes.CursorStreamProvider cursorStreamProvider)

Similar to toByteArray(InputStream) but obtaining the stream from the given cursorStreamProvider

toByteArray

public static byte[] toByteArray(InputStream input)

This method wraps IOUtils' toByteArray(InputStream) method but catches any IOException and wraps it into a RuntimeException.

toByteArray

public static byte[] toByteArray(org.mule.runtime.api.streaming.bytes.CursorStreamProvider cursorStreamProvider)

This method wraps IOUtils' toByteArray(InputStream) method but catches any IOException and wraps it into a RuntimeException.

copyLarge

public static long copyLarge(InputStream input,
                             OutputStream output)
                      throws IOException

Re-implement copy method to allow buffer size to be configured. This won't impact all methods because there is no polymorphism for static methods, but rather just direct use of these two methods.

Throws:

IOException

copyLarge

public static long copyLarge(Reader input,
                             Writer output)
                      throws IOException

Re-implement copy method to allow buffer size to be configured. This won't impact all methods because there is no polymorphism for static methods, but rather just direct use of these two methods.

Throws:

IOException

toDataHandler

public static DataHandler toDataHandler(String name,
                                        Object object,
                                        org.mule.runtime.api.metadata.MediaType contentType)
                                 throws IOException

Transforms an Object into a DataHandler of its corresponding type.

Parameters:

name - the name of the attachment being handled

object - the attachment to be handled

contentType - the Content-Type of the attachment that is being handled

Returns:

a DataHandler of the corresponding attachment

Throws:

IOException - if the transformation fails.

toMuleMessagePart

public static org.mule.runtime.api.message.Message toMuleMessagePart(String name,
                                                                     Object object,
                                                                     org.mule.runtime.api.metadata.MediaType contentType)
                                                              throws IOException

Transforms an Object into a Message to be used in a MultiPartPayload.

Parameters:

name - the name of the attachment being handled

object - the attachment to be handled

contentType - the Content-Type of the attachment that is being handled

Returns:

a Message of the corresponding attachment

Throws:

IOException - if the transformation fails.

ifInputStream

public static void ifInputStream(Object value,
                                 CheckedConsumer<InputStream> consumer)
                          throws NotAnInputStreamException

Throws:

NotAnInputStreamException

ifInputStream

public static <T> T ifInputStream(Object value,
                                  CheckedFunction<InputStream,T> function)
                           throws NotAnInputStreamException

Throws:

NotAnInputStreamException

closeQuietly

public static void closeQuietly(Closeable closeable)

Closes a {#link Closable} instance catching any exceptions

Parameters:

closeable - instance to be closed. Non null.