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

Class OffsetPagingProvider

java.lang.Object

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

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

All Implemented Interfaces:

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

public class OffsetPagingProvider
extends RestPagingProvider

Implementation of RestPagingProvider for APIs which do paging based on an offset query param.

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
OffsetPagingProvider(String offsetParamName, int initialOffset, 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 httpResponseAttributes) 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

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

OffsetPagingProvider

public OffsetPagingProvider(String offsetParamName,
                            int initialOffset,
                            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:

offsetParamName - the name of the query param that carries the offset value

initialOffset - the initial offset to apply on the first request

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 httpResponseAttributes)

Description copied from class: RestPagingProvider

Invoked each time a page is obtained.

Overrides:

onPage in class RestPagingProvider

Parameters:

page - the obtained page