org.mule.runtime.extension.api.runtime.streaming

Interface StreamingHelper

All Superinterfaces:

org.mule.sdk.api.runtime.streaming.StreamingHelper

@MinMuleVersion(value="4.1")
 @NoImplement
public interface StreamingHelper
extends org.mule.sdk.api.runtime.streaming.StreamingHelper

This class provides helper methods to deal with repeatable streaming resources which are contained into structures of arbitrary complexity.

As you know, when a parameter is resolved to a CursorProvider, the runtime automatically obtains a Cursor and injects that value instead. However, if that provider is embedded as the value of a Map or an arbitrary pojo, the runtime can't guess that's the case and go resolve it.

Same thing applies when a component is producing a result. The runtime automatically converts returned InputStream or PagingProvider instances into CursorProvider ones. However, if such instances are contained in some other value, that resolution won't happen automatically either.

For these border cases, this class provides some utilities to adapt the providers into cursors and vice versa

Since:

1.0

See Also:

CursorProvider, CursorStreamProvider, CursorIteratorProvider

Method Summary

Methods inherited from interface org.mule.sdk.api.runtime.streaming.StreamingHelper

resolveCursor, resolveCursorProvider, resolveCursorProviders, resolveCursors