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

Class RestPollingSource

java.lang.Object

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

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

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

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

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 RestConnection	connection
protected String	identityExpression
protected String	itemsExpression
protected String	requestBodyExpression
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
RestPollingSource(String itemsExpression, String watermarkExpression, String identityExpression, String requestBodyExpression)

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
protected org.mule.runtime.api.metadata.MediaType	getDefaultResponseMediaType()
protected String	getId()
protected abstract HttpRequestBinding	getParameterBinding() Returns the parameter binding configuration of this RestPollingSource.
protected abstract org.mule.runtime.api.util.MultiMap<String,org.mule.runtime.api.metadata.TypedValue<?>>	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.DataType	getRequestBodyDataType()
protected abstract RestRequestBuilder	getRequestBuilder(String path) Return a RequestBuilder configured to do the request to the endpoint this source must poll.
protected org.mule.runtime.api.metadata.DataType	getWatermarkDataType()
void	onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,HttpResponseAttributes> result, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)
void	poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,HttpResponseAttributes> 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

connection

protected RestConnection connection

watermarkExpression

protected final String watermarkExpression

identityExpression

protected final String identityExpression

itemsExpression

protected final String itemsExpression

requestBodyExpression

protected final String requestBodyExpression

Constructor Detail

RestPollingSource

public RestPollingSource(String itemsExpression,
                         String watermarkExpression,
                         String identityExpression,
                         String requestBodyExpression)

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,HttpResponseAttributes>

Throws:

org.mule.runtime.api.exception.MuleException

doStop

protected void doStop()

Specified by:

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

getParameterBinding

protected abstract HttpRequestBinding getParameterBinding()

Returns the parameter binding configuration of this RestPollingSource.

getParameterValues

protected abstract org.mule.runtime.api.util.MultiMap<String,org.mule.runtime.api.metadata.TypedValue<?>> 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

getRequestBuilder

protected abstract RestRequestBuilder getRequestBuilder(String path)

Return a RequestBuilder configured to do the request to the endpoint this source must poll. BaseUri, Path and Method must be configured.

Parameters:

path - The request path with the placeholders replaced with its corresponding values.

getId

protected String getId()

poll

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

Specified by:

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

getWatermarkDataType

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

getRequestBodyDataType

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

onRejectedItem

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

Specified by:

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

getDefaultResponseMediaType

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