Package org.apache.camel.component.timer

Class TimerConsumer

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultConsumer
org.apache.camel.component.timer.TimerConsumer
All Implemented Interfaces:
AutoCloseable, org.apache.camel.Consumer, org.apache.camel.EndpointAware, org.apache.camel.health.HealthCheckAware, org.apache.camel.RouteAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.RouteIdAware, org.apache.camel.StartupListener, org.apache.camel.StatefulService, org.apache.camel.Suspendable, org.apache.camel.SuspendableService
@ManagedResource(description="Managed TimerConsumer") public class TimerConsumer extends org.apache.camel.support.DefaultConsumer implements org.apache.camel.StartupListener, org.apache.camel.Suspendable
The timer consumer.

  • 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

    Constructors
    Constructor
    Description
    TimerConsumer(TimerEndpoint endpoint, org.apache.camel.Processor processor)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    configureTask(TimerTask task, Timer timer)
     
    void
    doInit()
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    long
    getCounter()
    Total number of polls run
    long
    getDelay()
     
    TimerEndpoint
    getEndpoint()
     
    long
    getPeriod()
     
    long
    getRepeatCount()
     
    String
    getRunLoggingLevel()
     
    String
    getTimerName()
     
    boolean
    isFixedRate()
     
    boolean
    isPolling()
    Whether polling is currently in progress
    protected boolean
    isTaskRunAllowed()
    Whether the timer task is allow to run or not
    void
    onCamelContextStarted(org.apache.camel.CamelContext context, boolean alreadyStarted)
     
    protected void
    sendTimerExchange(long counter)
     

    Methods inherited from class org.apache.camel.support.DefaultConsumer

    createExchange, createUoW, defaultConsumerCallback, doBuild, doneUoW, doShutdown, getAsyncProcessor, getExceptionHandler, getHealthCheck, getProcessor, getRoute, getRouteId, handleException, handleException, handleException, releaseExchange, setExceptionHandler, setHealthCheck, setRoute, setRouteId, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doFail, doLifecycleChange, doResume, doSuspend, 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.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StartupListener

    onCamelContextFullyStarted, onCamelContextStarting

    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

    • TimerConsumer

      public TimerConsumer(TimerEndpoint endpoint, org.apache.camel.Processor processor)

  • Method Details

    • getEndpoint

      public TimerEndpoint getEndpoint()
      Specified by:
      getEndpoint in interface org.apache.camel.EndpointAware
      Overrides:
      getEndpoint in class org.apache.camel.support.DefaultConsumer

    • getCounter

      @ManagedAttribute(description="Total number of polls run") public long getCounter()
      Total number of polls run

    • isPolling

      @ManagedAttribute(description="Whether polling is currently in progress") public boolean isPolling()
      Whether polling is currently in progress

    • getTimerName

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

    • isFixedRate

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

    • getDelay

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

    • getPeriod

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

    • getRepeatCount

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

    • getRunLoggingLevel

      @ManagedAttribute(description="The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.") public String getRunLoggingLevel()

    • doInit

      public void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultConsumer
      Throws:
      Exception

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.apache.camel.support.DefaultConsumer
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.apache.camel.support.DefaultConsumer
      Throws:
      Exception

    • onCamelContextStarted

      public void onCamelContextStarted(org.apache.camel.CamelContext context, boolean alreadyStarted) throws Exception
      Specified by:
      onCamelContextStarted in interface org.apache.camel.StartupListener
      Throws:
      Exception

    • isTaskRunAllowed

      protected boolean isTaskRunAllowed()
      Whether the timer task is allow to run or not

    • configureTask

      protected void configureTask(TimerTask task, Timer timer)

    • sendTimerExchange

      protected void sendTimerExchange(long counter)