Package org.apache.camel.component.debezium.mongodb.configuration

Class MongoDbConnectorEmbeddedDebeziumConfiguration

java.lang.Object
org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
org.apache.camel.component.debezium.mongodb.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class MongoDbConnectorEmbeddedDebeziumConfiguration extends org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

  • Constructor Details

    • MongoDbConnectorEmbeddedDebeziumConfiguration

      public MongoDbConnectorEmbeddedDebeziumConfiguration()

  • Method Details

    • setTransactionMetadataFactory

      public void setTransactionMetadataFactory(String transactionMetadataFactory)
      Class to make transaction context invalid input: '&' transaction struct/schemas

    • getTransactionMetadataFactory

      public String getTransactionMetadataFactory()

    • setStreamingDelayMs

      public void setStreamingDelayMs(long streamingDelayMs)
      A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms.

    • getStreamingDelayMs

      public long getStreamingDelayMs()

    • setCustomMetricTags

      public void setCustomMetricTags(String customMetricTags)
      The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2

    • getCustomMetricTags

      public String getCustomMetricTags()

    • setMongodbConnectionString

      public void setMongodbConnectionString(String mongodbConnectionString)
      Database connection string.

    • getMongodbConnectionString

      public String getMongodbConnectionString()

    • setMongodbPassword

      public void setMongodbPassword(String mongodbPassword)
      Password to be used when connecting to MongoDB, if necessary.

    • getMongodbPassword

      public String getMongodbPassword()

    • setQueryFetchSize

      public void setQueryFetchSize(int queryFetchSize)
      The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size.

    • getQueryFetchSize

      public int getQueryFetchSize()

    • setSignalEnabledChannels

      public void setSignalEnabledChannels(String signalEnabledChannels)
      List of channels names that are enabled. Source channel is enabled by default

    • getSignalEnabledChannels

      public String getSignalEnabledChannels()

    • setMongodbSslEnabled

      public void setMongodbSslEnabled(boolean mongodbSslEnabled)
      Should connector use SSL to connect to MongoDB instances

    • isMongodbSslEnabled

      public boolean isMongodbSslEnabled()

    • setCursorMaxAwaitTimeMs

      public void setCursorMaxAwaitTimeMs(int cursorMaxAwaitTimeMs)
      The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request

    • getCursorMaxAwaitTimeMs

      public int getCursorMaxAwaitTimeMs()

    • setFieldRenames

      public void setFieldRenames(String fieldRenames)
      A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard (*) which matches any characters, the colon character (:) is used to determine rename mapping of field.

    • getFieldRenames

      public String getFieldRenames()

    • setMongodbServerSelectionTimeoutMs

      public void setMongodbServerSelectionTimeoutMs(int mongodbServerSelectionTimeoutMs)
      The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms).

    • getMongodbServerSelectionTimeoutMs

      public int getMongodbServerSelectionTimeoutMs()

    • setPollIntervalMs

      public void setPollIntervalMs(long pollIntervalMs)
      Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms.

    • getPollIntervalMs

      public long getPollIntervalMs()

    • setSignalDataCollection

      public void setSignalDataCollection(String signalDataCollection)
      The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set.

    • getSignalDataCollection

      public String getSignalDataCollection()

    • setConverters

      public void setConverters(String converters)
      Optional list of custom converters that would be used instead of default ones. The converters are defined using 'invalid input: '<'converter.prefix>.type' config option and configured using options 'invalid input: '<'converter.prefix>.

    • getConverters

      public String getConverters()

    • setHeartbeatTopicsPrefix

      public void setHeartbeatTopicsPrefix(String heartbeatTopicsPrefix)
      The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.

    • getHeartbeatTopicsPrefix

      public String getHeartbeatTopicsPrefix()

    • setMongodbConnectTimeoutMs

      public void setMongodbConnectTimeoutMs(int mongodbConnectTimeoutMs)
      The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms).

    • getMongodbConnectTimeoutMs

      public int getMongodbConnectTimeoutMs()

    • setSnapshotFetchSize

      public void setSnapshotFetchSize(int snapshotFetchSize)
      The maximum number of records that should be loaded into memory while performing a snapshot.

    • getSnapshotFetchSize

      public int getSnapshotFetchSize()

    • setMongodbPollIntervalMs

      public void setMongodbPollIntervalMs(long mongodbPollIntervalMs)
      Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms).

    • getMongodbPollIntervalMs

      public long getMongodbPollIntervalMs()

    • setIncrementalSnapshotWatermarkingStrategy

      public void setIncrementalSnapshotWatermarkingStrategy(String incrementalSnapshotWatermarkingStrategy)
      Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;

    • getIncrementalSnapshotWatermarkingStrategy

      public String getIncrementalSnapshotWatermarkingStrategy()

    • setMongodbUser

      public void setMongodbUser(String mongodbUser)
      Database user for connecting to MongoDB, if necessary.

    • getMongodbUser

      public String getMongodbUser()

    • setHeartbeatIntervalMs

      public void setHeartbeatIntervalMs(int heartbeatIntervalMs)
      Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default.

    • getHeartbeatIntervalMs

      public int getHeartbeatIntervalMs()

    • setSnapshotModeConfigurationBasedSnapshotOnSchemaError

      public void setSnapshotModeConfigurationBasedSnapshotOnSchemaError(boolean snapshotModeConfigurationBasedSnapshotOnSchemaError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error.

    • isSnapshotModeConfigurationBasedSnapshotOnSchemaError

      public boolean isSnapshotModeConfigurationBasedSnapshotOnSchemaError()

    • setSnapshotCollectionFilterOverrides

      public void setSnapshotCollectionFilterOverrides(String snapshotCollectionFilterOverrides)
      This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override..

    • getSnapshotCollectionFilterOverrides

      public String getSnapshotCollectionFilterOverrides()

    • setFieldExcludeList

      public void setFieldExcludeList(String fieldExcludeList)
      A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values

    • getFieldExcludeList

      public String getFieldExcludeList()

    • setErrorsMaxRetries

      public void setErrorsMaxRetries(int errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, > 0 = num of retries).

    • getErrorsMaxRetries

      public int getErrorsMaxRetries()

    • setDatabaseExcludeList

      public void setDatabaseExcludeList(String databaseExcludeList)
      A comma-separated list of regular expressions or literals that match the database names for which changes are to be excluded

    • getDatabaseExcludeList

      public String getDatabaseExcludeList()

    • setMaxBatchSize

      public void setMaxBatchSize(int maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048.

    • getMaxBatchSize

      public int getMaxBatchSize()

    • setSkippedOperations

      public void setSkippedOperations(String skippedOperations)
      The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped.

    • getSkippedOperations

      public String getSkippedOperations()

    • setTopicNamingStrategy

      public void setTopicNamingStrategy(String topicNamingStrategy)
      The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc.

    • getTopicNamingStrategy

      public String getTopicNamingStrategy()

    • setSnapshotMode

      public void setSnapshotMode(String snapshotMode)
      The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog.

    • getSnapshotMode

      public String getSnapshotMode()

    • setSnapshotModeConfigurationBasedSnapshotData

      public void setSnapshotModeConfigurationBasedSnapshotData(boolean snapshotModeConfigurationBasedSnapshotData)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not.

    • isSnapshotModeConfigurationBasedSnapshotData

      public boolean isSnapshotModeConfigurationBasedSnapshotData()

    • setMaxQueueSize

      public void setMaxQueueSize(int maxQueueSize)
      Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size.

    • getMaxQueueSize

      public int getMaxQueueSize()

    • setCollectionIncludeList

      public void setCollectionIncludeList(String collectionIncludeList)
      A comma-separated list of regular expressions or literals that match the collection names for which changes are to be captured

    • getCollectionIncludeList

      public String getCollectionIncludeList()

    • setRetriableRestartConnectorWaitMs

      public void setRetriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms.

    • getRetriableRestartConnectorWaitMs

      public long getRetriableRestartConnectorWaitMs()

    • setCaptureMode

      public void setCaptureMode(String captureMode)
      The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents

    • getCaptureMode

      public String getCaptureMode()

    • setSnapshotDelayMs

      public void setSnapshotDelayMs(long snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms.

    • getSnapshotDelayMs

      public long getSnapshotDelayMs()

    • setProvideTransactionMetadata

      public void setProvideTransactionMetadata(boolean provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting

    • isProvideTransactionMetadata

      public boolean isProvideTransactionMetadata()

    • setSnapshotModeConfigurationBasedSnapshotOnDataError

      public void setSnapshotModeConfigurationBasedSnapshotOnDataError(boolean snapshotModeConfigurationBasedSnapshotOnDataError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error.

    • isSnapshotModeConfigurationBasedSnapshotOnDataError

      public boolean isSnapshotModeConfigurationBasedSnapshotOnDataError()

    • setSchemaHistoryInternalFileFilename

      public void setSchemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename)
      The path to the file that will be used to record the database schema history

    • getSchemaHistoryInternalFileFilename

      public String getSchemaHistoryInternalFileFilename()

    • setTombstonesOnDelete

      public void setTombstonesOnDelete(boolean tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.

    • isTombstonesOnDelete

      public boolean isTombstonesOnDelete()

    • setTopicPrefix

      public void setTopicPrefix(String topicPrefix)
      Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted.

    • getTopicPrefix

      public String getTopicPrefix()

    • setSourceinfoStructMaker

      public void setSourceinfoStructMaker(String sourceinfoStructMaker)
      The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct.

    • getSourceinfoStructMaker

      public String getSourceinfoStructMaker()

    • setMongodbAuthsource

      public void setMongodbAuthsource(String mongodbAuthsource)
      Database containing user credentials.

    • getMongodbAuthsource

      public String getMongodbAuthsource()

    • setCollectionExcludeList

      public void setCollectionExcludeList(String collectionExcludeList)
      A comma-separated list of regular expressions or literals that match the collection names for which changes are to be excluded

    • getCollectionExcludeList

      public String getCollectionExcludeList()

    • setSnapshotIncludeCollectionList

      public void setSnapshotIncludeCollectionList(String snapshotIncludeCollectionList)
      This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector.

    • getSnapshotIncludeCollectionList

      public String getSnapshotIncludeCollectionList()

    • setSnapshotModeConfigurationBasedStartStream

      public void setSnapshotModeConfigurationBasedStartStream(boolean snapshotModeConfigurationBasedStartStream)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot.

    • isSnapshotModeConfigurationBasedStartStream

      public boolean isSnapshotModeConfigurationBasedStartStream()

    • setMaxQueueSizeInBytes

      public void setMaxQueueSizeInBytes(long maxQueueSizeInBytes)
      Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled

    • getMaxQueueSizeInBytes

      public long getMaxQueueSizeInBytes()

    • setSnapshotModeConfigurationBasedSnapshotSchema

      public void setSnapshotModeConfigurationBasedSnapshotSchema(boolean snapshotModeConfigurationBasedSnapshotSchema)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not.

    • isSnapshotModeConfigurationBasedSnapshotSchema

      public boolean isSnapshotModeConfigurationBasedSnapshotSchema()

    • setSignalPollIntervalMs

      public void setSignalPollIntervalMs(long signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds.

    • getSignalPollIntervalMs

      public long getSignalPollIntervalMs()

    • setPostProcessors

      public void setPostProcessors(String postProcessors)
      Optional list of post processors. The processors are defined using 'invalid input: '<'post.processor.prefix>.type' config option and configured using options 'invalid input: '<'post.processor.prefix.

    • getPostProcessors

      public String getPostProcessors()

    • setNotificationEnabledChannels

      public void setNotificationEnabledChannels(String notificationEnabledChannels)
      List of notification channels names that are enabled.

    • getNotificationEnabledChannels

      public String getNotificationEnabledChannels()

    • setMongodbSocketTimeoutMs

      public void setMongodbSocketTimeoutMs(int mongodbSocketTimeoutMs)
      The socket timeout, given in milliseconds. Defaults to 0 ms.

    • getMongodbSocketTimeoutMs

      public int getMongodbSocketTimeoutMs()

    • setEventProcessingFailureHandlingMode

      public void setEventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)
      Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped.

    • getEventProcessingFailureHandlingMode

      public String getEventProcessingFailureHandlingMode()

    • setSnapshotMaxThreads

      public void setSnapshotMaxThreads(int snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1.

    • getSnapshotMaxThreads

      public int getSnapshotMaxThreads()

    • setNotificationSinkTopicName

      public void setNotificationSinkTopicName(String notificationSinkTopicName)
      The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels

    • getNotificationSinkTopicName

      public String getNotificationSinkTopicName()

    • setSnapshotModeCustomName

      public void setSnapshotModeCustomName(String snapshotModeCustomName)
      When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot.

    • getSnapshotModeCustomName

      public String getSnapshotModeCustomName()

    • setSchemaNameAdjustmentMode

      public void setSchemaNameAdjustmentMode(String schemaNameAdjustmentMode)
      Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default)

    • getSchemaNameAdjustmentMode

      public String getSchemaNameAdjustmentMode()

    • setMongodbSslInvalidHostnameAllowed

      public void setMongodbSslInvalidHostnameAllowed(boolean mongodbSslInvalidHostnameAllowed)
      Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks

    • isMongodbSslInvalidHostnameAllowed

      public boolean isMongodbSslInvalidHostnameAllowed()

    • setMongodbHeartbeatFrequencyMs

      public void setMongodbHeartbeatFrequencyMs(int mongodbHeartbeatFrequencyMs)
      The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms).

    • getMongodbHeartbeatFrequencyMs

      public int getMongodbHeartbeatFrequencyMs()

    • setDatabaseIncludeList

      public void setDatabaseIncludeList(String databaseIncludeList)
      A comma-separated list of regular expressions or literals that match the database names for which changes are to be captured

    • getDatabaseIncludeList

      public String getDatabaseIncludeList()

    • createConnectorConfiguration

      protected io.debezium.config.Configuration createConnectorConfiguration()
      Specified by:
      createConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

    • configureConnectorClass

      protected Class configureConnectorClass()
      Specified by:
      configureConnectorClass in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

    • validateConnectorConfiguration

      protected org.apache.camel.component.debezium.configuration.ConfigurationValidation validateConnectorConfiguration()
      Specified by:
      validateConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

    • getConnectorDatabaseType

      public String getConnectorDatabaseType()
      Specified by:
      getConnectorDatabaseType in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration