Package org.apache.camel.support
Class DefaultScheduledPollConsumer
java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultConsumer
org.apache.camel.support.ScheduledPollConsumer
org.apache.camel.support.DefaultScheduledPollConsumer
- All Implemented Interfaces:
AutoCloseable
,Runnable
,org.apache.camel.Consumer
,org.apache.camel.EndpointAware
,org.apache.camel.health.HealthCheckAware
,org.apache.camel.PollingConsumerPollingStrategy
,org.apache.camel.RouteAware
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.RouteIdAware
,org.apache.camel.StatefulService
,org.apache.camel.Suspendable
,org.apache.camel.SuspendableService
A default implementation of an event driven
Consumer
which uses the PollingConsumer
-
Field Summary
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Constructor Summary
ConstructorDescriptionDefaultScheduledPollConsumer
(org.apache.camel.Endpoint endpoint, org.apache.camel.Processor processor, ScheduledExecutorService executor) DefaultScheduledPollConsumer
(DefaultEndpoint defaultEndpoint, org.apache.camel.Processor processor) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doBuild()
protected void
doInit()
protected void
doStart()
protected void
doStop()
int
protected int
poll()
The polling method which is invoked periodically to poll this consumervoid
setTimeout
(int timeout) Sets a timeout to use withPollingConsumer
.Methods inherited from class org.apache.camel.support.ScheduledPollConsumer
addLastErrorDetail, afterConfigureScheduler, afterPoll, beforePoll, doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getCounter, getDelay, getErrorCounter, getInitialDelay, getLastError, getLastErrorDetails, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getSuccessCounter, getTimeUnit, initialHealthCheckState, isFirstPollDone, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, processEmptyMessage, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler
Methods inherited from class org.apache.camel.support.DefaultConsumer
createExchange, createUoW, defaultConsumerCallback, doneUoW, getAsyncProcessor, getEndpoint, getExceptionHandler, getHealthCheck, getProcessor, getRoute, getRouteId, handleException, handleException, releaseExchange, setExceptionHandler, setHealthCheck, setRoute, setRouteId, toString
Methods inherited from class org.apache.camel.support.service.BaseService
build, doFail, doLifecycleChange, doResume, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.health.HealthCheckAware
getHealthCheck, setHealthCheck
Methods inherited from interface org.apache.camel.Service
build, close, init, start, stop
Methods inherited from interface org.apache.camel.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Constructor Details
-
DefaultScheduledPollConsumer
public DefaultScheduledPollConsumer(DefaultEndpoint defaultEndpoint, org.apache.camel.Processor processor) -
DefaultScheduledPollConsumer
public DefaultScheduledPollConsumer(org.apache.camel.Endpoint endpoint, org.apache.camel.Processor processor, ScheduledExecutorService executor)
-
-
Method Details
-
poll
Description copied from class:ScheduledPollConsumer
The polling method which is invoked periodically to poll this consumer- Specified by:
poll
in classScheduledPollConsumer
- Returns:
- number of messages polled, will be 0 if no message was polled at all.
- Throws:
Exception
- can be thrown if an exception occurred during polling
-
getTimeout
public int getTimeout() -
setTimeout
public void setTimeout(int timeout) Sets a timeout to use withPollingConsumer
.
Use timeout < 0 forPollingConsumer.receive()
.
Use timeout == 0 forPollingConsumer.receiveNoWait()
.
Use timeout > 0 forPollingConsumer.receive(long)
}.
The default timeout value is 0- Parameters:
timeout
- the timeout value
-
doBuild
- Overrides:
doBuild
in classScheduledPollConsumer
- Throws:
Exception
-
doInit
- Overrides:
doInit
in classScheduledPollConsumer
- Throws:
Exception
-
doStart
- Overrides:
doStart
in classScheduledPollConsumer
- Throws:
Exception
-
doStop
- Overrides:
doStop
in classScheduledPollConsumer
- Throws:
Exception
-