org.apache.camel.impl

Class ScheduledPollEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultPollingEndpoint, GenericFileEndpoint, SchedulerEndpoint

public abstract class ScheduledPollEndpoint
extends DefaultEndpoint

A base class for Endpoint which creates a ScheduledPollConsumer

Version:

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
protected	ScheduledPollEndpoint()
protected	ScheduledPollEndpoint(String endpointUri) Deprecated.
protected	ScheduledPollEndpoint(String endpointUri, CamelContext context) Deprecated.
protected	ScheduledPollEndpoint(String endpointUri, Component component)

Method Summary

Modifier and Type	Method and Description
protected void	configurePollingConsumer(PollingConsumer consumer)
void	configureProperties(Map<String,Object> options) Configure properties on this endpoint.
protected void	configureScheduledPollConsumerProperties(Map<String,Object> options, Map<String,Object> consumerProperties)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
int	getBackoffErrorThreshold()
int	getBackoffIdleThreshold()
int	getBackoffMultiplier()
long	getDelay()
long	getInitialDelay()
PollingConsumerPollStrategy	getPollStrategy()
LoggingLevel	getRunLoggingLevel()
ScheduledExecutorService	getScheduledExecutorService()
ScheduledPollConsumerScheduler	getScheduler()
Map<String,Object>	getSchedulerProperties()
TimeUnit	getTimeUnit()
protected void	initConsumerProperties()
boolean	isGreedy()
boolean	isSendEmptyMessageWhenIdle()
boolean	isStartScheduler()
boolean	isUseFixedDelay()
void	setBackoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
void	setBackoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
void	setBackoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
void	setDelay(long delay) Milliseconds before the next poll.
void	setGreedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
void	setInitialDelay(long initialDelay) Milliseconds before the first poll starts.
void	setPollStrategy(PollingConsumerPollStrategy pollStrategy) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
void	setRunLoggingLevel(LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
void	setScheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
void	setScheduler(ScheduledPollConsumerScheduler scheduler) Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs.
void	setScheduler(String schedulerName) Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs.
void	setSchedulerProperties(Map<String,Object> schedulerProperties) To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
void	setSendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
void	setStartScheduler(boolean startScheduler) Whether the scheduler should be auto started.
void	setTimeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
void	setUseFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.

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

configureConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, 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.Endpoint

createConsumer, createProducer

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

ScheduledPollEndpoint

protected ScheduledPollEndpoint(String endpointUri,
                                Component component)

ScheduledPollEndpoint

@Deprecated
protected ScheduledPollEndpoint(String endpointUri,
                                            CamelContext context)

Deprecated.

ScheduledPollEndpoint

@Deprecated
protected ScheduledPollEndpoint(String endpointUri)

Deprecated.

ScheduledPollEndpoint

protected ScheduledPollEndpoint()

Method Detail

configureProperties

public void configureProperties(Map<String,Object> options)

Description copied from interface: Endpoint

Configure properties on this endpoint.

Specified by:

configureProperties in interface Endpoint

Overrides:

configureProperties in class DefaultEndpoint

Parameters:

options - the options (properties)

configureScheduledPollConsumerProperties

protected void configureScheduledPollConsumerProperties(Map<String,Object> options,
                                                        Map<String,Object> consumerProperties)

configurePollingConsumer

protected void configurePollingConsumer(PollingConsumer consumer)
                                 throws Exception

Overrides:

configurePollingConsumer in class DefaultEndpoint

Throws:

Exception

initConsumerProperties

protected void initConsumerProperties()

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()

isStartScheduler

public boolean isStartScheduler()

setStartScheduler

public void setStartScheduler(boolean startScheduler)

Whether the scheduler should be auto started.

getInitialDelay

public long getInitialDelay()

setInitialDelay

public void setInitialDelay(long initialDelay)

Milliseconds before the first poll starts.

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

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

Milliseconds before the next poll.

The default value is 500. 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

getTimeUnit

public TimeUnit getTimeUnit()

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

Time unit for initialDelay and delay options.

isUseFixedDelay

public boolean isUseFixedDelay()

setUseFixedDelay

public void setUseFixedDelay(boolean useFixedDelay)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

getPollStrategy

public PollingConsumerPollStrategy getPollStrategy()

setPollStrategy

public void setPollStrategy(PollingConsumerPollStrategy pollStrategy)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.

getRunLoggingLevel

public LoggingLevel getRunLoggingLevel()

setRunLoggingLevel

public void setRunLoggingLevel(LoggingLevel runLoggingLevel)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.

isSendEmptyMessageWhenIdle

public boolean isSendEmptyMessageWhenIdle()

setSendEmptyMessageWhenIdle

public void setSendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

isGreedy

public boolean isGreedy()

setGreedy

public void setGreedy(boolean greedy)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

getScheduler

public ScheduledPollConsumerScheduler getScheduler()

setScheduler

public void setScheduler(ScheduledPollConsumerScheduler scheduler)

Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2, and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay, useFixedDelay, timeUnit, and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text #myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.

setScheduler

public void setScheduler(String schedulerName)

Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. This option is used for referring to one of the built-in schedulers either spring, or quartz2. Using none refers to no scheduler to be used.

getSchedulerProperties

public Map<String,Object> getSchedulerProperties()

setSchedulerProperties

public void setSchedulerProperties(Map<String,Object> schedulerProperties)

To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

setScheduledExecutorService

public void setScheduledExecutorService(ScheduledExecutorService scheduledExecutorService)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.

getBackoffMultiplier

public int getBackoffMultiplier()

setBackoffMultiplier

public void setBackoffMultiplier(int backoffMultiplier)

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

getBackoffIdleThreshold

public int getBackoffIdleThreshold()

setBackoffIdleThreshold

public void setBackoffIdleThreshold(int backoffIdleThreshold)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

getBackoffErrorThreshold

public int getBackoffErrorThreshold()

setBackoffErrorThreshold

public void setBackoffErrorThreshold(int backoffErrorThreshold)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.