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

Class PaginatedBasedRestPollingSource

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<T,A>

org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

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

public abstract class PaginatedBasedRestPollingSource
extends org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

Base class for defining a polling source that consumes a remote REST endpoint in a connector.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RestPagingProvider	baseOperationPagingProvider
protected RestConfiguration	config
protected RestConnection	connection
protected String	eventExpression
protected String	identityExpression
protected ConfigurationOverrides	overrides
protected String	requestBodyExpression
protected String	startValueExpression
protected String	watermarkExpression

Fields inherited from class org.mule.runtime.extension.api.runtime.source.PollingSource

IDS_ON_UPDATED_WATERMARK_OS_NAME_SUFFIX, OS_NAME_MASK, OS_NAME_PREFIX, RECENTLY_PROCESSED_IDS_OS_NAME_SUFFIX, UPDATED_WATERMARK_ITEM_OS_KEY, WATERMARK_ITEM_OS_KEY, WATERMARK_OS_NAME_SUFFIX

Constructor Summary

Constructors

Constructor and Description
PaginatedBasedRestPollingSource(String watermarkExpression, String identityExpression, String requestBodyExpression, String eventExpression, String startValueExpression)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doInstancesStart() Start method to be overridden on each instance, at least making the baseOperationPagingProvider initialization.
protected void	doStart()
protected void	doStop()
protected RestConfiguration	getConfig()
protected RestConnection	getConnection()
protected org.mule.runtime.api.metadata.MediaType	getDefaultResponseMediaType()
protected org.mule.runtime.api.el.ExpressionLanguage	getExpressionLanguage()
protected String	getId()
protected abstract HttpRequestBinding	getParameterBinding() Returns the parameter binding configuration of this RestPollingSource.
protected abstract Map<String,Object>	getParameterValues() Returns a MultiMap containing all the parameters this source exposes to the user.
protected abstract String	getPathTemplate() Returns the request path for this RestPollingSource with placeholders for its uri parameters.
protected org.mule.runtime.api.metadata.TypedValue<?>	getStartValue(org.mule.runtime.api.el.BindingContext bindingContext) Returns the initial value start value will hold.
protected org.mule.runtime.api.metadata.DataType	getWatermarkDataType()
void	onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Object> result, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)
void	poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,Object> pollContext)

Methods inherited from class org.mule.runtime.extension.api.runtime.source.PollingSource

onStart, onStop

Methods inherited from class java.lang.Object

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

Field Detail

config

@Config
protected RestConfiguration config

connection

protected RestConnection connection

watermarkExpression

protected final String watermarkExpression

identityExpression

protected final String identityExpression

requestBodyExpression

protected final String requestBodyExpression

eventExpression

protected final String eventExpression

startValueExpression

protected final String startValueExpression

baseOperationPagingProvider

protected RestPagingProvider baseOperationPagingProvider

overrides

@ParameterGroup(name="Connector Overrides")
protected ConfigurationOverrides overrides

Constructor Detail

PaginatedBasedRestPollingSource

public PaginatedBasedRestPollingSource(String watermarkExpression,
                                       String identityExpression,
                                       String requestBodyExpression,
                                       String eventExpression,
                                       String startValueExpression)

Method Detail

doStart

protected void doStart()
                throws org.mule.runtime.api.exception.MuleException

Specified by:

doStart in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

Throws:

org.mule.runtime.api.exception.MuleException

doInstancesStart

protected abstract void doInstancesStart()

Start method to be overridden on each instance, at least making the baseOperationPagingProvider initialization.

getStartValue

protected org.mule.runtime.api.metadata.TypedValue<?> getStartValue(org.mule.runtime.api.el.BindingContext bindingContext)

Returns the initial value start value will hold. Defaults to the expression parameterized as the startValueExpression, but it can execute any code (such as a http call to obtain data).

Parameters:

bindingContext - the context to access the parameters, config or connection in the DW engine

Returns:

a TypedValue with the information that will be available later on in the `startValue` binding in the trigger later on

doStop

protected void doStop()

Specified by:

doStop in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

getParameterBinding

protected abstract HttpRequestBinding getParameterBinding()

Returns the parameter binding configuration of this RestPollingSource.

getParameterValues

protected abstract Map<String,Object> getParameterValues()

Returns a MultiMap containing all the parameters this source exposes to the user. Each entry must contain the parameter name as key and its value represented as a TypedValue.

getPathTemplate

protected abstract String getPathTemplate()

Returns the request path for this RestPollingSource with placeholders for its uri parameters. i.e: /user/{username}/events

getId

protected String getId()

getConfig

protected RestConfiguration getConfig()

Returns:

The injected config

getExpressionLanguage

protected org.mule.runtime.api.el.ExpressionLanguage getExpressionLanguage()

Returns:

The injected expression language

getConnection

protected RestConnection getConnection()

Returns:

The injected connection

poll

public void poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,Object> pollContext)

Specified by:

poll in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

getWatermarkDataType

protected org.mule.runtime.api.metadata.DataType getWatermarkDataType()

onRejectedItem

public void onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Object> result,
                           org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)

Specified by:

onRejectedItem in class org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,Object>

getDefaultResponseMediaType

protected org.mule.runtime.api.metadata.MediaType getDefaultResponseMediaType()