org.apache.axiom.attachments.impl

Class BufferUtils

java.lang.Object

org.apache.axiom.attachments.impl.BufferUtils

public class BufferUtils
extends java.lang.Object

Attachment processing uses a lot of buffers. The BufferUtils class attempts to reuse buffers to prevent excessive GarbageCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BufferUtils.SizeLimitedOutputStream An output stream that counts the number of bytes written to it and throws an exception when the size exceeds a given limit.
private static class	BufferUtils.SizeLimitExceededException Exception used by SizeLimitedOutputStream if the size limit has been exceeded.

Field Summary

Fields

Modifier and Type	Field and Description
private static byte[]	_cacheBuffer
private static boolean	_cacheBufferInUse
private static java.nio.ByteBuffer	_cacheByteBuffer
private static boolean	_cacheByteBufferInUse
static int	BUFFER_LEN
(package private) static boolean	ENABLE_BAAOS_OPT
(package private) static boolean	ENABLE_FILE_CHANNEL
private static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
BufferUtils()

Method Summary

Modifier and Type	Method and Description
static int	doesDataHandlerExceedLimit(javax.activation.DataHandler dh, int limit) The method checks to see if attachment is eligble for optimization.
private static byte[]	getTempBuffer()
private static java.nio.ByteBuffer	getTempByteBuffer()
static long	inputStream2BAAOutputStream(java.io.InputStream is, BAAOutputStream baaos, long limit) inputStream2BAAOutputStream
static boolean	inputStream2FileOutputStream(java.io.InputStream is, java.io.FileOutputStream fos) Opimized writing to FileOutputStream using a channel
static void	inputStream2OutputStream(java.io.InputStream is, java.io.OutputStream os) Private utility to write the InputStream contents to the OutputStream.
static int	inputStream2OutputStream(java.io.InputStream is, java.io.OutputStream os, int limit)
private static void	releaseTempBuffer(byte[] buffer)
private static void	releaseTempByteBuffer(java.nio.ByteBuffer buffer)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

BUFFER_LEN

public static final int BUFFER_LEN

See Also:

Constant Field Values

ENABLE_FILE_CHANNEL

static boolean ENABLE_FILE_CHANNEL

ENABLE_BAAOS_OPT

static boolean ENABLE_BAAOS_OPT

_cacheBuffer

private static byte[] _cacheBuffer

_cacheBufferInUse

private static boolean _cacheBufferInUse

_cacheByteBuffer

private static java.nio.ByteBuffer _cacheByteBuffer

_cacheByteBufferInUse

private static boolean _cacheByteBufferInUse

Constructor Detail

BufferUtils

public BufferUtils()

Method Detail

inputStream2OutputStream

public static void inputStream2OutputStream(java.io.InputStream is,
                                            java.io.OutputStream os)
                                     throws java.io.IOException

Private utility to write the InputStream contents to the OutputStream.

Parameters:

is -

os -

Throws:

java.io.IOException

inputStream2OutputStream

public static int inputStream2OutputStream(java.io.InputStream is,
                                           java.io.OutputStream os,
                                           int limit)
                                    throws java.io.IOException

Parameters:

is - InputStream

os - OutputStream

limit - maximum number of bytes to read

Returns:

total bytes read

Throws:

java.io.IOException

inputStream2FileOutputStream

public static boolean inputStream2FileOutputStream(java.io.InputStream is,
                                                   java.io.FileOutputStream fos)
                                            throws java.io.IOException

Opimized writing to FileOutputStream using a channel

Parameters:

is -

fos -

Returns:

false if lock was not aquired

Throws:

java.io.IOException

inputStream2BAAOutputStream

public static long inputStream2BAAOutputStream(java.io.InputStream is,
                                               BAAOutputStream baaos,
                                               long limit)
                                        throws java.io.IOException

inputStream2BAAOutputStream

Parameters:

is -

baaos -

limit -

Returns:

the number of bytes copied

Throws:

java.io.IOException

doesDataHandlerExceedLimit

public static int doesDataHandlerExceedLimit(javax.activation.DataHandler dh,
                                             int limit)

The method checks to see if attachment is eligble for optimization. An attachment is eligible for optimization if and only if the size of the attachment is greated then the optimzation threshold size limit. if the Content represented by DataHandler has size less than the optimize threshold size, the attachment will not be eligible for optimization, instead it will be inlined.

Parameters:

dh -

limit -

Returns:

1 if DataHandler data is bigger than limit, 0 if DataHandler data is smaller or -1 if an error occurs or unsupported.

Throws:

java.io.IOException

getTempBuffer

private static byte[] getTempBuffer()

releaseTempBuffer

private static void releaseTempBuffer(byte[] buffer)

getTempByteBuffer

private static java.nio.ByteBuffer getTempByteBuffer()

releaseTempByteBuffer

private static void releaseTempByteBuffer(java.nio.ByteBuffer buffer)