org.mule.runtime.core.internal.streaming.bytes

Class AbstractInputStreamBuffer

java.lang.Object

org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

org.mule.runtime.core.internal.streaming.bytes.AbstractInputStreamBuffer

All Implemented Interfaces:

InputStreamBuffer

Direct Known Subclasses:

InMemoryStreamBuffer

public abstract class AbstractInputStreamBuffer
extends AbstractStreamingBuffer
implements InputStreamBuffer

Base class for implementations of InputStreamBuffer.

Contains the base algorithm and template methods so that implementations can be created easily

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

AbstractStreamingBuffer.LockReleaser

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.api.util.LazyValue<ByteBuffer>	buffer
protected ByteBufferManager	bufferManager

Fields inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

closed, readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
AbstractInputStreamBuffer(InputStream stream, ByteBufferManager bufferManager, int bufferSize) Creates a new instance
AbstractInputStreamBuffer(InputStream stream, ReadableByteChannel streamChannel, ByteBufferManager bufferManager, int bufferSize) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canDoSoftCopy()
void	close() Releases all the resources held by this buffer
protected void	consume(ByteBuffer data)
abstract int	consumeForwardData() Consumes the stream in order to obtain data that has not been read yet.
protected int	consumeStream(ByteBuffer buffer)
protected ByteBuffer	copy(long position, int length)
protected void	deallocate(ByteBuffer byteBuffer)
abstract void	doClose() Template method to support the close() operation
protected abstract ByteBuffer	doGet(long position, int length)
ByteBuffer	get(long position, int length) Returns a ByteBuffer with up to length amount of bytes starting from the given position.
ByteBuffer	getBuffer()
protected boolean	isStreamFullyConsumed()
protected static ReadableByteChannel	openStreamChannel(InputStream stream)
protected void	streamFullyConsumed()

Methods inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

checkNotClosed, closeSafely, withReadLock, withWriteLock

Methods inherited from class java.lang.Object

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

Field Detail

bufferManager

protected final ByteBufferManager bufferManager

buffer

protected org.mule.runtime.api.util.LazyValue<ByteBuffer> buffer

Constructor Detail

AbstractInputStreamBuffer

public AbstractInputStreamBuffer(InputStream stream,
                                 ByteBufferManager bufferManager,
                                 int bufferSize)

Creates a new instance

Parameters:

stream - The stream being buffered. This is the original data source

bufferSize - the buffer size

bufferManager - the ByteBufferManager that will be used to allocate all buffers

AbstractInputStreamBuffer

public AbstractInputStreamBuffer(InputStream stream,
                                 ReadableByteChannel streamChannel,
                                 ByteBufferManager bufferManager,
                                 int bufferSize)

Creates a new instance

Parameters:

stream - The stream being buffered. This is the original data source

streamChannel - a ReadableByteChannel used to read from the stream

bufferManager - the ByteBufferManager that will be used to allocate all buffers

bufferSize - the buffer size

Method Detail

openStreamChannel

protected static ReadableByteChannel openStreamChannel(InputStream stream)

Parameters:

stream - the stream to consume

Returns:

a new ReadableByteChannel for consuming the stream

consumeForwardData

public abstract int consumeForwardData()
                                throws IOException

Consumes the stream in order to obtain data that has not been read yet.

Returns:

the amount of bytes read

Throws:

IOException

close

public final void close()

Releases all the resources held by this buffer

Specified by:

close in interface InputStreamBuffer

doClose

public abstract void doClose()

Template method to support the close() operation

get

public final ByteBuffer get(long position,
                            int length)

Returns a ByteBuffer with up to length amount of bytes starting from the given position. The returned buffer may contain less information than requested. If no information is available at all, then it returns null

Specified by:

get in interface InputStreamBuffer

Parameters:

position - the stream position from which the data should be read

length - how many bytes to read

Returns:

A ByteBuffer with up to length bytes of information or null if no information available at all

Throws:

IllegalStateException - if the buffer is closed

doGet

protected abstract ByteBuffer doGet(long position,
                                    int length)

consume

protected void consume(ByteBuffer data)

getBuffer

public ByteBuffer getBuffer()

Returns:

the buffer

consumeStream

protected int consumeStream(ByteBuffer buffer)
                     throws IOException

Throws:

IOException

deallocate

protected void deallocate(ByteBuffer byteBuffer)

isStreamFullyConsumed

protected boolean isStreamFullyConsumed()

streamFullyConsumed

protected void streamFullyConsumed()

copy

protected final ByteBuffer copy(long position,
                                int length)

canDoSoftCopy

protected abstract boolean canDoSoftCopy()