Interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
SqlEndpointBuilderFactory.AdvancedSqlEndpointBuilder
- Enclosing interface:
- SqlEndpointBuilderFactory
public static interface SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the SQL component.
-
Method Summary
Modifier and TypeMethodDescriptionalwaysPopulateStatement
(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.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.basic()
lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).lazyStartProducer
(String lazyStartProducer) Whether the producer should be started lazy (on the first message).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.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.placeholder
(String placeholder) Specifies a character that will be replaced to in SQL query.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.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.rowMapperFactory
(String rowMapperFactory) Factory for creating RowMapper.rowMapperFactory
(org.apache.camel.component.sql.RowMapperFactory rowMapperFactory) Factory for creating RowMapper.templateOptions
(String key, Object value) Configures the Spring JdbcTemplate with the key/values from the Map.templateOptions
(Map values) Configures the Spring JdbcTemplate with the key/values from the Map.usePlaceholder
(boolean usePlaceholder) Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries.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.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
basic
-
lazyStartProducer
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
alwaysPopulateStatement
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
alwaysPopulateStatement
- the value to set- Returns:
- the dsl builder
-
alwaysPopulateStatement
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
alwaysPopulateStatement
- the value to set- Returns:
- the dsl builder
-
parametersCount
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
parametersCount
- the value to set- Returns:
- the dsl builder
-
parametersCount
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
parametersCount
- the value to set- Returns:
- the dsl builder
-
placeholder
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
placeholder
- the value to set- Returns:
- the dsl builder
-
prepareStatementStrategy
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
prepareStatementStrategy
- the value to set- Returns:
- the dsl builder
-
prepareStatementStrategy
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
prepareStatementStrategy
- the value to set- Returns:
- the dsl builder
-
rowMapperFactory
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder rowMapperFactory(org.apache.camel.component.sql.RowMapperFactory rowMapperFactory) Factory for creating RowMapper. The option is a: <code>org.apache.camel.component.sql.RowMapperFactory</code> type. Group: advanced- Parameters:
rowMapperFactory
- the value to set- Returns:
- the dsl builder
-
rowMapperFactory
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder rowMapperFactory(String rowMapperFactory) Factory for creating RowMapper. The option will be converted to a <code>org.apache.camel.component.sql.RowMapperFactory</code> type. Group: advanced- Parameters:
rowMapperFactory
- the value to set- Returns:
- the dsl builder
-
templateOptions
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder templateOptions(String key, Object value) Configures the Spring JdbcTemplate with the key/values from the Map. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></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- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
templateOptions
Configures the Spring JdbcTemplate with the key/values from the Map. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></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- Parameters:
values
- the values- Returns:
- the dsl builder
-
usePlaceholder
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
usePlaceholder
- the value to set- Returns:
- the dsl builder
-
usePlaceholder
default SqlEndpointBuilderFactory.AdvancedSqlEndpointProducerBuilder 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- Parameters:
usePlaceholder
- the value to set- Returns:
- the dsl builder
-