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

Class AbstractCursorStreamProviderFactory

java.lang.Object

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

All Implemented Interfaces:

CursorStreamProviderFactory, CursorProviderFactory<InputStream>

Direct Known Subclasses:

InMemoryCursorStreamProviderFactory, NullCursorStreamProviderFactory

public abstract class AbstractCursorStreamProviderFactory
extends Object
implements CursorStreamProviderFactory

Base implementation of CursorStreamProviderFactory which contains all the base behaviour and template methods.

It interacts with the CursorManager in order to track all allocated resources and make sure they're properly disposed of once they're no longer necessary.

Since:

4.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCursorStreamProviderFactory(ByteBufferManager bufferManager, StreamingManager streamingManager) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected ByteBufferManager	getBufferManager()
Object	of(Event event, InputStream inputStream) Optionally creates a new CursorProvider to buffer the given value.
protected abstract Object	resolve(InputStream inputStream, Event event) Implementations should use this method to actually create the output value

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.streaming.bytes.CursorStreamProviderFactory

accepts

Constructor Detail

AbstractCursorStreamProviderFactory

protected AbstractCursorStreamProviderFactory(ByteBufferManager bufferManager,
                                              StreamingManager streamingManager)

Creates a new instance

Parameters:

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

Method Detail

of

public final Object of(Event event,
                       InputStream inputStream)

Optionally creates a new CursorProvider to buffer the given value.

Implementations might resolve that the given stream is/should not be buffered and thus it will return the same given stream. In that case, the stream will be unaltered.

Specified by:

of in interface CursorProviderFactory<InputStream>

Parameters:

event - the event on which buffering is talking place

inputStream - the stream to be cursored

Returns:

A CursorProvider or the same given inputStream

getBufferManager

protected ByteBufferManager getBufferManager()

Returns:

the ByteBufferManager that MUST to be used to allocate byte buffers

resolve

protected abstract Object resolve(InputStream inputStream,
                                  Event event)

Implementations should use this method to actually create the output value

Parameters:

inputStream -

event -

Returns: