org.mule.connectors.restconnect.commons.api.operation.paging

Class PageNumberPagingProvider

java.lang.Object

org.mule.connectors.restconnect.commons.api.operation.paging.RestPagingProvider

org.mule.connectors.restconnect.commons.api.operation.paging.PageNumberPagingProvider

All Implemented Interfaces:

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

public class PageNumberPagingProvider
extends RestPagingProvider

Implementation of RestPagingProvider for APIs which do paging based on requesting individual pages by number

Since:

1.0

Field Summary

Fields inherited from class org.mule.connectors.restconnect.commons.api.operation.paging.RestPagingProvider

encoding, expressionLanguage, mediaType, responseTimeout

Constructor Summary

Constructors

Constructor and Description

PageNumberPagingProvider(String pageNumberParamName, int initialPageNumber, Function<RestConnection,org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder> 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 mediaType, String encoding, int responseTimeout) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	configureRequest(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder 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, String rawPage) Invoked each time a page is obtained.

Methods inherited from class org.mule.connectors.restconnect.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

PageNumberPagingProvider

public PageNumberPagingProvider(String pageNumberParamName,
                                int initialPageNumber,
                                Function<RestConnection,org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder> 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 mediaType,
                                String encoding,
                                int responseTimeout)

Creates a new instance

Parameters:

pageNumberParamName - the name of the query param that carries the page number value

initialPageNumber - the initial page to get in 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

mediaType - the MediaType for the page items

encoding - the encoding for the page items

responseTimeout - the timeout for each request

Method Detail

configureRequest

protected void configureRequest(org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder 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 HttpRequestBuilder

onPage

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

Description copied from class: RestPagingProvider

Invoked each time a page is obtained.

Overrides:

onPage in class RestPagingProvider

Parameters:

page - the obtained page