org.apache.camel.builder.endpoint.dsl

Interface GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

GridFsEndpointBuilderFactory.GridFsEndpointBuilder

Enclosing interface:

GridFsEndpointBuilderFactory

public static interface GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the MongoDB GridFS component.

Method Summary

Modifier and Type	Method and Description
default GridFsEndpointBuilderFactory.AdvancedGridFsEndpointProducerBuilder	advanced()
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	bucket(String bucket) Sets the name of the GridFS bucket within the database.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	database(String database) Sets the name of the MongoDB database to target.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	operation(String operation) Sets the operation this endpoint will execute against GridFs.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	readPreference(Object readPreference) Sets a MongoDB ReadPreference on the Mongo connection.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	readPreference(String readPreference) Sets a MongoDB ReadPreference on the Mongo connection.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	writeConcern(Object writeConcern) Set the WriteConcern for write operations on MongoDB using the standard ones.
default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder	writeConcern(String writeConcern) Set the WriteConcern for write operations on MongoDB using the standard ones.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default GridFsEndpointBuilderFactory.AdvancedGridFsEndpointProducerBuilder advanced()

bucket

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder bucket(String bucket)

Sets the name of the GridFS bucket within the database. Default is fs. The option is a: <code>java.lang.String</code> type. Default: fs Group: common

Parameters:

bucket - the value to set

Returns:

the dsl builder

database

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder database(String database)

Sets the name of the MongoDB database to target. The option is a: <code>java.lang.String</code> type. Required: true Group: common

Parameters:

database - the value to set

Returns:

the dsl builder

readPreference

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder readPreference(Object readPreference)

Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The com.mongodb.ReadPreference#valueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest, primary or secondary etc. The option is a: <code>com.mongodb.ReadPreference</code> type. Group: common

Parameters:

readPreference - the value to set

Returns:

the dsl builder

readPreference

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder readPreference(String readPreference)

Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The com.mongodb.ReadPreference#valueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest, primary or secondary etc. The option will be converted to a <code>com.mongodb.ReadPreference</code> type. Group: common

Parameters:

readPreference - the value to set

Returns:

the dsl builder

writeConcern

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder writeConcern(Object writeConcern)

Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the WriteConcern#valueOf(String) method. The option is a: <code>com.mongodb.WriteConcern</code> type. Group: common

Parameters:

writeConcern - the value to set

Returns:

the dsl builder

writeConcern

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder writeConcern(String writeConcern)

Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the WriteConcern#valueOf(String) method. The option will be converted to a <code>com.mongodb.WriteConcern</code> type. Group: common

Parameters:

writeConcern - the value to set

Returns:

the dsl builder

lazyStartProducer

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder 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 GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder 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

operation

default GridFsEndpointBuilderFactory.GridFsEndpointProducerBuilder operation(String operation)

Sets the operation this endpoint will execute against GridFs. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder