org.apache.camel.builder.endpoint.dsl

Interface SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

SpringJdbcEndpointBuilderFactory

public static interface SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the Spring JDBC component.

Method Summary

Modifier and Type	Method and Description
default SpringJdbcEndpointBuilderFactory.AdvancedSpringJdbcEndpointBuilder	advanced()
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	allowNamedParameters(boolean allowNamedParameters) Whether to allow using named parameters in the queries.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	allowNamedParameters(String allowNamedParameters) Whether to allow using named parameters in the queries.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	outputClass(String outputClass) Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	outputType(SpringJdbcEndpointBuilderFactory.JdbcOutputType outputType) Determines the output the producer should use.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	outputType(String outputType) Determines the output the producer should use.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	parameters(Map values) Optional parameters to the java.sql.Statement.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	parameters(String key, Object value) Optional parameters to the java.sql.Statement.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	readSize(int readSize) The default maximum number of rows that can be read by a polling query.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	readSize(String readSize) The default maximum number of rows that can be read by a polling query.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	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 SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	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 SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	transacted(boolean transacted) Whether transactions are in use.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	transacted(String transacted) Whether transactions are in use.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	useGetBytesForBlob(boolean useGetBytesForBlob) To read BLOB columns as bytes instead of string data.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	useGetBytesForBlob(String useGetBytesForBlob) To read BLOB columns as bytes instead of string data.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	useHeadersAsParameters(boolean useHeadersAsParameters) Set this option to true to use the prepareStatementStrategy with named parameters.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	useHeadersAsParameters(String useHeadersAsParameters) Set this option to true to use the prepareStatementStrategy with named parameters.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	useJDBC4ColumnNameAndLabelSemantics(boolean useJDBC4ColumnNameAndLabelSemantics) Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name.
default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder	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 SpringJdbcEndpointBuilderFactory.AdvancedSpringJdbcEndpointBuilder advanced()

allowNamedParameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder allowNamedParameters(boolean allowNamedParameters)

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

Parameters:

allowNamedParameters - the value to set

Returns:

the dsl builder

allowNamedParameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder allowNamedParameters(String allowNamedParameters)

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

Parameters:

allowNamedParameters - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

outputClass

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder outputClass(String outputClass)

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

Parameters:

outputClass - the value to set

Returns:

the dsl builder

outputType

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder outputType(SpringJdbcEndpointBuilderFactory.JdbcOutputType outputType)

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

Parameters:

outputType - the value to set

Returns:

the dsl builder

outputType

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder outputType(String outputType)

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

Parameters:

outputType - the value to set

Returns:

the dsl builder

parameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder parameters(String key,
                                                                              Object value)

Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. 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 parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

parameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder parameters(Map values)

Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc. 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 parameters(String, Object) method to add a value (call the method multiple times to set more values). Group: producer

Parameters:

values - the values

Returns:

the dsl builder

readSize

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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: <code>int</code> type. Group: producer

Parameters:

readSize - the value to set

Returns:

the dsl builder

readSize

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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 <code>int</code> type. Group: producer

Parameters:

readSize - the value to set

Returns:

the dsl builder

resetAutoCommit

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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: <code>boolean</code> type. Default: true Group: producer

Parameters:

resetAutoCommit - the value to set

Returns:

the dsl builder

resetAutoCommit

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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 <code>boolean</code> type. Default: true Group: producer

Parameters:

resetAutoCommit - the value to set

Returns:

the dsl builder

transacted

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder transacted(boolean transacted)

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

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder transacted(String transacted)

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

Parameters:

transacted - the value to set

Returns:

the dsl builder

useGetBytesForBlob

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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: <code>boolean</code> type. Default: false Group: producer

Parameters:

useGetBytesForBlob - the value to set

Returns:

the dsl builder

useGetBytesForBlob

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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 <code>boolean</code> type. Default: false Group: producer

Parameters:

useGetBytesForBlob - the value to set

Returns:

the dsl builder

useHeadersAsParameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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: <code>boolean</code> type. Default: false Group: producer

Parameters:

useHeadersAsParameters - the value to set

Returns:

the dsl builder

useHeadersAsParameters

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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 <code>boolean</code> type. Default: false Group: producer

Parameters:

useHeadersAsParameters - the value to set

Returns:

the dsl builder

useJDBC4ColumnNameAndLabelSemantics

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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: <code>boolean</code> type. Default: true Group: producer

Parameters:

useJDBC4ColumnNameAndLabelSemantics - the value to set

Returns:

the dsl builder

useJDBC4ColumnNameAndLabelSemantics

default SpringJdbcEndpointBuilderFactory.SpringJdbcEndpointBuilder 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 <code>boolean</code> type. Default: true Group: producer

Parameters:

useJDBC4ColumnNameAndLabelSemantics - the value to set

Returns:

the dsl builder