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

Interface PagingStrategy

All Known Implementing Classes:

DataweaveHypermediaPagingStrategy, DataweaveMarkerPagingStrategy, HypermediaPagingStrategy, MarkerPagingStrategy, OffsetPagingStrategy, PageNumberPagingStrategy

public interface PagingStrategy

Strategy to allow implementing different types of pagination.

Since:

1.0

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

Method Detail

configureRequest

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. This method receives the raw output of the requestBuilder in order to configure the custom parameters that apply.

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

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. Depending on the paging strategy, will change its attributes (like page number or next marker) to prepare for the next http call.

Parameters:

page - the obtained page

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