Package 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	Description
default MongoDbEndpointBuilderFactory.AdvancedMongoDbEndpointBuilder	advanced()
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	authSource(String authSource)	The database name associated with the user's credentials.
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	connectionUriString(String connectionUriString)	Set the whole Connection String/Uri for mongodb endpoint.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	createCollection(boolean createCollection)	Create the collection during initialisation if it doesn't exist.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	createCollection(String createCollection)	Create the 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	hosts(String hosts)	Host address of mongodb server in host:port format.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	mongoConnection(com.mongodb.client.MongoClient 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(String operation)	Sets the operation this endpoint will execute against MongoDB.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	operation(org.apache.camel.component.mongodb.MongoDbOperation operation)	Sets the operation this endpoint will execute against MongoDB.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	outputType(String outputType)	Convert the output of the producer to the selected type: DocumentList Document or MongoIterable.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	outputType(org.apache.camel.component.mongodb.MongoDbOutputType outputType)	Convert the output of the producer to the selected type: DocumentList Document or MongoIterable.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	password(String password)	User password for mongodb connection.
default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder	username(String username)	Username for mongodb connection.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

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

consumerType, fullDocument, fullDocument, persistentId, persistentTailTracking, persistentTailTracking, streamFilter, tailTrackCollection, tailTrackDb, tailTrackField, tailTrackIncreasingField

Method Details

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: java.lang.String 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: java.lang.String 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

connectionUriString

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder connectionUriString(String connectionUriString)

Set the whole Connection String/Uri for mongodb endpoint. The option is a: java.lang.String type. Group: common

Specified by:

connectionUriString in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

connectionUriString in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

connectionUriString - the value to set

Returns:

the dsl builder

createCollection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder createCollection(boolean createCollection)

Create the collection during initialisation if it doesn't exist. Default is true. The option is a: boolean 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 the collection during initialisation if it doesn't exist. Default is true. The option will be converted to a boolean 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: java.lang.String 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

hosts

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder hosts(String hosts)

Host address of mongodb server in host:port format. It's possible to also use more than one address, as a comma separated list of hosts: host1:port1,host2:port2. If this parameter is specified, the provided connectionBean is ignored. The option is a: java.lang.String type. Group: common

Specified by:

hosts in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

hosts in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

hosts - the value to set

Returns:

the dsl builder

mongoConnection

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder mongoConnection(com.mongodb.client.MongoClient mongoConnection)

Sets the connection bean used as a client for connecting to a database. The option is a: com.mongodb.client.MongoClient 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 com.mongodb.client.MongoClient 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(org.apache.camel.component.mongodb.MongoDbOperation operation)

Sets the operation this endpoint will execute against MongoDB. The option is a: org.apache.camel.component.mongodb.MongoDbOperation 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 org.apache.camel.component.mongodb.MongoDbOperation 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(org.apache.camel.component.mongodb.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: org.apache.camel.component.mongodb.MongoDbOutputType 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 org.apache.camel.component.mongodb.MongoDbOutputType 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

authSource

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder authSource(String authSource)

The database name associated with the user's credentials. The option is a: java.lang.String type. Group: security

Specified by:

authSource in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

authSource in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

authSource - the value to set

Returns:

the dsl builder

password

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder password(String password)

User password for mongodb connection. The option is a: java.lang.String type. Group: security

Specified by:

password in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

password in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

username

default MongoDbEndpointBuilderFactory.MongoDbEndpointBuilder username(String username)

Username for mongodb connection. The option is a: java.lang.String type. Group: security

Specified by:

username in interface MongoDbEndpointBuilderFactory.MongoDbEndpointConsumerBuilder

Specified by:

username in interface MongoDbEndpointBuilderFactory.MongoDbEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder