DOCSP-10975: replace blacklist and whitelist (#27)

Author: Chris Cho

source/kafka-sink-postprocessors.txt

@@ -44,29 +44,29 @@ class:
 
        .. seealso:: :ref:`Strategy options and configuration <config-document-id-adder>`.
 
-   * - BlacklistKeyProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlacklistKeyProjector``
+   * - BlocklistKeyProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistKeyProjector``
        | Removes matching key fields from the sink record.
 
-       .. seealso:: :ref:`Configuration <config-blacklist-whitelist>` and :ref:`Example <blacklist-example>`.
+       .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
 
-   * - BlacklistValueProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlacklistValueProjector``
+   * - BlocklistValueProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector``
        | Removes matching value fields from the sink record.
 
-       .. seealso:: :ref:`Configuration <config-blacklist-whitelist>` and :ref:`Example <blacklist-example>`.
+       .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
 
-   * - WhitelistKeyProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.WhitelistKeyProjector``
+   * - AllowlistKeyProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistKeyProjector``
        | Includes only matching key fields from the sink record.
 
-       .. seealso:: :ref:`Configuration <config-blacklist-whitelist>` and :ref:`Example <whitelist-example>`.
+       .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
 
-   * - WhitelistValueProjector
-     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.WhitelistValueProjector``
+   * - AllowlistValueProjector
+     - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector``
        | matching value fields from the sink record.
 
-       .. seealso:: :ref:`Configuration <config-blacklist-whitelist>` and :ref:`Example <whitelist-example>`.
+       .. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
 
    * - KafkaMetaAdder
      - | Full Path: ``com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder``
@@ -89,7 +89,7 @@ comma separated list of fully-qualified ``PostProcessor`` class names:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.WhitelistValueProjector
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector
 
 .. note::
 
@@ -147,12 +147,12 @@ provided with this connector:
 
    * - PartialKeyStrategy
      - | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialKeyStrategy``
-       | Uses a blacklist or whitelist projection of the key structure of the ``SinkDocument``.
+       | Uses a blocklist or allowlist projection of the key structure of the ``SinkDocument``.
        | Defaults to a blank document if no key exists.
 
    * - PartialValueStrategy
      - | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy``
-       | Uses a blacklist or whitelist projection of the value structure of the ``SinkDocument``.
+       | Uses a blocklist or allowlist projection of the value structure of the ``SinkDocument``.
        | Defaults to a blank document if no value exists.
 
    * - UuidStrategy
@@ -179,9 +179,9 @@ setting.
    Other strategies permit exactly-once delivery if the fields that form
    the document *_id* are guaranteed to be unique.
 
-.. _config-blacklist-whitelist:
+.. _config-blocklist-allowlist:
 
-Blacklist / Whitelist Projector
+Blocklist / Allowlist Projector
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This section provides example projection configurations to show how they
@@ -224,18 +224,18 @@ filter the following sample record:
    to avoid repetition. Specify the one appropriate to your use case when
    creating your configuration.
 
-.. _blacklist-example:
+.. _blocklist-example:
 
-Blacklist Projection Example
+Blocklist Projection Example
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In the following example sink configuration, we specify a blacklist
+In the following example sink configuration, we specify a blocklist
 projection and the specific fields to omit from the record:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Blacklist[Key|Value]Projector
-   [key|value].projection.type=blacklist
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Blocklist[Key|Value]Projector
+   [key|value].projection.type=blocklist
    [key|value].projection.list=age,address.city,lut.key2,data.v
 
 .. note::
@@ -272,18 +272,18 @@ The record contains the following data after applying the projection:
      }
    }
 
-.. _whitelist-example:
+.. _allowlist-example:
 
-Whitelist Projection Example
+Allowlist Projection Example
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In the following example sink configuration, we specify a whitelist
+In the following example sink configuration, we specify a allowlist
 projection and the specific fields to include in the record:
 
 .. code-block:: properties
 
-   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Whitelist[Key|Value]Projector
-   [key|value].projection.type=whitelist
+   post.processor.chain=com.mongodb.kafka.connect.sink.processor.Allowlist[Key|Value]Projector
+   [key|value].projection.type=allowlist
    [key|value].projection.list=age,address.city,lut.key2,data.v
 
 .. note::
