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

Class RestPagingProvider<C extends RestConnection>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

RestPagingDataWeaveProvider

public abstract class RestPagingProvider<C extends RestConnection>
extends Object
implements org.mule.runtime.extension.api.runtime.streaming.PagingProvider<C,org.mule.runtime.api.metadata.TypedValue<String>>

Provides the base functionality for paginating the results of a REST endpoint.

Different APIs use different paging strategies which are tackled in implementations of this class. This class provides the basics as:

• Executing one request per page to be obtained
• Ability to parse the response to extract the data and useful metadata as the total results count (if provided)
• Handling streaming
• Handling the nuances of the PagingProvider contract
• Handling encodings and media types

Each item in the obtained page will be returned as an individual TypedValue, with the proper mime type and encoding set.

Type parameters: – subclass of RestConnection

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestPagingProvider.PagingContext Context related to the pagination.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close(RestConnection connection)
protected abstract 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.
List<org.mule.runtime.api.metadata.TypedValue<String>>	getPage(C connection)
Optional<Integer>	getTotalResults(RestConnection connection)
protected org.mule.runtime.api.metadata.TypedValue<String>	postProcess(org.mule.runtime.api.metadata.TypedValue<String> rawPage) Allows post process the server response before the payload is extracted.
protected HttpResponseResult	send(C connection, org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder, org.mule.runtime.api.metadata.MediaType defaultResponseMediaType) Does the HTTP call with the given connection for the requestBuilder.
protected abstract 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 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

RestPagingProvider

public RestPagingProvider(Function<C,org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder> requestFactory,
                          org.mule.runtime.api.metadata.MediaType defaultResponseMediaType,
                          PagingStrategy pagingStrategy)

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.

Method Detail

getPage

public final List<org.mule.runtime.api.metadata.TypedValue<String>> getPage(C connection)

Specified by:

getPage in interface org.mule.sdk.api.runtime.streaming.PagingProvider<C extends RestConnection,org.mule.runtime.api.metadata.TypedValue<String>>

toRawPage

protected abstract 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.

Parameters:

content - the stream response from the server.

mediaType - the MediaType for this content.

Returns:

a TypedValue with the content as String.

send

protected HttpResponseResult send(C connection,
                                  org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder,
                                  org.mule.runtime.api.metadata.MediaType defaultResponseMediaType)

Does the HTTP call with the given connection for the requestBuilder.

Parameters:

connection - raw content page as TypedValue

requestBuilder - the HttpRequestBuilder to be executed.

defaultResponseMediaType - to be used if the server doesn't specify one with the HttpHeaders.Names.CONTENT_TYPE header.

Returns:

a HttpResponse which represents the server response.

extractPageItems

protected abstract 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.

Parameters:

content - raw content page as TypedValue

Returns:

a List> which represents a page with items.

postProcess

protected org.mule.runtime.api.metadata.TypedValue<String> postProcess(org.mule.runtime.api.metadata.TypedValue<String> rawPage)

Allows post process the server response before the payload is extracted.

Parameters:

rawPage - the server response as it.

Returns:

either the same rawPage or a new page modified.

getTotalResults

public Optional<Integer> getTotalResults(RestConnection connection)

Specified by:

getTotalResults in interface org.mule.sdk.api.runtime.streaming.PagingProvider<C extends RestConnection,org.mule.runtime.api.metadata.TypedValue<String>>

close

public final void close(RestConnection connection)
                 throws org.mule.runtime.api.exception.MuleException

Specified by:

close in interface org.mule.sdk.api.runtime.streaming.PagingProvider<C extends RestConnection,org.mule.runtime.api.metadata.TypedValue<String>>

Throws:

org.mule.runtime.api.exception.MuleException