Package org.apache.camel.component.sql

Class SqlConsumer

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.ScheduledBatchPollingConsumer
org.apache.camel.component.sql.SqlConsumer
All Implemented Interfaces:
AutoCloseable, Runnable, org.apache.camel.BatchConsumer, 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.HostedService, org.apache.camel.spi.RouteIdAware, org.apache.camel.spi.ShutdownAware, org.apache.camel.spi.ShutdownPrepared, org.apache.camel.StatefulService, org.apache.camel.Suspendable, org.apache.camel.SuspendableService
public class SqlConsumer extends org.apache.camel.support.ScheduledBatchPollingConsumer

  • Field Summary

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

    maxMessagesPerPoll, pendingExchanges, shutdownRunningTask

    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
    SqlConsumer(DefaultSqlEndpoint endpoint, org.apache.camel.Processor processor, org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String query, SqlPrepareStatementStrategy sqlPrepareStatementStrategy, SqlProcessingStrategy sqlProcessingStrategy)
     
    SqlConsumer(DefaultSqlEndpoint endpoint, org.apache.camel.Processor processor, org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate namedJdbcTemplate, String query, org.springframework.jdbc.core.namedparam.SqlParameterSource parameterSource, SqlPrepareStatementStrategy sqlPrepareStatementStrategy, SqlProcessingStrategy sqlProcessingStrategy)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.camel.Exchange
    createExchange(Object data)
     
    protected void
    doInit()
     
    protected void
    doStart()
     
    DefaultSqlEndpoint
    getEndpoint()
     
    int
    getExpectedUpdateCount()
     
    String
    getOnConsume()
     
    String
    getOnConsumeBatchComplete()
     
    String
    getOnConsumeFailed()
     
    boolean
    isBreakBatchOnConsumeFail()
     
    boolean
    isRouteEmptyResultSet()
     
    boolean
    isUseIterator()
     
    protected int
    poll()
     
    int
    processBatch(Queue<Object> exchanges)
     
    void
    setAlwaysPopulateStatement(boolean alwaysPopulateStatement)
     
    void
    setBreakBatchOnConsumeFail(boolean breakBatchOnConsumeFail)
    Sets whether to break batch if onConsume failed.
    void
    setExpectedUpdateCount(int expectedUpdateCount)
    Sets an expected update count to validate when using onConsume.
    void
    setMaxMessagesPerPoll(int maxMessagesPerPoll)
     
    void
    setOnConsume(String onConsume)
    Sets a SQL to execute when the row has been successfully processed.
    void
    setOnConsumeBatchComplete(String onConsumeBatchComplete)
     
    void
    setOnConsumeFailed(String onConsumeFailed)
    Sets a SQL to execute when the row failed being processed.
    void
    setParametersCount(int parametersCount)
     
    void
    setRouteEmptyResultSet(boolean routeEmptyResultSet)
    Sets whether empty resultset should be allowed to be sent to the next hop. defaults to false.
    void
    setUseIterator(boolean useIterator)
    Sets how resultset should be delivered to route.

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

    deferShutdown, getMaxMessagesPerPoll, getPendingExchangesSize, isBatchAllowed, prepareShutdown, processEmptyMessage

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

    addLastErrorDetail, afterConfigureScheduler, afterPoll, beforePoll, doBuild, doShutdown, doStop, doSuspend, forceConsumerAsReady, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getCounter, getDelay, getErrorCounter, getInitialDelay, getLastError, getLastErrorDetails, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getSuccessCounter, getTimeUnit, initialHealthCheckState, isConsumerReady, isFirstPollDone, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, 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, getExceptionHandler, getHealthCheck, getProcessor, getRoute, getRouteId, handleException, handleException, handleException, isHostedService, releaseExchange, setExceptionHandler, setHealthCheck, setRoute, setRouteId, toString

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

    build, doFail, doLifecycleChange, doResume, fail, getInternalLock, 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.Consumer

    createExchange, defaultConsumerCallback, getProcessor, releaseExchange

    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

  • Method Details

    • getEndpoint

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

    • doInit

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

    • doStart

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

    • poll

      protected int poll() throws Exception
      Specified by:
      poll in class org.apache.camel.support.ScheduledPollConsumer
      Throws:
      Exception

    • createExchange

      protected org.apache.camel.Exchange createExchange(Object data)

    • processBatch

      public int processBatch(Queue<Object> exchanges) throws Exception
      Throws:
      Exception

    • getOnConsume

      public String getOnConsume()

    • setOnConsume

      public void setOnConsume(String onConsume)
      Sets a SQL to execute when the row has been successfully processed.

    • getOnConsumeFailed

      public String getOnConsumeFailed()

    • setOnConsumeFailed

      public void setOnConsumeFailed(String onConsumeFailed)
      Sets a SQL to execute when the row failed being processed.

    • getOnConsumeBatchComplete

      public String getOnConsumeBatchComplete()

    • setOnConsumeBatchComplete

      public void setOnConsumeBatchComplete(String onConsumeBatchComplete)

    • isUseIterator

      public boolean isUseIterator()

    • setUseIterator

      public void setUseIterator(boolean useIterator)
      Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true.

    • isRouteEmptyResultSet

      public boolean isRouteEmptyResultSet()

    • setRouteEmptyResultSet

      public void setRouteEmptyResultSet(boolean routeEmptyResultSet)
      Sets whether empty resultset should be allowed to be sent to the next hop. defaults to false. So the empty resultset will be filtered out.

    • getExpectedUpdateCount

      public int getExpectedUpdateCount()

    • setExpectedUpdateCount

      public void setExpectedUpdateCount(int expectedUpdateCount)
      Sets an expected update count to validate when using onConsume.

    • isBreakBatchOnConsumeFail

      public boolean isBreakBatchOnConsumeFail()

    • setBreakBatchOnConsumeFail

      public void setBreakBatchOnConsumeFail(boolean breakBatchOnConsumeFail)
      Sets whether to break batch if onConsume failed.

    • setMaxMessagesPerPoll

      public void setMaxMessagesPerPoll(int maxMessagesPerPoll)
      Specified by:
      setMaxMessagesPerPoll in interface org.apache.camel.BatchConsumer
      Overrides:
      setMaxMessagesPerPoll in class org.apache.camel.support.ScheduledBatchPollingConsumer

    • setParametersCount

      public void setParametersCount(int parametersCount)

    • setAlwaysPopulateStatement

      public void setAlwaysPopulateStatement(boolean alwaysPopulateStatement)