org.apache.camel.builder.endpoint.dsl

Interface JdbcEndpointBuilderFactory.JdbcEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

JdbcEndpointBuilderFactory

public static interface JdbcEndpointBuilderFactory.JdbcEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the JDBC component.

Method Summary

Modifier and Type	Method and Description
default JdbcEndpointBuilderFactory.AdvancedJdbcEndpointBuilder	advanced()
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	allowNamedParameters(boolean allowNamedParameters) Whether to allow using named parameters in the queries.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	allowNamedParameters(String allowNamedParameters) Whether to allow using named parameters in the queries.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	outputClass(String outputClass) Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	outputType(JdbcEndpointBuilderFactory.JdbcOutputType outputType) Determines the output the producer should use.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	outputType(String outputType) Determines the output the producer should use.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	parameters(Map values) Optional parameters to the java.sql.Statement.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	parameters(String key, Object value) Optional parameters to the java.sql.Statement.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	readSize(int readSize) The default maximum number of rows that can be read by a polling query.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	readSize(String readSize) The default maximum number of rows that can be read by a polling query.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	resetAutoCommit(boolean resetAutoCommit) Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	resetAutoCommit(String resetAutoCommit) Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	transacted(boolean transacted) Whether transactions are in use.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	transacted(String transacted) Whether transactions are in use.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useGetBytesForBlob(boolean useGetBytesForBlob) To read BLOB columns as bytes instead of string data.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useGetBytesForBlob(String useGetBytesForBlob) To read BLOB columns as bytes instead of string data.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useHeadersAsParameters(boolean useHeadersAsParameters) Set this option to true to use the prepareStatementStrategy with named parameters.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useHeadersAsParameters(String useHeadersAsParameters) Set this option to true to use the prepareStatementStrategy with named parameters.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useJDBC4ColumnNameAndLabelSemantics(boolean useJDBC4ColumnNameAndLabelSemantics) Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name.
default JdbcEndpointBuilderFactory.JdbcEndpointBuilder	useJDBC4ColumnNameAndLabelSemantics(String useJDBC4ColumnNameAndLabelSemantics) Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default JdbcEndpointBuilderFactory.AdvancedJdbcEndpointBuilder advanced()

allowNamedParameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder allowNamedParameters(boolean allowNamedParameters)

Whether to allow using named parameters in the queries. The option is a: boolean type. Default: true Group: producer

allowNamedParameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder allowNamedParameters(String allowNamedParameters)

Whether to allow using named parameters in the queries. The option will be converted to a boolean type. Default: true Group: producer

lazyStartProducer

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder 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: boolean type. Default: false Group: producer

lazyStartProducer

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder 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 boolean type. Default: false Group: producer

outputClass

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputClass(String outputClass)

Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. The option is a: java.lang.String type. Group: producer

outputType

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputType(JdbcEndpointBuilderFactory.JdbcOutputType outputType)

Determines the output the producer should use. The option is a: org.apache.camel.component.jdbc.JdbcOutputType type. Default: SelectList Group: producer

outputType

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder outputType(String outputType)

Determines the output the producer should use. The option will be converted to a org.apache.camel.component.jdbc.JdbcOutputType type. Default: SelectList Group: producer

parameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder parameters(String key,
                                                                  Object value)

Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer

parameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder parameters(Map values)

Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer

readSize

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder readSize(int readSize)

The default maximum number of rows that can be read by a polling query. The default value is 0. The option is a: int type. Group: producer

readSize

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder readSize(String readSize)

The default maximum number of rows that can be read by a polling query. The default value is 0. The option will be converted to a int type. Group: producer

resetAutoCommit

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder resetAutoCommit(boolean resetAutoCommit)

Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. The option is a: boolean type. Default: true Group: producer

resetAutoCommit

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder resetAutoCommit(String resetAutoCommit)

Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx. The option will be converted to a boolean type. Default: true Group: producer

transacted

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder transacted(boolean transacted)

Whether transactions are in use. The option is a: boolean type. Default: false Group: producer

transacted

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder transacted(String transacted)

Whether transactions are in use. The option will be converted to a boolean type. Default: false Group: producer

useGetBytesForBlob

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useGetBytesForBlob(boolean useGetBytesForBlob)

To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. The option is a: boolean type. Default: false Group: producer

useGetBytesForBlob

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useGetBytesForBlob(String useGetBytesForBlob)

To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes. The option will be converted to a boolean type. Default: false Group: producer

useHeadersAsParameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useHeadersAsParameters(boolean useHeadersAsParameters)

Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders. The option is a: boolean type. Default: false Group: producer

useHeadersAsParameters

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useHeadersAsParameters(String useHeadersAsParameters)

Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders. The option will be converted to a boolean type. Default: false Group: producer

useJDBC4ColumnNameAndLabelSemantics

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useJDBC4ColumnNameAndLabelSemantics(boolean useJDBC4ColumnNameAndLabelSemantics)

Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. The option is a: boolean type. Default: true Group: producer

useJDBC4ColumnNameAndLabelSemantics

default JdbcEndpointBuilderFactory.JdbcEndpointBuilder useJDBC4ColumnNameAndLabelSemantics(String useJDBC4ColumnNameAndLabelSemantics)

Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true. The option will be converted to a boolean type. Default: true Group: producer