org.apache.camel.component.ibatis

Class IBatisConsumer

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultConsumer

org.apache.camel.impl.ScheduledPollConsumer

org.apache.camel.impl.ScheduledBatchPollingConsumer

org.apache.camel.component.ibatis.IBatisConsumer

All Implemented Interfaces:

Runnable, BatchConsumer, Consumer, EndpointAware, PollingConsumerPollingStrategy, RouteAware, Service, ShutdownableService, ShutdownAware, ShutdownPrepared, StatefulService, Suspendable, SuspendableService

public class IBatisConsumer
extends ScheduledBatchPollingConsumer

Consumer to read data from databaase.

See Also:

IBatisProcessingStrategy

Field Summary

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

pendingExchanges, shutdownRunningTask

Fields inherited from class org.apache.camel.impl.DefaultConsumer

log

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

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

Constructor Summary

Constructors

Constructor and Description
IBatisConsumer(IBatisEndpoint endpoint, Processor processor)

Method Summary

Modifier and Type	Method and Description
IBatisEndpoint	getEndpoint() Gets the endpoint associated with an object.
String	getOnConsume() Gets the statement(s) to run after successful processing.
boolean	isRouteEmptyResultSet() Indicates whether empty resultset should be allowed to be sent to the next hop or not
boolean	isUseIterator() Indicates how resultset should be delivered to the route
protected int	poll() Polls the database
int	processBatch(Queue<Object> exchanges) Processes the list of Exchange objects in a batch.
void	setOnConsume(String onConsume) Sets the statement to run after successful processing.
void	setRouteEmptyResultSet(boolean routeEmptyResultSet) Sets whether empty resultset should be allowed to be sent to the next hop.
void	setUseIterator(boolean useIterator) Sets how resultset should be delivered to route.

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

deferShutdown, getMaxMessagesPerPoll, getPendingExchangesSize, isBatchAllowed, prepareShutdown, processEmptyMessage, setMaxMessagesPerPoll

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

afterPoll, beforePoll, doShutdown, doStart, doStop, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler

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

createUoW, doneUoW, getAsyncProcessor, getExceptionHandler, getProcessor, getRoute, handleException, handleException, setExceptionHandler, setRoute, toString

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

doResume, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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

start, stop

Constructor Detail

IBatisConsumer

public IBatisConsumer(IBatisEndpoint endpoint,
                      Processor processor)
               throws Exception

Throws:

Exception

Method Detail

getEndpoint

public IBatisEndpoint getEndpoint()

Description copied from interface: EndpointAware

Gets the endpoint associated with an object. It's the endpoint for sending to for components like Producer or for consuming from for components like Consumer or Route

Specified by:

getEndpoint in interface EndpointAware

Overrides:

getEndpoint in class DefaultConsumer

Returns:

the endpoint

poll

protected int poll()
            throws Exception

Polls the database

Specified by:

poll in class ScheduledPollConsumer

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

processBatch

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

Description copied from interface: BatchConsumer

Processes the list of Exchange objects in a batch.

Each message exchange will be processed individually but the batch consumer will add properties with the current index and total in the batch. The items in the Queue may actually be Holder objects that store other data alongside the Exchange.

Parameters:

exchanges - list of items in this batch

Returns:

number of messages actually processed

Throws:

Exception - if an internal processing error has occurred.

getOnConsume

public String getOnConsume()

Gets the statement(s) to run after successful processing. Use comma to separate multiple statements.

setOnConsume

public void setOnConsume(String onConsume)

Sets the statement to run after successful processing. Use comma to separate multiple statements.

isUseIterator

public boolean isUseIterator()

Indicates how resultset should be delivered to the route

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

Indicates whether empty resultset should be allowed to be sent to the next hop or not

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.