com.mulesoft.connectivity.rest.commons.api.operation.paging

Class RestPagingDataWeaveProvider<C extends RestConnection>

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.operation.paging.RestPagingProvider<C>

com.mulesoft.connectivity.rest.commons.api.operation.paging.RestPagingDataWeaveProvider<C>

All Implemented Interfaces:

org.mule.sdk.api.runtime.streaming.PagingProvider<C,org.mule.runtime.api.metadata.TypedValue<String>>

public class RestPagingDataWeaveProvider<C extends RestConnection>
extends RestPagingProvider<C>

An implementation for RestPagingProvider which uses DataWeave to extract the payload and create the list of pages.

Type parameters: – subclass of RestConnection

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class com.mulesoft.connectivity.rest.commons.api.operation.paging.RestPagingProvider

RestPagingProvider.PagingContext

Constructor Summary

Constructors

Constructor and Description
RestPagingDataWeaveProvider(Function<C,org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder> requestFactory, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType, PagingStrategy pagingStrategy, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, String pageItemsExtractorExpression) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected List<org.mule.runtime.api.metadata.TypedValue<String>>	extractPageItems(org.mule.runtime.api.metadata.TypedValue<String> content) Given the raw content response body this method will extract the payload data as a list of items which represent a page.
protected org.mule.runtime.api.metadata.TypedValue<String>	toRawPage(InputStream content, org.mule.runtime.api.metadata.MediaType mediaType) Given the server response this method will consume the response from the content InputStream with the given MediaType, which may or may not contain a charset (cases like application/json should use the default encodings), returns a TypedValue with the content as String.

Methods inherited from class com.mulesoft.connectivity.rest.commons.api.operation.paging.RestPagingProvider

close, getPage, getTotalResults, postProcess, send

Methods inherited from class java.lang.Object

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

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

useStickyConnections

Constructor Detail

RestPagingDataWeaveProvider

public RestPagingDataWeaveProvider(Function<C,org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder> requestFactory,
                                   org.mule.runtime.api.metadata.MediaType defaultResponseMediaType,
                                   PagingStrategy pagingStrategy,
                                   org.mule.runtime.api.el.ExpressionLanguage expressionLanguage,
                                   String pageItemsExtractorExpression)

Creates a new instance

Parameters:

requestFactory - a Function to generate the request to be used on each page request. Each invocation should yield a different instance.

defaultResponseMediaType - the MediaType for the page items if the server doesn't specify one.

pagingStrategy - the pagination strategy.

expressionLanguage - ExpressionLanguage to evaluate the pageItemsExtractorExpression to extract the pages content from the server's response.

pageItemsExtractorExpression - a DataWeave expression to extract the response with the page data.

Method Detail

toRawPage

protected org.mule.runtime.api.metadata.TypedValue<String> toRawPage(InputStream content,
                                                                     org.mule.runtime.api.metadata.MediaType mediaType)

Description copied from class: RestPagingProvider

Given the server response this method will consume the response from the content InputStream with the given MediaType, which may or may not contain a charset (cases like application/json should use the default encodings), returns a TypedValue with the content as String.

Specified by:

toRawPage in class RestPagingProvider<C extends RestConnection>

Parameters:

content - the stream response from the server.

mediaType - the MediaType for this content.

Returns:

a TypedValue with the content as String.

extractPageItems

protected List<org.mule.runtime.api.metadata.TypedValue<String>> extractPageItems(org.mule.runtime.api.metadata.TypedValue<String> content)

Description copied from class: RestPagingProvider

Given the raw content response body this method will extract the payload data as a list of items which represent a page.

Specified by:

extractPageItems in class RestPagingProvider<C extends RestConnection>

Parameters:

content - raw content page as TypedValue

Returns:

a List> which represents a page with items.