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

Class PageNumberPagingStrategy

java.lang.Object

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

All Implemented Interfaces:

PagingStrategy

public class PageNumberPagingStrategy
extends Object
implements PagingStrategy

Base class of PagingStrategy for APIs which do paging based on requesting individual pages by number

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
PageNumberPagingStrategy(String pageNumberParamName, int initialPageNumber) Creates a new instance

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder	configureRequest(String baseUri, org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder, RestPagingProvider.PagingContext context) Depending on the paging strategy, different parameters or headers may need to be passed.
Integer	extractPageCount(org.mule.runtime.api.metadata.TypedValue<String> rawPage, org.mule.runtime.api.util.MultiMap<String,String> headers)
void	onPage(List<org.mule.runtime.api.metadata.TypedValue<String>> page, org.mule.runtime.api.metadata.TypedValue<String> rawPage, org.mule.runtime.api.util.MultiMap<String,String> headers, RestPagingProvider.PagingContext context) Invoked each time a page is obtained.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageNumberPagingStrategy

public PageNumberPagingStrategy(String pageNumberParamName,
                                int initialPageNumber)

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

Method Detail

configureRequest

public org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder configureRequest(String baseUri,
                                                                                            org.mule.runtime.http.api.domain.message.request.HttpRequestBuilder requestBuilder,
                                                                                            RestPagingProvider.PagingContext context)

Description copied from interface: PagingStrategy

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

Specified by:

configureRequest in interface PagingStrategy

Parameters:

baseUri - the base uri of the REST API being consumed.

requestBuilder - a HttpRequestBuilder.

context - the pagination context to allow stopping the pagination mechanism.

Returns:

the same HttpRequestBuilder configured or a new one.

onPage

public void onPage(List<org.mule.runtime.api.metadata.TypedValue<String>> page,
                   org.mule.runtime.api.metadata.TypedValue<String> rawPage,
                   org.mule.runtime.api.util.MultiMap<String,String> headers,
                   RestPagingProvider.PagingContext context)

Description copied from interface: PagingStrategy

Invoked each time a page is obtained. Depending on the paging strategy, will change its attributes (like page number or next marker) to prepare for the next http call.

Specified by:

onPage in interface PagingStrategy

Parameters:

page - the obtained page

context - the pagination context to allow stopping the pagination mechanism.

extractPageCount

public Integer extractPageCount(org.mule.runtime.api.metadata.TypedValue<String> rawPage,
                                org.mule.runtime.api.util.MultiMap<String,String> headers)