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

Class RestPollingSource<C extends RestConnection,S extends Serializable,A>

java.lang.Object

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

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

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

Type Parameters:

C - RestConnection type for connection.

S - Serializable type for watermark item.

A - Object type for attributes.

public abstract class RestPollingSource<C extends RestConnection,S extends Serializable,A>
extends org.mule.runtime.extension.api.runtime.source.PollingSource<InputStream,A>

Base class for implementing a PollingSource.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RestConfiguration	config
protected C	connection
protected org.mule.runtime.api.connection.ConnectionProvider<C>	connectionProvider
protected RestPollingSourceStrategy<S,A>	restPollingSourceStrategy

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

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
protected org.mule.runtime.api.metadata.MediaType	getDefaultResponseMediaType() This method specifies the MediaType that should be assumed the response to have in case the remote service doesn't specify a Content-Type header.
protected org.mule.runtime.api.el.ExpressionLanguage	getExpressionLanguage()
protected abstract org.mule.runtime.http.api.domain.message.request.HttpRequest	getRequest(Optional<S> lastWatermark) This method generates the http request to be executed for the polling source at each execution time
protected abstract RestPollingSourceStrategy<S,A>	getRestPollingSourceStrategy() This method specifies the RestPollingSourceStrategy that must be defined as the rest polling source strategy.
void	onRejectedItem(org.mule.runtime.extension.api.runtime.operation.Result<InputStream,A> result, org.mule.runtime.extension.api.runtime.source.SourceCallbackContext callbackContext)
void	poll(org.mule.runtime.extension.api.runtime.source.PollContext<InputStream,A> 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

connectionProvider

@Connection
protected org.mule.runtime.api.connection.ConnectionProvider<C extends RestConnection> connectionProvider

connection

protected C extends RestConnection connection

config

@Config
protected RestConfiguration config

restPollingSourceStrategy

protected RestPollingSourceStrategy<S extends Serializable,A> restPollingSourceStrategy

Constructor Detail

RestPollingSource

public RestPollingSource()

Method Detail

getExpressionLanguage

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

Returns:

The injected expression language

getRestPollingSourceStrategy

protected abstract RestPollingSourceStrategy<S,A> getRestPollingSourceStrategy()
                                                                        throws org.mule.runtime.api.exception.MuleException

This method specifies the RestPollingSourceStrategy that must be defined as the rest polling source strategy. The rest polling source strategy is needed to process the responses obtained from any SaaS

Returns:

the RestPollingSourceStrategy to be assigned as the strategy of current polling source

Throws:

org.mule.runtime.api.exception.MuleException

getDefaultResponseMediaType

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

This method specifies the MediaType that should be assumed the response to have in case the remote service doesn't specify a Content-Type header.
By default, this method returns the configuration media type since it's the most common response type. However, this method should be overwritten if a different type of media type is to be expected, or if you know that a certain encoding will be enforced.

Returns:

the MediaType to assign the response in case the server doesn't specify one in its response

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

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

poll

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

Specified by:

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

onRejectedItem

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

Specified by:

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

getRequest

protected abstract org.mule.runtime.http.api.domain.message.request.HttpRequest getRequest(Optional<S> lastWatermark)

This method generates the http request to be executed for the polling source at each execution time

Parameters:

lastWatermark - latest watermark obtained

Returns:

the HttpRequest to be executed