org.apache.camel.component.sql

Class SqlEndpoint

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.sql.SqlEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="sql",
             syntax="sql:query",
             consumerClass=SqlConsumer.class,
             label="database,sql")
public class SqlEndpoint
extends org.apache.camel.impl.DefaultPollingEndpoint

SQL Endpoint. Endpoint URI should contain valid SQL statement, but instead of question marks (that are parameter placeholders), sharp signs should be used. This is because in camel question mark has other meaning.

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
SqlEndpoint()
SqlEndpoint(String uri, org.apache.camel.Component component, org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String query)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected String	createEndpointUri()
org.apache.camel.Producer	createProducer()
DataSource	getDataSource()
String	getDataSourceRef()
org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate()
int	getMaxMessagesPerPoll()
String	getOnConsume()
String	getOnConsumeBatchComplete()
String	getOnConsumeFailed()
String	getOutputClass()
String	getOutputHeader()
SqlOutputType	getOutputType()
int	getParametersCount()
SqlPrepareStatementStrategy	getPrepareStatementStrategy()
SqlProcessingStrategy	getProcessingStrategy()
String	getQuery()
char	getSeparator()
boolean	isAllowNamedParameters()
boolean	isAlwaysPopulateStatement()
boolean	isBatch()
boolean	isNoop()
boolean	isSingleton()
protected List<?>	queryForList(ResultSet rs, boolean allowMapToClass)
protected Object	queryForObject(ResultSet rs)
void	setAllowNamedParameters(boolean allowNamedParameters) Whether to allow using named parameters in the queries.
void	setAlwaysPopulateStatement(boolean alwaysPopulateStatement) If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared.
void	setBatch(boolean batch) Enables or disables batch mode
void	setDataSource(DataSource dataSource) Sets the DataSource to use to communicate with the database.
void	setDataSourceRef(String dataSourceRef) Sets the reference to a DataSource to lookup from the registry, to use for communicating with the database.
void	setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)
void	setMaxMessagesPerPoll(int maxMessagesPerPoll) Sets the maximum number of messages to poll
void	setNoop(boolean noop) If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing
void	setOnConsume(String onConsume) After processing each row then this query can be executed, if the Exchange was processed successfully, for example to mark the row as processed.
void	setOnConsumeBatchComplete(String onConsumeBatchComplete) After processing the entire batch, this query can be executed to bulk update rows etc.
void	setOnConsumeFailed(String onConsumeFailed) After processing each row then this query can be executed, if the Exchange failed, for example to mark the row as failed.
void	setOutputClass(String outputClass) Specify the full package and class name to use as conversion when outputType=SelectOne.
void	setOutputHeader(String outputHeader) Store the query result in a header instead of the message body.
void	setOutputType(SqlOutputType outputType) Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned.
void	setParametersCount(int parametersCount) If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API.
void	setPrepareStatementStrategy(SqlPrepareStatementStrategy prepareStatementStrategy) Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.
void	setProcessingStrategy(SqlProcessingStrategy processingStrategy) Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch.
void	setQuery(String query) Sets the SQL query to perform
void	setSeparator(char separator) The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders.

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, doStart, 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, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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

SqlEndpoint

public SqlEndpoint()

SqlEndpoint

public SqlEndpoint(String uri,
           org.apache.camel.Component component,
           org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
           String query)

Method Detail

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Overrides:

createConsumer in class org.apache.camel.impl.DefaultPollingEndpoint

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate()

setJdbcTemplate

public void setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

Sets the SQL query to perform

isBatch

public boolean isBatch()

setBatch

public void setBatch(boolean batch)

Enables or disables batch mode

getMaxMessagesPerPoll

public int getMaxMessagesPerPoll()

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(int maxMessagesPerPoll)

Sets the maximum number of messages to poll

getProcessingStrategy

public SqlProcessingStrategy getProcessingStrategy()

setProcessingStrategy

public void setProcessingStrategy(SqlProcessingStrategy processingStrategy)

Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch.

getPrepareStatementStrategy

public SqlPrepareStatementStrategy getPrepareStatementStrategy()

setPrepareStatementStrategy

public void setPrepareStatementStrategy(SqlPrepareStatementStrategy prepareStatementStrategy)

Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.

getOnConsume

public String getOnConsume()

setOnConsume

public void setOnConsume(String onConsume)

After processing each row then this query can be executed, if the Exchange was processed successfully, for example to mark the row as processed. The query can have parameter.

getOnConsumeFailed

public String getOnConsumeFailed()

setOnConsumeFailed

public void setOnConsumeFailed(String onConsumeFailed)

After processing each row then this query can be executed, if the Exchange failed, for example to mark the row as failed. The query can have parameter.

getOnConsumeBatchComplete

public String getOnConsumeBatchComplete()

setOnConsumeBatchComplete

public void setOnConsumeBatchComplete(String onConsumeBatchComplete)

After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters.

isAllowNamedParameters

public boolean isAllowNamedParameters()

setAllowNamedParameters

public void setAllowNamedParameters(boolean allowNamedParameters)

Whether to allow using named parameters in the queries.

isAlwaysPopulateStatement

public boolean isAlwaysPopulateStatement()

setAlwaysPopulateStatement

public void setAlwaysPopulateStatement(boolean alwaysPopulateStatement)

If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters.

getSeparator

public char getSeparator()

setSeparator

public void setSeparator(char separator)

The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead.

The default value is ,

getOutputType

public SqlOutputType getOutputType()

setOutputType

public void setOutputType(SqlOutputType outputType)

Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( * ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception.

getOutputClass

public String getOutputClass()

setOutputClass

public void setOutputClass(String outputClass)

Specify the full package and class name to use as conversion when outputType=SelectOne.

getParametersCount

public int getParametersCount()

setParametersCount

public void setParametersCount(int parametersCount)

If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead.

isNoop

public boolean isNoop()

setNoop

public void setNoop(boolean noop)

If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing

getOutputHeader

public String getOutputHeader()

setOutputHeader

public void setOutputHeader(String outputHeader)

Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved.

getDataSourceRef

public String getDataSourceRef()

setDataSourceRef

public void setDataSourceRef(String dataSourceRef)

Sets the reference to a DataSource to lookup from the registry, to use for communicating with the database.

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

Sets the DataSource to use to communicate with the database.

createEndpointUri

protected String createEndpointUri()

Overrides:

createEndpointUri in class org.apache.camel.impl.DefaultEndpoint

queryForList

protected List<?> queryForList(ResultSet rs,
                   boolean allowMapToClass)
                        throws SQLException

Throws:

SQLException

queryForObject

protected Object queryForObject(ResultSet rs)
                         throws SQLException

Throws:

SQLException