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

Class MarkerPagingProvider

java.lang.Object

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

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

All Implemented Interfaces:

org.mule.runtime.extension.api.runtime.streaming.PagingProvider<RestConnection,org.mule.runtime.api.metadata.TypedValue<String>>

public class MarkerPagingProvider
extends RestPagingProvider

Implementation of RestPagingProvider for APIs which do paging based on a marker provided in the response of each request, acting as a marker or position inside the stream of results.

Request number 1 will obtain the first page plus a marker embedded in the response. Said marker will be added as a query param in request number 2, which will reply with the next page and a new marker which overwrites the prior one. The process continues until no new marker is provided or the next page comes back empty.

Since:

1.0

Field Summary

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

defaultMediaType, expressionLanguage, responseTimeout

Constructor Summary

Constructors

Constructor and Description

MarkerPagingProvider(String markerParamName, String nextMarkerExpression, Function<RestConnection,RestRequestBuilder> requestFactory, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper, String payloadExpression, org.mule.runtime.api.metadata.MediaType defaultMediaType, int responseTimeout) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	configureRequest(RestRequestBuilder requestBuilder) Depending on the paging strategy, different parameters or headers may need to be passed.
protected void	onPage(List<org.mule.runtime.api.metadata.TypedValue<String>> page, org.mule.runtime.api.metadata.TypedValue<String> rawPage, HttpResponseAttributes responseAttributes) Invoked each time a page is obtained.

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

close, doClose, evaluate, getPage, getTotalResults, stopPaging, toBindingContext, withResponseBinding

Methods inherited from class java.lang.Object

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

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

useStickyConnections

Constructor Detail

MarkerPagingProvider

public MarkerPagingProvider(String markerParamName,
                            String nextMarkerExpression,
                            Function<RestConnection,RestRequestBuilder> requestFactory,
                            org.mule.runtime.api.el.ExpressionLanguage expressionLanguage,
                            org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper,
                            String payloadExpression,
                            org.mule.runtime.api.metadata.MediaType defaultMediaType,
                            int responseTimeout)

Creates a new instance

Parameters:

markerParamName - the name of the query parameter in which the marker is placed in the request

nextMarkerExpression - the DW expression used to extract the next marker from the response

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

expressionLanguage - the app's ExpressionLanguage

streamingHelper - the StreamingHelper associated to the executing operation

payloadExpression - a DW expression to extract the data from the response

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

responseTimeout - the timeout for each request

Method Detail

configureRequest

protected void configureRequest(RestRequestBuilder requestBuilder)

Description copied from class: RestPagingProvider

Depending on the paging strategy, different parameters or headers may need to be passed. This method receives the raw output of the RestPagingProvider.requestFactory in order to configure the custom parameters that apply/

Specified by:

configureRequest in class RestPagingProvider

Parameters:

requestBuilder - a RestRequestBuilder

onPage

protected void onPage(List<org.mule.runtime.api.metadata.TypedValue<String>> page,
                      org.mule.runtime.api.metadata.TypedValue<String> rawPage,
                      HttpResponseAttributes responseAttributes)

Description copied from class: RestPagingProvider

Invoked each time a page is obtained.

Specified by:

onPage in class RestPagingProvider

Parameters:

page - the obtained page