camel-mongodb-gridfs-kafka-connector source configuration

When using camel-mongodb-gridfs-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-mongodb-gridfs-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.mongodbgridfs.CamelMongodbgridfsSourceConnector

The camel-mongodb-gridfs source connector supports 19 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.connectionBean	Name of com.mongodb.client.MongoClient to use.	null	true	HIGH
camel.source.endpoint.bucket	Sets the name of the GridFS bucket within the database. Default is fs.	"fs"	false	MEDIUM
camel.source.endpoint.database	Sets the name of the MongoDB database to target	null	true	HIGH
camel.source.endpoint.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.	null	false	MEDIUM
camel.source.endpoint.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. One of: [ACKNOWLEDGED] [W1] [W2] [W3] [UNACKNOWLEDGED] [JOURNALED] [MAJORITY]	null	false	MEDIUM
camel.source.endpoint.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	false	MEDIUM
camel.source.endpoint.delay	Sets the delay between polls within the Consumer. Default is 500ms	500L	false	MEDIUM
camel.source.endpoint.fileAttributeName	If the QueryType uses a FileAttribute, this sets the name of the attribute that is used. Default is camel-processed.	"camel-processed"	false	MEDIUM
camel.source.endpoint.initialDelay	Sets the initialDelay before the consumer will start polling. Default is 1000ms	1000L	false	MEDIUM
camel.source.endpoint.persistentTSCollection	If the QueryType uses a persistent timestamp, this sets the name of the collection within the DB to store the timestamp.	"camel-timestamps"	false	MEDIUM
camel.source.endpoint.persistentTSObject	If the QueryType uses a persistent timestamp, this is the ID of the object in the collection to store the timestamp.	"camel-timestamp"	false	MEDIUM
camel.source.endpoint.query	Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer	null	false	MEDIUM
camel.source.endpoint.queryStrategy	Sets the QueryStrategy that is used for polling for new files. Default is Timestamp One of: [TimeStamp] [PersistentTimestamp] [FileAttribute] [TimeStampAndFileAttribute] [PersistentTimestampAndFileAttribute]	"TimeStamp"	false	MEDIUM
camel.source.endpoint.exceptionHandler	To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.	null	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	false	MEDIUM
camel.source.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.component.mongodb-gridfs.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	false	MEDIUM
camel.component.mongodb-gridfs.basicProperty Binding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW

Name

Description

Default

Required

Priority

camel.source.path.connectionBean

Name of com.mongodb.client.MongoClient to use.

null

true

HIGH

camel.source.endpoint.bucket

Sets the name of the GridFS bucket within the database. Default is fs.

"fs"

false

MEDIUM

camel.source.endpoint.database

Sets the name of the MongoDB database to target

null

true

HIGH

camel.source.endpoint.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.

null

false

MEDIUM

camel.source.endpoint.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. One of: [ACKNOWLEDGED] [W1] [W2] [W3] [UNACKNOWLEDGED] [JOURNALED] [MAJORITY]

null

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.delay

Sets the delay between polls within the Consumer. Default is 500ms

500L

false

MEDIUM

camel.source.endpoint.fileAttributeName

If the QueryType uses a FileAttribute, this sets the name of the attribute that is used. Default is camel-processed.

"camel-processed"

false

MEDIUM

camel.source.endpoint.initialDelay

Sets the initialDelay before the consumer will start polling. Default is 1000ms

1000L

false

MEDIUM

camel.source.endpoint.persistentTSCollection

If the QueryType uses a persistent timestamp, this sets the name of the collection within the DB to store the timestamp.

"camel-timestamps"

false

MEDIUM

camel.source.endpoint.persistentTSObject

If the QueryType uses a persistent timestamp, this is the ID of the object in the collection to store the timestamp.

"camel-timestamp"

false

MEDIUM

camel.source.endpoint.query

Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer

null

false

MEDIUM

camel.source.endpoint.queryStrategy

Sets the QueryStrategy that is used for polling for new files. Default is Timestamp One of: [TimeStamp] [PersistentTimestamp] [FileAttribute] [TimeStampAndFileAttribute] [PersistentTimestampAndFileAttribute]

"TimeStamp"

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.component.mongodb-gridfs.bridgeErrorHandler

false

MEDIUM

camel.component.mongodb-gridfs.basicProperty Binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

The camel-mongodb-gridfs sink connector has no converters out of the box.

The camel-mongodb-gridfs sink connector has no transforms out of the box.

The camel-mongodb-gridfs sink connector has no aggregation strategies out of the box.