Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.runtime.source

Interface PollContext<T,A>

Type Parameters:

T - the generic type for the generated message's payload

A - the generic type for the generated message's attributes

@MinMuleVersion("4.1")
@NoImplement
public interface PollContext<T,A>

Contains context associated to each polling execution, and allows to dispatch items for execution through the accept(Consumer) method. Depending on how the supplied PollContext.PollItem is configured, the runtime will automatically apply watermarking, idempotency, etc.

Since:

1.1

See Also:

• PollContext.PollItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PollContext.PollItem<T,A>	An item obtained through a poll
static enum	PollContext.PollItemStatus	The possible outcomes of submiting an item for processing through the accept(Consumer) method

Method Summary

Modifier and Type	Method	Description
PollContext.PollItemStatus	accept(Consumer<PollContext.PollItem<T,A>> consumer)	Submits an item to be processed.
Optional<Serializable>	getWatermark()	The current watermark value at the moment of starting the poll.
boolean	isSourceStopping()	Whether the source has received the stopping signal.
void	onConnectionException(org.mule.runtime.api.connection.ConnectionException e)	Equivalent to SourceCallback.onConnectionException(ConnectionException).
void	setWatermarkComparator(Comparator<? extends Serializable> comparator)	Allows to set a custom Comparator to evaluate watermark values.

Method Details

accept

PollContext.PollItemStatus accept(Consumer<PollContext.PollItem<T,A>> consumer)

Submits an item to be processed. The runtime will supply a PollContext.PollItem in which the Result and other options will be set

Parameters:

consumer - a Consumer of a PollContext.PollItem

Returns:

a PollContext.PollItemStatus

getWatermark

Optional<Serializable> getWatermark()

The current watermark value at the moment of starting the poll. If watermarking is disabled or this is the first execution, the value will be Optional.empty()

Returns:

an optional watermark value

isSourceStopping

boolean isSourceStopping()

Whether the source has received the stopping signal. It is a good practice to check for this condition before engaging on a time consuming task.

Returns:

Whether the source has received the stopping signal or not.

setWatermarkComparator

void setWatermarkComparator(Comparator<? extends Serializable> comparator)

Allows to set a custom Comparator to evaluate watermark values. If not specified and Comparable values are used as watermarks, then this method is only optional. Otherwise, exceptions will be thrown if a proper comparator was not set.

Parameters:

comparator - a custom Comparator

Throws:

IllegalArgumentException - if the comparator is null

onConnectionException

void onConnectionException(org.mule.runtime.api.connection.ConnectionException e)

Equivalent to SourceCallback.onConnectionException(ConnectionException). Should be used in the same circumstances

Parameters:

e - a ConnectionException