Package org.apache.camel.spi

Interface ScheduledPollConsumerScheduler

All Superinterfaces:

AutoCloseable, CamelContextAware, HasCamelContext, Service, ShutdownableService

public interface ScheduledPollConsumerScheduler
extends ShutdownableService, CamelContextAware

A pluggable scheduler for org.apache.camel.support.ScheduledPollConsumer consumers.

The default implementation org.apache.camel.support.DefaultScheduledPollConsumerScheduler is using the ScheduledExecutorService from the JDK to schedule and run the poll task.

An alternative implementation is in camel-quartz component that allows to use CRON expression to define when the scheduler should run.

Method Summary

Modifier and Type	Method	Description
boolean	isSchedulerStarted()	Whether the scheduler has been started.
void	onInit(Consumer consumer)	Initializes this ScheduledPollConsumerScheduler with the associated Consumer.
void	scheduleTask(Runnable task)	Schedules the task to run.
void	startScheduler()	Starts the scheduler.
void	unscheduleTask()	Attempts to unschedules the last task which was scheduled.

Methods inherited from interface org.apache.camel.CamelContextAware

setCamelContext

Methods inherited from interface org.apache.camel.spi.HasCamelContext

getCamelContext

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Method Details

onInit

void onInit(Consumer consumer)

Initializes this ScheduledPollConsumerScheduler with the associated Consumer.

Parameters:

consumer - the consumer.

scheduleTask

void scheduleTask(Runnable task)

Schedules the task to run.

Parameters:

task - the task to run.

unscheduleTask

void unscheduleTask()

Attempts to unschedules the last task which was scheduled.

An implementation may not implement this method.

startScheduler

void startScheduler()

Starts the scheduler.

If the scheduler is already started, then this is a noop method call.

isSchedulerStarted

boolean isSchedulerStarted()

Whether the scheduler has been started.

Returns:

true if started, false otherwise.