@@ -350,15 +350,15 @@ projection output from the following sample record:
      }
    }
 
-**Whitelist Wildcard Examples**
+**Allowlist Wildcard Examples**
 
 The ``*`` wildcard pattern in the example below matches all the keys named
 ``temp`` in the ``forecast`` array and all fields nested a single level
 below it.
 
 .. code-block:: properties
 
-   [key|value].projection.type=whitelist
+   [key|value].projection.type=allowlist
    [key|value].projection.list=city,forecast.temp.*
 
 The record contains the following data after applying the projection:
@@ -386,7 +386,7 @@ all levels that contain the field ``scale``.
 
 .. code-block:: properties
 
-   [key|value].projection.type=whitelist
+   [key|value].projection.type=allowlist
    [key|value].projection.list=**.scale
 
 The record contains the following data after applying the projection:
@@ -401,15 +401,15 @@ The record contains the following data after applying the projection:
      }
    }
 
-**Blacklist Wildcard Examples**
+**Blocklist Wildcard Examples**
 
 The wildcard character can also be used to match all field names at
-specific levels as demonstrated in the following blacklist projection
+specific levels as demonstrated in the following blocklist projection
 configuration example:
 
 .. code-block:: properties
 
-   [key|value].projection.type=blacklist
+   [key|value].projection.type=blocklist
    [key|value].projection.list=population,forecast.*.*
 
 The record contains the following data after applying the projection:
@@ -433,7 +433,7 @@ specified.
 
 .. code-block:: properties
 
-   [key|value].projection.type=blacklist
+   [key|value].projection.type=blocklist
    [key|value].projection.list=**.high
 
    {
@@ -711,7 +711,7 @@ file:
 
    document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy
    value.projection.list=flight_no,airport_code
-   value.projection.type=whitelist
+   value.projection.type=allowlist
    writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy"
 
 The sample data inserted into the collection contains the following:
@@ -752,7 +752,7 @@ values without changing the ``_id`` field.
    The ``PartialValueStrategy`` id strategy uses the 
    ``[key|value].projection.type`` and ``[key|value].projection.list``
    settings to define which fields are used to form the ``_id`` field. 
-   Since the Blacklist and Whitelist post processors use the same
+   Since the Blocklist and Allowlist post processors use the same
    projection settings, they cannot be specified separately. Use a `Single
    Message Transform (SMT)
    <https://docs.confluent.io/current/connect/transforms/index.html>`_

source/kafka-sink-properties.txt

@@ -164,7 +164,7 @@ data to sink to MongoDB. For an example configuration file, see
      - | The type of key projection to use.
        |
        | **Default**: ``none``
-       | **Accepted Values**:  ``none``, ``blacklist``, or ``whitelist``
+       | **Accepted Values**:  ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
 
    * - post.processor.chain
      - list
@@ -199,7 +199,7 @@ data to sink to MongoDB. For an example configuration file, see
      - | The type of value projection to use.
        |
        | **Default**: ``none``
-       | **Accepted Values**: ``none``, ``blacklist``, or ``whitelist``
+       | **Accepted Values**: ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
 
    * - writemodel.strategy
      - string
@@ -245,8 +245,8 @@ Example: Override Connector Sink Settings on TopicA
    topic.override.topicA.collection=collectionA
    topic.override.topicA.max.batch.size=100
    topic.override.topicA.document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.UuidStrategy
-   topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlacklistValueProjector
-   topic.override.topicA.value.projection.type=blacklist
+   topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector
+   topic.override.topicA.value.projection.type=blocklist
    topic.override.topicA.value.projection.list=k2,k4
 
 The sink connector topic override settings instruct the connector to apply
@@ -255,7 +255,7 @@ the following behavior for data consumed from ``topicA``:
 - Write documents to the MongoDB collection ``collectionA`` in batches of
   up to 100.
 - Generate a UUID to be stored in the ``_id`` field for each new document.
-- Omit fields ``k2`` and ``k4`` from the value projection using a blacklist.
+- Omit fields ``k2`` and ``k4`` from the value projection using a blocklist.
 
 
 Dead Letter Queue Configuration Settings