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

Class InMemoryStreamBuffer

java.lang.Object

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

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

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

All Implemented Interfaces:

InputStreamBuffer

public class InMemoryStreamBuffer
extends AbstractInputStreamBuffer

An implementation of AbstractInputStreamBuffer which holds the buffered information in memory.

If the buffer does not have enough capacity to hold all the data, then it will expanded up to a certain threshold configured in the constructor. Once that threshold is reached, a StreamingBufferSizeExceededException will be thrown. If no threshold is provided, then the buffer will be allowed to grow indefinitely.

Since:

4.0

Nested Class Summary

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

AbstractStreamingBuffer.LockReleaser

Field Summary

Fields inherited from class org.mule.runtime.core.internal.streaming.bytes.AbstractInputStreamBuffer

buffer, bufferManager

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

closed, readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
InMemoryStreamBuffer(InputStream stream, InMemoryCursorStreamConfig config, ByteBufferManager bufferManager) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected boolean	canDoSoftCopy()
int	consumeForwardData() Consumes the stream in order to obtain data that has not been read yet.
void	doClose() Template method to support the AbstractInputStreamBuffer.close() operation
protected ByteBuffer	doGet(long position, int length)

Methods inherited from class org.mule.runtime.core.internal.streaming.bytes.AbstractInputStreamBuffer

close, consume, consumeStream, copy, deallocate, get, getBuffer, isStreamFullyConsumed, openStreamChannel, 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

Constructor Detail

InMemoryStreamBuffer

public InMemoryStreamBuffer(InputStream stream,
                            InMemoryCursorStreamConfig config,
                            ByteBufferManager bufferManager)

Creates a new instance

Parameters:

stream - the stream to be buffered

config - this buffer's configuration.

Method Detail

doGet

protected ByteBuffer doGet(long position,
                           int length)

Specified by:

doGet in class AbstractInputStreamBuffer

doClose

public void doClose()

Template method to support the AbstractInputStreamBuffer.close() operation

Specified by:

doClose in class AbstractInputStreamBuffer

consumeForwardData

public int consumeForwardData()
                       throws IOException

Consumes the stream in order to obtain data that has not been read yet. If buffer doesn't have any remaining capacity, then expandBuffer() is invoked before attempting to consume new information.

Specified by:

consumeForwardData in class AbstractInputStreamBuffer

Returns:

the amount of bytes read

Throws:

org.mule.runtime.api.streaming.exception.StreamingBufferSizeExceededException - if the buffer is not big enough and cannot be expanded

IOException

canDoSoftCopy

protected boolean canDoSoftCopy()

Specified by:

canDoSoftCopy in class AbstractInputStreamBuffer