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(scheme="timer",
             consumerClass=TimerConsumer.class)
public class TimerEndpoint
extends DefaultEndpoint
implements MultipleConsumersSupport

Represents a timer endpoint that can generate periodic inbound exchanges triggered by a timer.

Version:

Field Summary

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

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

Constructor Summary

TimerEndpoint()

TimerEndpoint(String uri, Component component, String timerName)

Method Summary

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.
String	getCamelId()
String	getCamelManagementName()
long	getDelay()
String	getEndpointUri() Returns the string representation of the endpoint URI
long	getPeriod()
long	getRepeatCount()
String	getState()
Date	getTime()
Timer	getTimer()
String	getTimerName()
boolean	isDaemon()
boolean	isFixedRate()
boolean	isMultipleConsumersSupported() Are multiple consumers supported?
boolean	isSingleton() Whether this class supports being singleton or not.
void	setDaemon(boolean daemon)
void	setDelay(long delay)
void	setFixedRate(boolean fixedRate)
void	setPeriod(long period)
void	setRepeatCount(long repeatCount)
void	setTime(Date time)
void	setTimer(Timer timer)
void	setTimerName(String timerName)

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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)

Method Detail

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

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)

isDaemon

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

setDaemon

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

getDelay

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

setDelay

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

isFixedRate

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

setFixedRate

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

getPeriod

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

setPeriod

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

getRepeatCount

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

setRepeatCount

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

getTime

public Date getTime()

setTime

public void setTime(Date time)

isSingleton

@ManagedAttribute(description="Singleton")
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.

getTimer

public Timer getTimer()

setTimer

public void setTimer(Timer timer)

getCamelId

@ManagedAttribute(description="Camel id")
public String getCamelId()

getCamelManagementName

@ManagedAttribute(description="Camel ManagementName")
public String getCamelManagementName()

getEndpointUri

@ManagedAttribute(description="Endpoint Uri")
public String getEndpointUri()

Description copied from interface: Endpoint

Returns the string representation of the endpoint URI

Specified by:

getEndpointUri in interface Endpoint

Overrides:

getEndpointUri in class DefaultEndpoint

Returns:

the endpoint URI

getState

@ManagedAttribute(description="Endpoint State")
public String getState()