org.apache.camel.builder.endpoint.dsl

Interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder, MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Enclosing interface:

MongoDbEndpointBuilderFactory

public static interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder
extends MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder, MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Advanced builder for endpoint for the MongoDB component.

Method Summary

Modifier and Type	Method and Description
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	basic()
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	cursorRegenerationDelay(long cursorRegenerationDelay) MongoDB tailable cursors will block until new data arrives.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	cursorRegenerationDelay(String cursorRegenerationDelay) MongoDB tailable cursors will block until new data arrives.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	dynamicity(boolean dynamicity) Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	dynamicity(String dynamicity) Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	readPreference(String readPreference) Configure how MongoDB clients route read operations to the members of a replica set.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	writeConcern(String writeConcern) Configure the connection bean with the level of acknowledgment requested from MongoDB for write operations to a standalone mongod, replicaset or cluster.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	writeResultAsHeader(boolean writeResultAsHeader) In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header.
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	writeResultAsHeader(String writeResultAsHeader) In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

basic

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder basic()

Specified by:

basic in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

basic in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

cursorRegenerationDelay

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder cursorRegenerationDelay(long cursorRegenerationDelay)

MongoDB tailable cursors will block until new data arrives. If no new data is inserted, after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor, and if the attempt fails, how long before the next attempt is made. Default value is 1000ms. The option is a: <code>long</code> type. Default: 1000 Group: advanced

Specified by:

cursorRegenerationDelay in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

cursorRegenerationDelay in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

cursorRegenerationDelay - the value to set

Returns:

the dsl builder

cursorRegenerationDelay

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder cursorRegenerationDelay(String cursorRegenerationDelay)

MongoDB tailable cursors will block until new data arrives. If no new data is inserted, after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor, and if the attempt fails, how long before the next attempt is made. Default value is 1000ms. The option will be converted to a <code>long</code> type. Default: 1000 Group: advanced

Specified by:

cursorRegenerationDelay in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

cursorRegenerationDelay in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

cursorRegenerationDelay - the value to set

Returns:

the dsl builder

dynamicity

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder dynamicity(boolean dynamicity)

Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

dynamicity in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

dynamicity in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

dynamicity - the value to set

Returns:

the dsl builder

dynamicity

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder dynamicity(String dynamicity)

Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

dynamicity in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

dynamicity in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

dynamicity - the value to set

Returns:

the dsl builder

readPreference

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder readPreference(String readPreference)

Configure how MongoDB clients route read operations to the members of a replica set. Possible values are PRIMARY, PRIMARY_PREFERRED, SECONDARY, SECONDARY_PREFERRED or NEAREST. The option is a: <code>java.lang.String</code> type. Default: PRIMARY Group: advanced

Specified by:

readPreference in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

readPreference in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

readPreference - the value to set

Returns:

the dsl builder

synchronous

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

synchronous in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

synchronous in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

writeConcern

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder writeConcern(String writeConcern)

Configure the connection bean with the level of acknowledgment requested from MongoDB for write operations to a standalone mongod, replicaset or cluster. Possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED or MAJORITY. The option is a: <code>java.lang.String</code> type. Default: ACKNOWLEDGED Group: advanced

Specified by:

writeConcern in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

writeConcern in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

writeConcern - the value to set

Returns:

the dsl builder

writeResultAsHeader

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder writeResultAsHeader(boolean writeResultAsHeader)

In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

writeResultAsHeader in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

writeResultAsHeader in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

writeResultAsHeader - the value to set

Returns:

the dsl builder

writeResultAsHeader

default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder writeResultAsHeader(String writeResultAsHeader)

In write operations, it determines whether instead of returning WriteResult as the body of the OUT message, we transfer the IN message to the OUT and attach the WriteResult as a header. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

writeResultAsHeader in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointConsumerBuilder

Specified by:

writeResultAsHeader in interface MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointProducerBuilder

Parameters:

writeResultAsHeader - the value to set

Returns:

the dsl builder