org.apache.camel.component.timer

Class TimerEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.timer.TimerEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, MultipleConsumersSupport, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@ManagedResource(description="Managed TimerEndpoint")
 @UriEndpoint(firstVersion="1.0.0",
             scheme="timer",
             title="Timer",
             syntax="timer:timerName",
             consumerOnly=true,
             consumerClass=TimerConsumer.class,
             label="core,scheduling")
public class TimerEndpoint
extends DefaultEndpoint
implements MultipleConsumersSupport

The timer component is used for generating message exchanges when a timer fires. This component is similar to the scheduler component, but has much less functionality.

Field Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TimerEndpoint()
protected	TimerEndpoint(String endpointUri, Component component)
	TimerEndpoint(String uri, Component component, String timerName)

Method Summary

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
TimerComponent	getComponent() Returns the component that created this endpoint.
long	getDelay()
String	getPattern()
long	getPeriod()
long	getRepeatCount()
Date	getTime()
Timer	getTimer(TimerConsumer consumer)
String	getTimerName()
boolean	isDaemon()
boolean	isFixedRate()
boolean	isMultipleConsumersSupported() Are multiple consumers supported?
boolean	isSingleton() Whether this class supports being singleton or not.
void	removeTimer(TimerConsumer consumer)
void	setDaemon(boolean daemon) Specifies whether or not the thread associated with the timer endpoint runs as a daemon.
void	setDelay(long delay) The number of milliseconds to wait before the first event is generated.
void	setFixedRate(boolean fixedRate) Events take place at approximately regular intervals, separated by the specified period.
void	setPattern(String pattern) Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.
void	setPeriod(long period) If greater than 0, generate periodic events every period milliseconds.
void	setRepeatCount(long repeatCount) Specifies a maximum limit of number of fires.
void	setTime(Date time) A java.util.Date the first event should be generated.
void	setTimer(Timer timer) To use a custom Timer
void	setTimerName(String timerName) The name of the timer

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

TimerEndpoint

public TimerEndpoint()

TimerEndpoint

public TimerEndpoint(String uri,
                     Component component,
                     String timerName)

TimerEndpoint

protected TimerEndpoint(String endpointUri,
                        Component component)

Method Detail

getComponent

public TimerComponent getComponent()

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

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 DefaultEndpoint

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 DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()

isMultipleConsumersSupported

@ManagedAttribute
public boolean isMultipleConsumersSupported()

Description copied from interface: MultipleConsumersSupport

Are multiple consumers supported?

Specified by:

isMultipleConsumersSupported in interface MultipleConsumersSupport

Returns:

true if multiple consumers are supported

getTimerName

@ManagedAttribute(description="Timer Name")
public String getTimerName()

setTimerName

@ManagedAttribute(description="Timer Name")
public void setTimerName(String timerName)

The name of the timer

isDaemon

@ManagedAttribute(description="Timer Daemon")
public boolean isDaemon()

setDaemon

@ManagedAttribute(description="Timer Daemon")
public void setDaemon(boolean daemon)

Specifies whether or not the thread associated with the timer endpoint runs as a daemon.

The default value is true.

getDelay

@ManagedAttribute(description="Timer Delay")
public long getDelay()

setDelay

@ManagedAttribute(description="Timer Delay")
public void setDelay(long delay)

The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option.

The default value is 1000. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour).

See Also:

human friendly syntax

isFixedRate

@ManagedAttribute(description="Timer FixedRate")
public boolean isFixedRate()

setFixedRate

@ManagedAttribute(description="Timer FixedRate")
public void setFixedRate(boolean fixedRate)

Events take place at approximately regular intervals, separated by the specified period.

getPeriod

@ManagedAttribute(description="Timer Period")
public long getPeriod()

setPeriod

@ManagedAttribute(description="Timer Period")
public void setPeriod(long period)

If greater than 0, generate periodic events every period milliseconds.

The default value is 1000. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour).

See Also:

human friendly syntax

getRepeatCount

@ManagedAttribute(description="Repeat Count")
public long getRepeatCount()

setRepeatCount

@ManagedAttribute(description="Repeat Count")
public void setRepeatCount(long repeatCount)

Specifies a maximum limit of number of fires. So if you set it to 1, the timer will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

getTime

public Date getTime()

setTime

public void setTime(Date time)

A java.util.Date the first event should be generated. If using the URI, the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss.

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.

getTimer

public Timer getTimer(TimerConsumer consumer)

setTimer

public void setTimer(Timer timer)

To use a custom Timer

removeTimer

public void removeTimer(TimerConsumer consumer)