org.apache.camel.builder.endpoint.dsl

Interface MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder, MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Enclosing interface:

MongoDbEndpointBuilderFactory

public static interface MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder
extends MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder, MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Builder for endpoint for the MongoDB component.

Method Summary

Modifier and Type	Method and Description
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	advanced()
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	collection(String collection) Sets the name of the MongoDB collection to bind to this endpoint.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	collectionIndex(String collectionIndex) Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2}).
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	createCollection(boolean createCollection) Create collection during initialisation if it doesn't exist.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	createCollection(String createCollection) Create collection during initialisation if it doesn't exist.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	database(String database) Sets the name of the MongoDB database to target.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	mongoConnection(Object mongoConnection) Sets the connection bean used as a client for connecting to a database.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	mongoConnection(String mongoConnection) Sets the connection bean used as a client for connecting to a database.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	operation(MongoDbEndpointBuilderFactory.MongoDbOperation operation) Sets the operation this endpoint will execute against MongoDB.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	operation(String operation) Sets the operation this endpoint will execute against MongoDB.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	outputType(MongoDbEndpointBuilderFactory.MongoDbOutputType outputType) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	outputType(String outputType) Convert the output of the producer to the selected type : DocumentList Document or MongoIterable.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	persistentId(String persistentId) One tail tracking collection can host many trackers for several tailable consumers.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	persistentTailTracking(boolean persistentTailTracking) Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	persistentTailTracking(String persistentTailTracking) Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	streamFilter(String streamFilter) Filter condition for change streams consumer.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	tailTrackCollection(String tailTrackCollection) Collection where tail tracking information will be persisted.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	tailTrackDb(String tailTrackDb) Indicates what database the tail tracking mechanism will persist to.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	tailTrackField(String tailTrackField) Field where the last tracked value will be placed.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	tailTrackIncreasingField(String tailTrackIncreasingField) Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.

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

bridgeErrorHandler, bridgeErrorHandler, consumerType

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.endpoint.dsl.MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

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 MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder advanced()

Specified by:

advanced in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

advanced in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

collection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder collection(String collection)

Sets the name of the MongoDB collection to bind to this endpoint. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

collection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

collection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

collection - the value to set

Returns:

the dsl builder

collectionIndex

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder collectionIndex(String collectionIndex)

Sets the collection index (JSON FORMAT : { field1 : order1, field2 : order2}). The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

collectionIndex in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

collectionIndex in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

collectionIndex - the value to set

Returns:

the dsl builder

createCollection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder createCollection(boolean createCollection)

Create collection during initialisation if it doesn't exist. Default is true. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

createCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

createCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

createCollection - the value to set

Returns:

the dsl builder

createCollection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder createCollection(String createCollection)

Create collection during initialisation if it doesn't exist. Default is true. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

createCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

createCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

createCollection - the value to set

Returns:

the dsl builder

database

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder database(String database)

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

Specified by:

database in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

database in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

database - the value to set

Returns:

the dsl builder

mongoConnection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder mongoConnection(Object mongoConnection)

Sets the connection bean used as a client for connecting to a database. The option is a: <code>com.mongodb.client.MongoClient</code> type. Group: common

Specified by:

mongoConnection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

mongoConnection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

mongoConnection - the value to set

Returns:

the dsl builder

mongoConnection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder mongoConnection(String mongoConnection)

Sets the connection bean used as a client for connecting to a database. The option will be converted to a <code>com.mongodb.client.MongoClient</code> type. Group: common

Specified by:

mongoConnection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

mongoConnection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

mongoConnection - the value to set

Returns:

the dsl builder

operation

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder operation(MongoDbEndpointBuilderFactory.MongoDbOperation operation)

Sets the operation this endpoint will execute against MongoDB. The option is a: <code>org.apache.camel.component.mongodb.MongoDbOperation</code> type. Group: common

Specified by:

operation in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

operation in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

operation - the value to set

