org.apache.camel.component.ibatis

Class IBatisEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

org.apache.camel.component.ibatis.IBatisEndpoint

All Implemented Interfaces:

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

@UriEndpoint(scheme="ibatis",
             title="iBatis",
             syntax="ibatis:statement",
             consumerClass=IBatisConsumer.class,
             label="database,sql")
public class IBatisEndpoint
extends DefaultPollingEndpoint

Performs a query, poll, insert, update or delete in a relational database using Apache iBATIS.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
IBatisEndpoint()
IBatisEndpoint(String uri, IBatisComponent component, String statement)

Method Summary

Modifier and Type	Method and Description
IBatisConsumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
IBatisComponent	getComponent() Returns the component that created this endpoint.
String	getIsolation()
int	getMaxMessagesPerPoll()
String	getOnConsume()
IBatisProcessingStrategy	getProcessingStrategy()
com.ibatis.sqlmap.client.SqlMapClient	getSqlMapClient()
String	getStatement()
StatementType	getStatementType()
boolean	isRouteEmptyResultSet()
boolean	isSingleton() Whether this class supports being singleton or not.
boolean	isUseIterator()
boolean	isUseTransactions()
void	setIsolation(String isolation) Transaction isolation level
void	setMaxMessagesPerPoll(int maxMessagesPerPoll) This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges.
void	setOnConsume(String onConsume) Statement to run after data has been processed in the route
void	setRouteEmptyResultSet(boolean routeEmptyResultSet) Whether allow empty resultset to be routed to the next hop
void	setStatement(String statement) The statement name in the iBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate.
void	setStatementType(StatementType statementType) Mandatory to specify for the producer to control which kind of operation to invoke.
void	setStrategy(IBatisProcessingStrategy strategy) Allows to plugin a custom IBatisProcessingStrategy to use by the consumer.
void	setUseIterator(boolean useIterator) Process resultset individually or as a list
void	setUseTransactions(boolean useTransactions) Whether to use transactions.

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

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

start, stop

Constructor Detail

IBatisEndpoint

public IBatisEndpoint()

IBatisEndpoint

public IBatisEndpoint(String uri,
                      IBatisComponent component,
                      String statement)
               throws Exception

Throws:

Exception

Method Detail

getComponent

public IBatisComponent getComponent()

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public IBatisConsumer createConsumer(Processor processor)
                              throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Overrides:

createConsumer in class DefaultPollingEndpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

getSqlMapClient

public com.ibatis.sqlmap.client.SqlMapClient getSqlMapClient()
                                                      throws IOException

Throws:

IOException

getProcessingStrategy

public IBatisProcessingStrategy getProcessingStrategy()
                                               throws Exception

Throws:

Exception

setStrategy

public void setStrategy(IBatisProcessingStrategy strategy)

Allows to plugin a custom IBatisProcessingStrategy to use by the consumer.

getStatement

public String getStatement()

setStatement

public void setStatement(String statement)

The statement name in the iBatis XML mapping file which maps to the query, insert, update or delete operation you wish to evaluate.

isUseTransactions

public boolean isUseTransactions()

setUseTransactions

public void setUseTransactions(boolean useTransactions)

Whether to use transactions.

This option is by default true.

getStatementType

public StatementType getStatementType()

setStatementType

public void setStatementType(StatementType statementType)

Mandatory to specify for the producer to control which kind of operation to invoke.

getMaxMessagesPerPoll

public int getMaxMessagesPerPoll()

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(int maxMessagesPerPoll)

This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it.

getIsolation

public String getIsolation()
                    throws Exception

Throws:

Exception

setIsolation

public void setIsolation(String isolation)
                  throws Exception

Transaction isolation level

Throws:

Exception

getOnConsume

public String getOnConsume()

setOnConsume

public void setOnConsume(String onConsume)

Statement to run after data has been processed in the route

isUseIterator

public boolean isUseIterator()

setUseIterator

public void setUseIterator(boolean useIterator)

Process resultset individually or as a list

isRouteEmptyResultSet

public boolean isRouteEmptyResultSet()

setRouteEmptyResultSet

public void setRouteEmptyResultSet(boolean routeEmptyResultSet)

Whether allow empty resultset to be routed to the next hop

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 ScheduledPollEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()