org.apache.camel.builder.endpoint.dsl

Interface CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

CouchDbEndpointBuilderFactory.CouchDbEndpointBuilder

Enclosing interface:

CouchDbEndpointBuilderFactory

public static interface CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the CouchDB component.

Method Summary

Modifier and Type	Method and Description
default CouchDbEndpointBuilderFactory.AdvancedCouchDbEndpointProducerBuilder	advanced()
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	createDatabase(boolean createDatabase) Creates the database if it does not already exist.
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	createDatabase(String createDatabase) Creates the database if it does not already exist.
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	password(String password) Password for authenticated databases.
default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder	username(String username) Username in case of authenticated databases.

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 CouchDbEndpointBuilderFactory.AdvancedCouchDbEndpointProducerBuilder advanced()

createDatabase

default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder createDatabase(boolean createDatabase)

Creates the database if it does not already exist. The option is a: <code>boolean</code> type. Default: false Group: common

Parameters:

createDatabase - the value to set

Returns:

the dsl builder

createDatabase

default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder createDatabase(String createDatabase)

Creates the database if it does not already exist. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Parameters:

createDatabase - the value to set

Returns:

the dsl builder

lazyStartProducer

default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder 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 CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder 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

password

default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder password(String password)

Password for authenticated databases. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder

username

default CouchDbEndpointBuilderFactory.CouchDbEndpointProducerBuilder username(String username)

Username in case of authenticated databases. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

username - the value to set

Returns:

the dsl builder