org.apache.camel.component.timer

Class TimerConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.component.timer.TimerConsumer

All Implemented Interfaces:

Consumer, EndpointAware, RouteAware, Service, ShutdownableService, StartupListener, StatefulService, Suspendable, SuspendableService

public class TimerConsumer
extends DefaultConsumer
implements StartupListener, Suspendable

The timer consumer.

Version:

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
TimerConsumer(TimerEndpoint endpoint, Processor processor)

Method Summary

Modifier and Type	Method and Description
protected void	configureTask(TimerTask task, Timer timer)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
TimerEndpoint	getEndpoint() Gets the endpoint associated with an object.
protected boolean	isTaskRunAllowed() Whether the timer task is allow to run or not
void	onCamelContextStarted(CamelContext context, boolean alreadyStarted) Callback invoked when the CamelContext is about to be fully started (not started yet).
protected void	sendTimerExchange(long counter)

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, doShutdown, doSuspend, 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.Service

start, stop

Constructor Detail

TimerConsumer

public TimerConsumer(TimerEndpoint endpoint,
                     Processor processor)

Method Detail

getEndpoint

public TimerEndpoint 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

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 DefaultConsumer

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 DefaultConsumer

Throws:

Exception

See Also:

ServiceSupport.doStart()

onCamelContextStarted

public void onCamelContextStarted(CamelContext context,
                                  boolean alreadyStarted)
                           throws Exception

Description copied from interface: StartupListener

Callback invoked when the CamelContext is about to be fully started (not started yet). Yes we are aware of the method name, but we can all have a bad-naming day.

Specified by:

onCamelContextStarted in interface StartupListener

Parameters:

context - the Camel context

alreadyStarted - whether or not the CamelContext already has been started. For example the context could already have been started, and then a service is added/started later which still triggers this callback to be invoked.

Throws:

Exception - can be thrown in case of errors to fail the startup process and have the application fail on startup.

isTaskRunAllowed

protected boolean isTaskRunAllowed()

Whether the timer task is allow to run or not

configureTask

protected void configureTask(TimerTask task,
                             Timer timer)

sendTimerExchange

protected void sendTimerExchange(long counter)