blob: 7428b5044a748df2abab176d5b52a40d0f1a2b01 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.builder.endpoint.dsl;
import javax.annotation.Generated;
import org.apache.camel.ExchangePattern;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
import org.apache.camel.spi.ExceptionHandler;
/**
* Component for working with documents stored in MongoDB database.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface MongoDbEndpointBuilderFactory {
/**
* Builder for endpoint consumers for the MongoDB component.
*/
public interface MongoDbEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default AdvancedMongoDbEndpointConsumerBuilder advanced() {
return (AdvancedMongoDbEndpointConsumerBuilder) this;
}
/**
* Sets the name of the MongoDB collection to bind to this endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder collection(String collection) {
doSetProperty("collection", collection);
return this;
}
/**
* Sets the collection index (JSON FORMAT : { field1 : order1, field2 :
* order2}).
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder collectionIndex(
String collectionIndex) {
doSetProperty("collectionIndex", collectionIndex);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder createCollection(
boolean createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder createCollection(
String createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Sets the name of the MongoDB database to target.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder database(String database) {
doSetProperty("database", database);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option is a: <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder mongoConnection(
Object mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option will be converted to a
* <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder mongoConnection(
String mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the operation this endpoint will execute against MongoDB.
*
* The option is a:
* <code>org.apache.camel.component.mongodb.MongoDbOperation</code>
* type.
*
* Group: common
*/
default MongoDbEndpointConsumerBuilder operation(
MongoDbOperation operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder operation(String operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder outputType(
MongoDbOutputType outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder outputType(String outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* 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.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default MongoDbEndpointConsumerBuilder bridgeErrorHandler(
boolean bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* 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.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default MongoDbEndpointConsumerBuilder bridgeErrorHandler(
String bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* Consumer type.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: consumer
*/
default MongoDbEndpointConsumerBuilder consumerType(String consumerType) {
doSetProperty("consumerType", consumerType);
return this;
}
/**
* Filter condition for change streams consumer.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: changeStream
*/
default MongoDbEndpointConsumerBuilder streamFilter(String streamFilter) {
doSetProperty("streamFilter", streamFilter);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder persistentId(String persistentId) {
doSetProperty("persistentId", persistentId);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointConsumerBuilder persistentTailTracking(
boolean persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointConsumerBuilder persistentTailTracking(
String persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder tailTrackCollection(
String tailTrackCollection) {
doSetProperty("tailTrackCollection", tailTrackCollection);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder tailTrackDb(String tailTrackDb) {
doSetProperty("tailTrackDb", tailTrackDb);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder tailTrackField(
String tailTrackField) {
doSetProperty("tailTrackField", tailTrackField);
return this;
}
/**
* 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
*/
default MongoDbEndpointConsumerBuilder tailTrackIncreasingField(
String tailTrackIncreasingField) {
doSetProperty("tailTrackIncreasingField", tailTrackIncreasingField);
return this;
}
}
/**
* Advanced builder for endpoint consumers for the MongoDB component.
*/
public interface AdvancedMongoDbEndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default MongoDbEndpointConsumerBuilder basic() {
return (MongoDbEndpointConsumerBuilder) this;
}
/**
* 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.
*
* The option is a: <code>org.apache.camel.spi.ExceptionHandler</code>
* type.
*
* Group: consumer (advanced)
*/
default AdvancedMongoDbEndpointConsumerBuilder exceptionHandler(
ExceptionHandler exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* 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.
*
* The option will be converted to a
* <code>org.apache.camel.spi.ExceptionHandler</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedMongoDbEndpointConsumerBuilder exceptionHandler(
String exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option is a: <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedMongoDbEndpointConsumerBuilder exchangePattern(
ExchangePattern exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option will be converted to a
* <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedMongoDbEndpointConsumerBuilder exchangePattern(
String exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder cursorRegenerationDelay(
long cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder cursorRegenerationDelay(
String cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder dynamicity(
boolean dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder dynamicity(
String dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder writeResultAsHeader(
boolean writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointConsumerBuilder writeResultAsHeader(
String writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
}
/**
* Builder for endpoint producers for the MongoDB component.
*/
public interface MongoDbEndpointProducerBuilder
extends
EndpointProducerBuilder {
default AdvancedMongoDbEndpointProducerBuilder advanced() {
return (AdvancedMongoDbEndpointProducerBuilder) this;
}
/**
* Sets the name of the MongoDB collection to bind to this endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder collection(String collection) {
doSetProperty("collection", collection);
return this;
}
/**
* Sets the collection index (JSON FORMAT : { field1 : order1, field2 :
* order2}).
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder collectionIndex(
String collectionIndex) {
doSetProperty("collectionIndex", collectionIndex);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder createCollection(
boolean createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder createCollection(
String createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Sets the name of the MongoDB database to target.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder database(String database) {
doSetProperty("database", database);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option is a: <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder mongoConnection(
Object mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option will be converted to a
* <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder mongoConnection(
String mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the operation this endpoint will execute against MongoDB.
*
* The option is a:
* <code>org.apache.camel.component.mongodb.MongoDbOperation</code>
* type.
*
* Group: common
*/
default MongoDbEndpointProducerBuilder operation(
MongoDbOperation operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder operation(String operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder outputType(
MongoDbOutputType outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder outputType(String outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* 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.
*
* Group: producer
*/
default MongoDbEndpointProducerBuilder lazyStartProducer(
boolean lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* 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.
*
* Group: producer
*/
default MongoDbEndpointProducerBuilder lazyStartProducer(
String lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* Filter condition for change streams consumer.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: changeStream
*/
default MongoDbEndpointProducerBuilder streamFilter(String streamFilter) {
doSetProperty("streamFilter", streamFilter);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder persistentId(String persistentId) {
doSetProperty("persistentId", persistentId);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointProducerBuilder persistentTailTracking(
boolean persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointProducerBuilder persistentTailTracking(
String persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder tailTrackCollection(
String tailTrackCollection) {
doSetProperty("tailTrackCollection", tailTrackCollection);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder tailTrackDb(String tailTrackDb) {
doSetProperty("tailTrackDb", tailTrackDb);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder tailTrackField(
String tailTrackField) {
doSetProperty("tailTrackField", tailTrackField);
return this;
}
/**
* 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
*/
default MongoDbEndpointProducerBuilder tailTrackIncreasingField(
String tailTrackIncreasingField) {
doSetProperty("tailTrackIncreasingField", tailTrackIncreasingField);
return this;
}
}
/**
* Advanced builder for endpoint producers for the MongoDB component.
*/
public interface AdvancedMongoDbEndpointProducerBuilder
extends
EndpointProducerBuilder {
default MongoDbEndpointProducerBuilder basic() {
return (MongoDbEndpointProducerBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder cursorRegenerationDelay(
long cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder cursorRegenerationDelay(
String cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder dynamicity(
boolean dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder dynamicity(
String dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder writeResultAsHeader(
boolean writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointProducerBuilder writeResultAsHeader(
String writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
}
/**
* Builder for endpoint for the MongoDB component.
*/
public interface MongoDbEndpointBuilder
extends
MongoDbEndpointConsumerBuilder, MongoDbEndpointProducerBuilder {
default AdvancedMongoDbEndpointBuilder advanced() {
return (AdvancedMongoDbEndpointBuilder) this;
}
/**
* Sets the name of the MongoDB collection to bind to this endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder collection(String collection) {
doSetProperty("collection", collection);
return this;
}
/**
* Sets the collection index (JSON FORMAT : { field1 : order1, field2 :
* order2}).
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder collectionIndex(String collectionIndex) {
doSetProperty("collectionIndex", collectionIndex);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option is a: <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder createCollection(boolean createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Create collection during initialisation if it doesn't exist. Default
* is true.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder createCollection(String createCollection) {
doSetProperty("createCollection", createCollection);
return this;
}
/**
* Sets the name of the MongoDB database to target.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder database(String database) {
doSetProperty("database", database);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option is a: <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder mongoConnection(Object mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the Mongo instance that represents the backing connection.
*
* The option will be converted to a
* <code>com.mongodb.MongoClient</code> type.
*
* Group: common
*/
default MongoDbEndpointBuilder mongoConnection(String mongoConnection) {
doSetProperty("mongoConnection", mongoConnection);
return this;
}
/**
* Sets the operation this endpoint will execute against MongoDB.
*
* The option is a:
* <code>org.apache.camel.component.mongodb.MongoDbOperation</code>
* type.
*
* Group: common
*/
default MongoDbEndpointBuilder operation(MongoDbOperation operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder operation(String operation) {
doSetProperty("operation", operation);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder outputType(MongoDbOutputType outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder outputType(String outputType) {
doSetProperty("outputType", outputType);
return this;
}
/**
* Filter condition for change streams consumer.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: changeStream
*/
default MongoDbEndpointBuilder streamFilter(String streamFilter) {
doSetProperty("streamFilter", streamFilter);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder persistentId(String persistentId) {
doSetProperty("persistentId", persistentId);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointBuilder persistentTailTracking(
boolean persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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.
*
* Group: tail
*/
default MongoDbEndpointBuilder persistentTailTracking(
String persistentTailTracking) {
doSetProperty("persistentTailTracking", persistentTailTracking);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder tailTrackCollection(
String tailTrackCollection) {
doSetProperty("tailTrackCollection", tailTrackCollection);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder tailTrackDb(String tailTrackDb) {
doSetProperty("tailTrackDb", tailTrackDb);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder tailTrackField(String tailTrackField) {
doSetProperty("tailTrackField", tailTrackField);
return this;
}
/**
* 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
*/
default MongoDbEndpointBuilder tailTrackIncreasingField(
String tailTrackIncreasingField) {
doSetProperty("tailTrackIncreasingField", tailTrackIncreasingField);
return this;
}
}
/**
* Advanced builder for endpoint for the MongoDB component.
*/
public interface AdvancedMongoDbEndpointBuilder
extends
AdvancedMongoDbEndpointConsumerBuilder, AdvancedMongoDbEndpointProducerBuilder {
default MongoDbEndpointBuilder basic() {
return (MongoDbEndpointBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder cursorRegenerationDelay(
long cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder cursorRegenerationDelay(
String cursorRegenerationDelay) {
doSetProperty("cursorRegenerationDelay", cursorRegenerationDelay);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder dynamicity(boolean dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder dynamicity(String dynamicity) {
doSetProperty("dynamicity", dynamicity);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder synchronous(boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder synchronous(String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder writeResultAsHeader(
boolean writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
/**
* 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.
*
* Group: advanced
*/
default AdvancedMongoDbEndpointBuilder writeResultAsHeader(
String writeResultAsHeader) {
doSetProperty("writeResultAsHeader", writeResultAsHeader);
return this;
}
}
/**
* Proxy enum for
* <code>org.apache.camel.component.mongodb.MongoDbOperation</code> enum.
*/
enum MongoDbOperation {
findById,
findOneByQuery,
findAll,
findDistinct,
insert,
save,
update,
remove,
bulkWrite,
aggregate,
getDbStats,
getColStats,
count,
command;
}
/**
* Proxy enum for
* <code>org.apache.camel.component.mongodb.MongoDbOutputType</code> enum.
*/
enum MongoDbOutputType {
DocumentList,
Document,
MongoIterable;
}
/**
* MongoDB (camel-mongodb)
* Component for working with documents stored in MongoDB database.
*
* Category: database,nosql
* Available as of version: 2.19
* Maven coordinates: org.apache.camel:camel-mongodb
*
* Syntax: <code>mongodb:connectionBean</code>
*
* Path parameter: connectionBean (required)
* Name of com.mongodb.Mongo to use.
*/
default MongoDbEndpointBuilder mongodb(String path) {
class MongoDbEndpointBuilderImpl extends AbstractEndpointBuilder implements MongoDbEndpointBuilder, AdvancedMongoDbEndpointBuilder {
public MongoDbEndpointBuilderImpl(String path) {
super("mongodb", path);
}
}
return new MongoDbEndpointBuilderImpl(path);
}
}