org.apache.camel.component.scheduler

Class SchedulerEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.component.scheduler.SchedulerEndpoint

All Implemented Interfaces:

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

@UriEndpoint(scheme="scheduler",
             title="Scheduler",
             syntax="scheduler:name",
             consumerOnly=true,
             consumerClass=SchedulerConsumer.class,
             label="core,scheduling")
public class SchedulerEndpoint
extends ScheduledPollEndpoint

The scheduler component is used for generating message exchanges when a scheduler fires. This component is similar to the timer component, but it offers more functionality in terms of scheduling. Also this component uses JDK ScheduledExecutorService. Where as the timer uses a JDK Timer.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
SchedulerEndpoint(String uri, SchedulerComponent component, String remaining)

Method Summary

Methods

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
SchedulerComponent	getComponent() Returns the component that created this endpoint.
int	getConcurrentTasks()
String	getName()
boolean	isSingleton() Whether this class supports being singleton or not.
void	onConsumerStart(SchedulerConsumer consumer)
void	onConsumerStop(SchedulerConsumer consumer)
void	setConcurrentTasks(int concurrentTasks) Number of threads used by the scheduling thread pool.
void	setName(String name) The name of the scheduler

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, doStart, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

configureConsumer, 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

SchedulerEndpoint

public SchedulerEndpoint(String uri,
                 SchedulerComponent component,
                 String remaining)

Method Detail

getComponent

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

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

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.

Returns:

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

getName

public String getName()

setName

public void setName(String name)

The name of the scheduler

getConcurrentTasks

public int getConcurrentTasks()

setConcurrentTasks

public void setConcurrentTasks(int concurrentTasks)

Number of threads used by the scheduling thread pool.

Is by default using a single thread

onConsumerStart

public void onConsumerStart(SchedulerConsumer consumer)

onConsumerStop

public void onConsumerStop(SchedulerConsumer consumer)