Package org.apache.camel.builder.endpoint.dsl

Interface SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder, SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Enclosing interface:

SqlEndpointBuilderFactory

public static interface SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder
extends SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder, SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Advanced builder for endpoint for the SQL component.

Method Summary

Modifier and Type	Method	Description
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	alwaysPopulateStatement(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.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	alwaysPopulateStatement(String 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.
default SqlEndpointBuilderFactory.SqlEndpointBuilder	basic()
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	parametersCount(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.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	parametersCount(String parametersCount)	If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	placeholder(String placeholder)	Specifies a character that will be replaced to in SQL query.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	prepareStatementStrategy(String prepareStatementStrategy)	Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	prepareStatementStrategy(org.apache.camel.component.sql.SqlPrepareStatementStrategy prepareStatementStrategy)	Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	templateOptions(String key, Object value)	Configures the Spring JdbcTemplate with the key/values from the Map.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	templateOptions(Map values)	Configures the Spring JdbcTemplate with the key/values from the Map.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	usePlaceholder(boolean usePlaceholder)	Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries.
default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder	usePlaceholder(String usePlaceholder)	Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, pollStrategy, pollStrategy, processingStrategy, processingStrategy

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Method Detail

basic

default SqlEndpointBuilderFactory.SqlEndpointBuilder basic()

Specified by:

basic in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

basic in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

alwaysPopulateStatement

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder alwaysPopulateStatement(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. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

alwaysPopulateStatement in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

alwaysPopulateStatement in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

alwaysPopulateStatement - the value to set

Returns:

the dsl builder

alwaysPopulateStatement

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder alwaysPopulateStatement(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

alwaysPopulateStatement in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

alwaysPopulateStatement in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

alwaysPopulateStatement - the value to set

Returns:

the dsl builder

parametersCount

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder parametersCount(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. The option is a: <code>int</code> type. Group: advanced

Specified by:

parametersCount in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

parametersCount in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

parametersCount - the value to set

Returns:

the dsl builder

parametersCount

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder parametersCount(String 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. The option will be converted to a <code>int</code> type. Group: advanced

Specified by:

parametersCount in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

parametersCount in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

parametersCount - the value to set

Returns:

the dsl builder

placeholder

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder placeholder(String placeholder)

Specifies a character that will be replaced to in SQL query. Notice, that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). The option is a: <code>java.lang.String</code> type. Default: # Group: advanced

Specified by:

placeholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

placeholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

placeholder - the value to set

Returns:

the dsl builder

prepareStatementStrategy

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder prepareStatementStrategy(org.apache.camel.component.sql.SqlPrepareStatementStrategy prepareStatementStrategy)

Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. The option is a: <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> type. Group: advanced

Specified by:

prepareStatementStrategy in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

prepareStatementStrategy in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

prepareStatementStrategy - the value to set

Returns:

the dsl builder

prepareStatementStrategy

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder prepareStatementStrategy(String prepareStatementStrategy)

Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. The option will be converted to a <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> type. Group: advanced

Specified by:

prepareStatementStrategy in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

prepareStatementStrategy in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

prepareStatementStrategy - the value to set

Returns:

the dsl builder

templateOptions

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder templateOptions(String key,
                                                                             Object value)

Configures the Spring JdbcTemplate with the key/values from the Map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the templateOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

templateOptions in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

templateOptions in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

templateOptions

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder templateOptions(Map values)

Configures the Spring JdbcTemplate with the key/values from the Map. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the templateOptions(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

templateOptions in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

templateOptions in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

usePlaceholder

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder usePlaceholder(boolean usePlaceholder)

Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. The option is a: <code>boolean</code> type. Default: true Group: advanced

Specified by:

usePlaceholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

usePlaceholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

usePlaceholder - the value to set

Returns:

the dsl builder

usePlaceholder

default SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder usePlaceholder(String usePlaceholder)

Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Specified by:

usePlaceholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointConsumerBuilder

Specified by:

usePlaceholder in interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder

Parameters:

usePlaceholder - the value to set

Returns:

the dsl builder