org.apache.camel.component.scheduler

Class SchedulerConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.impl.ScheduledPollConsumer

org.apache.camel.component.scheduler.SchedulerConsumer

All Implemented Interfaces:

Runnable, Consumer, EndpointAware, PollingConsumerPollingStrategy, RouteAware, Service, ShutdownableService, StatefulService, SuspendableService

public class SchedulerConsumer
extends ScheduledPollConsumer

Field Summary

Fields inherited from class org.apache.camel.impl.DefaultConsumer

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
SchedulerConsumer(SchedulerEndpoint endpoint, Processor processor)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
SchedulerEndpoint	getEndpoint() Gets the endpoint associated with an object.
protected int	poll() The polling method which is invoked periodically to poll this consumer
protected int	sendTimerExchange()

Methods inherited from class org.apache.camel.impl.ScheduledPollConsumer

afterPoll, beforePoll, doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, processEmptyMessage, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler

Methods inherited from class org.apache.camel.impl.DefaultConsumer

createUoW, doneUoW, getAsyncProcessor, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

SchedulerConsumer

public SchedulerConsumer(SchedulerEndpoint endpoint,
                 Processor processor)

Method Detail

getEndpoint

public SchedulerEndpoint getEndpoint()

Description copied from interface: EndpointAware

Gets the endpoint associated with an object. It's the endpoint for sending to for components like Producer or for consuming from for components like Consumer or Route

Specified by:

getEndpoint in interface EndpointAware

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint

poll

protected int poll()
            throws Exception

Description copied from class: ScheduledPollConsumer

The polling method which is invoked periodically to poll this consumer

Specified by:

poll in class ScheduledPollConsumer

Returns:

number of messages polled, will be 0 if no message was polled at all.

Throws:

Exception - can be thrown if an exception occurred during polling

sendTimerExchange

protected int sendTimerExchange()

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class ScheduledPollConsumer

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class ScheduledPollConsumer

Throws:

Exception

See Also:

ServiceSupport.doStart()