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

Class HypermediaPagingStrategy

java.lang.Object

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

All Implemented Interfaces:

PagingStrategy

Direct Known Subclasses:

DataweaveHypermediaPagingStrategy

public abstract class HypermediaPagingStrategy
extends Object
implements PagingStrategy

Base class of PagingStrategy for APIs which do paging based on a next URL provided in the response of each request.

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

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
HypermediaPagingStrategy()

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	buildLinkHeaderMap(String linkHeader) Parse Link header into a Map of links by its relation
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.
protected abstract String	extractNextUrl(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

HypermediaPagingStrategy

public HypermediaPagingStrategy()

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.

extractNextUrl

protected abstract String extractNextUrl(org.mule.runtime.api.metadata.TypedValue<String> rawPage,
                                         org.mule.runtime.api.util.MultiMap<String,String> headers)

buildLinkHeaderMap

protected Map<String,String> buildLinkHeaderMap(String linkHeader)

Parse Link header into a Map of links by its relation

Parameters:

linkHeader - header to be parsed

Returns:

Map of Links by relation