org.apache.camel.component.ibatis

Class IBatisComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.ibatis.IBatisComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class IBatisComponent
extends UriEndpointComponent

An Version:

 Ibatis Component used to read/write to a database.

 Requires one of the following:

 1. A Sql Map config file either on the root of
 the classpath or explicitly set.

 OR

 2. A SqlMapClient explicit set.

 Using Ibatis as a source of data (<from>) you can use this component
 to treat a database table as a logical queue.
 Details are available in the IBatisConsumer

 Using Ibatis as a destination for data (<to>) you can use this
 component to run an insert statement either on a single message or if the
 delivered content contains a collection of messages it can iterate through
 the collection and run the insert on each element.
 Details are available in the IBatisProducer
 

See Also:

IBatisProducer, IBatisConsumer

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
IBatisComponent()
IBatisComponent(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient)

Method Summary

Modifier and Type	Method and Description
protected IBatisEndpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
protected com.ibatis.sqlmap.client.SqlMapClient	createSqlMapClient()
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
com.ibatis.sqlmap.client.SqlMapClient	getSqlMapClient()
String	getSqlMapConfig()
boolean	isUseTransactions()
void	setSqlMapClient(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient) To use the given SqlMapClient
void	setSqlMapConfig(String sqlMapConfig) Location of iBatis xml configuration file.
void	setUseTransactions(boolean useTransactions) Whether to use transactions.

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IBatisComponent

public IBatisComponent()

IBatisComponent

public IBatisComponent(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient)

Method Detail

createEndpoint

protected IBatisEndpoint createEndpoint(String uri,
                                        String remaining,
                                        Map<String,Object> parameters)
                                 throws Exception

Description copied from class: DefaultComponent

A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:

createEndpoint in class DefaultComponent

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - is thrown if error creating the endpoint

createSqlMapClient

protected com.ibatis.sqlmap.client.SqlMapClient createSqlMapClient()
                                                            throws IOException

Throws:

IOException

getSqlMapClient

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

setSqlMapClient

public void setSqlMapClient(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient)

To use the given SqlMapClient

getSqlMapConfig

public String getSqlMapConfig()

setSqlMapConfig

public void setSqlMapConfig(String sqlMapConfig)

Location of iBatis xml configuration file.

The default value is: SqlMapConfig.xml loaded from the classpath

isUseTransactions

public boolean isUseTransactions()

setUseTransactions

public void setUseTransactions(boolean useTransactions)

Whether to use transactions.

This option is by default true.

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 DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()