org.mule.runtime.core.api.streaming

Class DefaultStreamingManager

java.lang.Object

org.mule.runtime.core.api.streaming.DefaultStreamingManager

All Implemented Interfaces:

Disposable, Initialisable, StreamingManager

@NoExtend
public class DefaultStreamingManager
extends Object
implements StreamingManager, Initialisable, Disposable

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultStreamingManager()

Method Summary

Modifier and Type	Method and Description
protected ByteStreamingManager	createByteStreamingManager()
protected ObjectStreamingManager	createObjectStreamingManager()
void	dispose() A lifecycle method where implementor should free up any resources.
ByteStreamingManager	forBytes()
ObjectStreamingManager	forObjects()
protected ByteBufferManager	getBufferManager()
StreamingStatistics	getStreamingStatistics()
void	initialise() Method used to perform any initialisation work.
CursorProvider	manage(CursorProvider provider, CoreEvent creatorEvent) Becomes aware of the given provider and returns a replacement provider which is managed by the runtime, allowing for automatic resource handling
void	manage(InputStream stream, CoreEvent creatorEvent) Becomes aware of the given inputStream and makes sure it is closed by the time the given creatorEvent (and all its parent events) are completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStreamingManager

public DefaultStreamingManager()

Method Detail

initialise

public void initialise()
                throws InitialisationException

Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown.

In case that the Initialisable.initialise() method execution fails then mule will call the Disposable.dispose() method if the class also implements Disposable allowing the object to dispose any allocated resource during Initialisable.initialise()

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

See Also:

Disposable

createByteStreamingManager

protected ByteStreamingManager createByteStreamingManager()

createObjectStreamingManager

protected ObjectStreamingManager createObjectStreamingManager()

dispose

public void dispose()

A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

Specified by:

dispose in interface Disposable

forBytes

public ByteStreamingManager forBytes()

Specified by:

forBytes in interface StreamingManager

Returns:

a delegate manager to be used when streaming bytes

forObjects

public ObjectStreamingManager forObjects()

Specified by:

forObjects in interface StreamingManager

Returns:

a delegate manager to be used when streaming objects

manage

public CursorProvider manage(CursorProvider provider,
                             CoreEvent creatorEvent)

Becomes aware of the given provider and returns a replacement provider which is managed by the runtime, allowing for automatic resource handling

Specified by:

manage in interface StreamingManager

Parameters:

provider - the provider to be tracked

creatorEvent - the event that created the provider

Returns:

a CursorContext

manage

public void manage(InputStream stream,
                   CoreEvent creatorEvent)

Becomes aware of the given inputStream and makes sure it is closed by the time the given creatorEvent (and all its parent events) are completed.

If inputStream is a Cursor then nothing happens. Use StreamingManager.manage(CursorProvider, CoreEvent) for those cases.

Specified by:

manage in interface StreamingManager

Parameters:

stream - the stream to track

creatorEvent - the event on which the stream was created

getStreamingStatistics

public StreamingStatistics getStreamingStatistics()

Specified by:

getStreamingStatistics in interface StreamingManager

Returns:

statistics about the ongoing streaming operations

getBufferManager

protected ByteBufferManager getBufferManager()