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

Class BaseDataWeaveBasedRestPollingSourceStrategy<S extends Serializable,A>

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.source.BaseDataWeaveBasedRestPollingSourceStrategy<S,A>

All Implemented Interfaces:

RestPollingSourceStrategy<S,A>

Direct Known Subclasses:

DataWeaveBasedRestPollingSourceStrategy

public abstract class BaseDataWeaveBasedRestPollingSourceStrategy<S extends Serializable,A>
extends Object
implements RestPollingSourceStrategy<S,A>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	identityExpression
protected String	itemBinding
protected String	itemsExpression
protected String	watermarkExpression

Constructor Summary

Constructors

Constructor and Description
BaseDataWeaveBasedRestPollingSourceStrategy(String itemsExpression, String identityExpression, String watermarkExpression, String itemBinding, org.mule.runtime.api.el.ExpressionLanguage expressionLanguage, Class<S> watermarkDataType)

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mulesoft.connectivity.rest.commons.api.source.RestPollingSourceStrategy

getItemAttributes

Field Detail

watermarkExpression

protected final String watermarkExpression

identityExpression

protected final String identityExpression

itemsExpression

protected final String itemsExpression

itemBinding

protected final String itemBinding

Constructor Detail

BaseDataWeaveBasedRestPollingSourceStrategy

public BaseDataWeaveBasedRestPollingSourceStrategy(String itemsExpression,
                                                   String identityExpression,
                                                   String watermarkExpression,
                                                   String itemBinding,
                                                   org.mule.runtime.api.el.ExpressionLanguage expressionLanguage,
                                                   Class<S> watermarkDataType)
                                            throws SourceStartingException

Throws:

SourceStartingException

Method Detail

getItemWatermark

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

Description copied from interface: RestPollingSourceStrategy

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

Specified by:

getItemWatermark in interface RestPollingSourceStrategy<S extends Serializable,A>

Parameters:

lastWatermark - latest watermark obtained

payload - current payload obtained by SaaS response

item - current item

Returns:

the S watermark defined as generic type

getItemIdentity

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

Description copied from interface: RestPollingSourceStrategy

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

Specified by:

getItemIdentity in interface RestPollingSourceStrategy<S extends Serializable,A>

Parameters:

lastWatermark - latest watermark obtained

payload - current payload obtained by SaaS response

item - current item

Returns:

the String identity as string type

extractItems

public 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)

Description copied from interface: RestPollingSourceStrategy

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

Specified by:

extractItems in interface RestPollingSourceStrategy<S extends Serializable,A>

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

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

Description copied from interface: RestPollingSourceStrategy

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

Specified by:

getLastWatermark in interface RestPollingSourceStrategy<S extends Serializable,A>

Returns:

the PollContext , Optional> identity as string type