org.mule.runtime.core.internal.streaming

Class ManagedCursorProvider<T extends org.mule.runtime.api.streaming.Cursor>

java.lang.Object

org.mule.runtime.core.internal.streaming.ManagedCursorProvider<T>

Type Parameters:

T - the generic type of the actual Cursor types that will be produced

All Implemented Interfaces:

org.mule.runtime.api.streaming.CursorProvider<T>

Direct Known Subclasses:

ManagedCursorIteratorProvider, ManagedCursorStreamProvider

public abstract class ManagedCursorProvider<T extends org.mule.runtime.api.streaming.Cursor>
extends Object
implements org.mule.runtime.api.streaming.CursorProvider<T>

Base class for a CursorProvider decorator which makes sure that cursors opened by the decorated provider are properly tracked through the CursorManager.

Since:

4.0

See Also:

CursorManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ManagedCursorProvider(CursorContext cursorContext, CursorManager cursorManager)

Method Summary

Modifier and Type	Method and Description
void	close()
protected CursorManager	getCursorManager()
boolean	isClosed()
protected abstract T	managedCursor(T cursor, CursorContext handle) Returns a managed version of the cursor.
T	openCursor() Gets a cursor from the delegate and registers it through CursorManager.onOpen(Cursor, CursorContext).
void	releaseResources()

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedCursorProvider

protected ManagedCursorProvider(CursorContext cursorContext,
                                CursorManager cursorManager)

Method Detail

openCursor

public final T openCursor()

Gets a cursor from the delegate and registers it through CursorManager.onOpen(Cursor, CursorContext).

The returned cursor will also be managed through the means of managedCursor(Cursor, CursorContext)

Specified by:

openCursor in interface org.mule.runtime.api.streaming.CursorProvider<T extends org.mule.runtime.api.streaming.Cursor>

Returns:

a new Cursor

managedCursor

protected abstract T managedCursor(T cursor,
                                   CursorContext handle)

Returns a managed version of the cursor. How will that cursor be managed depends on each implementation. Although it is possible that the same input cursor is returned, the assumption should be that a new instance will be returned.

Parameters:

cursor - the cursor to manage

handle - the CursorContext

Returns:

a managed Cursor

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface org.mule.runtime.api.streaming.CursorProvider<T extends org.mule.runtime.api.streaming.Cursor>

close

public void close()

Specified by:

close in interface org.mule.runtime.api.streaming.CursorProvider<T extends org.mule.runtime.api.streaming.Cursor>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.mule.runtime.api.streaming.CursorProvider<T extends org.mule.runtime.api.streaming.Cursor>

getCursorManager

protected CursorManager getCursorManager()