com.mulesoft.connectivity.rest.commons.api.source

Interface RestPollingSourceStrategy<S extends Serializable,A>

All Known Implementing Classes:

BaseDataWeaveBasedRestPollingSourceStrategy, DataWeaveBasedRestPollingSourceStrategy

public interface RestPollingSourceStrategy<S extends Serializable,A>

This interface defines the necessary methods to extract the information needed to use a RestPollingSource

Method Summary

Modifier and Type	Method and Description
List<org.mule.runtime.api.metadata.TypedValue<String>>	extractItems(Optional<S> lastWatermark, org.mule.runtime.api.metadata.TypedValue<String> fullResponse, int statusCode, String reasonPhrase, org.mule.runtime.api.util.MultiMap<String,String> headers) This method gets the list of items from the SaaS response.
A	getItemAttributes(int statusCode, String reasonPhrase, org.mule.runtime.api.util.MultiMap<String,String> headers, org.mule.runtime.api.metadata.TypedValue<String> item) This method returns the attributes to be set for the item result attributes.
String	getItemIdentity(Optional<S> lastWatermark, org.mule.runtime.api.metadata.TypedValue<String> payload, org.mule.runtime.api.metadata.TypedValue<String> item) This method gets the item identity from the SaaS response having the full response, the individual item and the last watermark available.
S	getItemWatermark(Optional<S> lastWatermark, org.mule.runtime.api.metadata.TypedValue<String> payload, org.mule.runtime.api.metadata.TypedValue<String> item) This method gets the item watermark from the SaaS response having the full response, the individual item and the last watermark available.
Function<org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,A>,Optional<S>>	getLastWatermark() This method gets the latest watermark from the poll context to be used as starting point for new responses.

Method Detail

getItemWatermark

S getItemWatermark(Optional<S> lastWatermark,
                   org.mule.runtime.api.metadata.TypedValue<String> payload,
                   org.mule.runtime.api.metadata.TypedValue<String> item)

This method gets the item watermark from the SaaS response having the full response, the individual item and the last watermark available.

Parameters:

lastWatermark - latest watermark obtained

payload - current payload obtained by SaaS response

item - current item

Returns:

the S watermark defined as generic type

getItemIdentity

String getItemIdentity(Optional<S> lastWatermark,
                       org.mule.runtime.api.metadata.TypedValue<String> payload,
                       org.mule.runtime.api.metadata.TypedValue<String> item)

This method gets the item identity from the SaaS response having the full response, the individual item and the last watermark available.

Parameters:

lastWatermark - latest watermark obtained

payload - current payload obtained by SaaS response

item - current item

Returns:

the String identity as string type

extractItems

List<org.mule.runtime.api.metadata.TypedValue<String>> extractItems(Optional<S> lastWatermark,
                                                                    org.mule.runtime.api.metadata.TypedValue<String> fullResponse,
                                                                    int statusCode,
                                                                    String reasonPhrase,
                                                                    org.mule.runtime.api.util.MultiMap<String,String> headers)

This method gets the list of items from the SaaS response.

Parameters:

lastWatermark - latest watermark obtained

fullResponse - current payload obtained by SaaS response

statusCode - http status code from SaaS response

reasonPhrase - http reason phrase from SaaS response

headers - http headers from SaaS response

Returns:

the List> list of items

getLastWatermark

Function<org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,A>,Optional<S>> getLastWatermark()

This method gets the latest watermark from the poll context to be used as starting point for new responses.

Returns:

the PollContext , Optional> identity as string type

getItemAttributes

A getItemAttributes(int statusCode,
                    String reasonPhrase,
                    org.mule.runtime.api.util.MultiMap<String,String> headers,
                    org.mule.runtime.api.metadata.TypedValue<String> item)

This method returns the attributes to be set for the item result attributes.

Parameters:

item - current item obtained by SaaS response

statusCode - http status code from SaaS response

reasonPhrase - http reason phrase from SaaS response

headers - http headers from SaaS response

Returns:

the A identity as string type