Returns:

the dsl builder

operation

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder operation(String operation)

Sets the operation this endpoint will execute against MongoDB. The option will be converted to a <code>org.apache.camel.component.mongodb.MongoDbOperation</code> type. Group: common

Specified by:

operation in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

operation in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

operation - the value to set

Returns:

the dsl builder

outputType

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder outputType(MongoDbEndpointBuilderFactory.MongoDbOutputType outputType)

Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations. The option is a: <code>org.apache.camel.component.mongodb.MongoDbOutputType</code> type. Group: common

Specified by:

outputType in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

outputType in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

outputType - the value to set

Returns:

the dsl builder

outputType

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder outputType(String outputType)

Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or MongoIterable applies to findAll and aggregate. Document applies to all other operations. The option will be converted to a <code>org.apache.camel.component.mongodb.MongoDbOutputType</code> type. Group: common

Specified by:

outputType in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

outputType in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

outputType - the value to set

Returns:

the dsl builder

streamFilter

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder streamFilter(String streamFilter)

Filter condition for change streams consumer. The option is a: <code>java.lang.String</code> type. Group: changeStream

Specified by:

streamFilter in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

streamFilter in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

streamFilter - the value to set

Returns:

the dsl builder

persistentId

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder persistentId(String persistentId)

One tail tracking collection can host many trackers for several tailable consumers. To keep them separate, each tracker should have its own unique persistentId. The option is a: <code>java.lang.String</code> type. Group: tail

Specified by:

persistentId in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

persistentId in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

persistentId - the value to set

Returns:

the dsl builder

persistentTailTracking

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder persistentTailTracking(boolean persistentTailTracking)

Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. The option is a: <code>boolean</code> type. Default: false Group: tail

Specified by:

persistentTailTracking in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

persistentTailTracking in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

persistentTailTracking - the value to set

Returns:

the dsl builder

persistentTailTracking

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder persistentTailTracking(String persistentTailTracking)

Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records. The option will be converted to a <code>boolean</code> type. Default: false Group: tail

Specified by:

persistentTailTracking in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

persistentTailTracking in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

persistentTailTracking - the value to set

Returns:

the dsl builder

tailTrackCollection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder tailTrackCollection(String tailTrackCollection)

Collection where tail tracking information will be persisted. If not specified, MongoDbTailTrackingConfig#DEFAULT_COLLECTION will be used by default. The option is a: <code>java.lang.String</code> type. Group: tail

Specified by:

tailTrackCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

tailTrackCollection in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

tailTrackCollection - the value to set

Returns:

the dsl builder

tailTrackDb

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder tailTrackDb(String tailTrackDb)

Indicates what database the tail tracking mechanism will persist to. If not specified, the current database will be picked by default. Dynamicity will not be taken into account even if enabled, i.e. the tail tracking database will not vary past endpoint initialisation. The option is a: <code>java.lang.String</code> type. Group: tail

Specified by:

tailTrackDb in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

tailTrackDb in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

tailTrackDb - the value to set

Returns:

the dsl builder

tailTrackField

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder tailTrackField(String tailTrackField)

Field where the last tracked value will be placed. If not specified, MongoDbTailTrackingConfig#DEFAULT_FIELD will be used by default. The option is a: <code>java.lang.String</code> type. Group: tail

Specified by:

tailTrackField in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

tailTrackField in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

tailTrackField - the value to set

Returns:

the dsl builder

tailTrackIncreasingField

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder tailTrackIncreasingField(String tailTrackIncreasingField)

Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField greater than lastValue (possibly recovered from persistent tail tracking). Can be of type Integer, Date, String, etc. NOTE: No support for dot notation at the current time, so the field should be at the top level of the document. The option is a: <code>java.lang.String</code> type. Group: tail

Specified by:

tailTrackIncreasingField in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

tailTrackIncreasingField in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

tailTrackIncreasingField - the value to set

Returns:

the dsl builder