10.6.4 Oracle API for MongoDB

10.6.4.1 About Oracle API for MongoDB Connections

An Oracle API for MongoDB connection stores the information that Oracle GoldenGate for Distributed Applications and Analytics uses to connect to Oracle API for MongoDB.

You can use the connection with Extract to capture transactional changes from Oracle API for MongoDB as a source and with Replicat to deliver transactional changes to Oracle API for MongoDB as a target. After you create and validate the connection, you can reuse it across multiple Oracle GoldenGate for Distributed Applications and Analytics processes.

The connection stores the connection string, authentication settings, security configuration, and optional runtime settings independently of the process configuration.

10.6.4.2 Before You Begin

Before creating an Oracle API for MongoDB connection, ensure that you have the following:

  • An Oracle GoldenGate for Distributed Applications and Analytics deployment.
  • Network connectivity between the Oracle GoldenGate for Distributed Applications and Analytics deployment and Oracle API for MongoDB.
  • A valid connection string for Oracle API for MongoDB.
  • Authentication credentials or security artifacts required for the selected security protocol.
  • The required client libraries. Download the supported client libraries by using the Dependency Downloader for MongoDB.
  • Common runtime settings, such as the runtime classpath, configured to reference the downloaded client libraries.
  • Proxy information if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses Oracle API for MongoDB through an HTTP proxy.

10.6.4.3 Create and Validate an Oracle API for MongoDB Connection

Use the Add Connection page to create an Oracle API for MongoDB connection.

Procedure

  1. In the navigation menu, select DB Connections.
  2. Click Add Connection.
  3. In Connection Alias, enter a unique name for the connection.
  4. From Technology Type, select Oracle API for MongoDB.
  5. In the Technology Settings section, provide the Oracle API for MongoDB connection information.

    Configure the following technology settings:

    • Connection String – Specifies the connection string used to establish the connection to the Oracle API for MongoDB endpoint. This field is required.
  6. Configure the Security Settings section.

    Configure the following security settings.

    PLAIN Authentication

    Configure the following settings when Security Protocol is PLAIN:

    • Username – Specifies the user name used to authenticate with the Oracle API for MongoDB endpoint.
    • Password – Specifies the password associated with the user name. This field is treated as sensitive information and is displayed as a password field.

    Note:

    The Password property is deprecated and will be replaced by passwordSecretId.
    TLS Settings

    Configure the following settings when Security Protocol is TLS:

    • Username – Specifies the user name used to authenticate with the Oracle API for MongoDB endpoint.
    • Password – Specifies the password associated with the user name.
    • TLS CA Certificate – Upload the Base64-encoded CA certificate used to validate the Oracle API for MongoDB server certificate.
    Mutual TLS (mTLS) Settings

    Configure the following settings when Security Protocol is MTLS:

    • Username – Specifies the user name used to authenticate with the Oracle API for MongoDB endpoint.
    • Password – Specifies the password associated with the user name.
    • TLS CA Certificate – Upload the Base64-encoded CA certificate used to validate the Oracle API for MongoDB server certificate.
    • Client Certificate and Private Key – Upload the client certificate and private key used for mutual TLS authentication.
    • Client Key Password – Specifies the password protecting the client private key, when applicable.

    Note:

    The TLS CA Certificate is required for TLS and MTLS authentication. The Client Certificate and Private Key is required only for MTLS authentication.

  7. Configure Common Settings, if additional runtime configuration is required.

    Configure the following common settings:

    Classpath – Specifies the runtime classpath used to load the required MongoDB client libraries. You can use Dependency Downloader to download client libraries.

    Note:

    • Download the supported MongoDB client libraries by using the Dependency Downloader for MongoDB.
    • Configure the runtime classpath to reference the downloaded client libraries before starting the Extract or Replicat process.
  8. (Optional) Configure Proxy Settings if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Oracle API for MongoDB endpoint through an HTTP proxy.

    Configure the following proxy settings:

    • Proxy URL – Specifies the URL or host name of the proxy server used to access the Oracle API for MongoDB endpoint.
    • Proxy Port – Specifies the port number of the proxy server.
    • Proxy Username – Specifies the user name for proxy authentication, if required.
    • Proxy Password – Specifies the password for proxy authentication. This field is treated as sensitive information.
    • Truststore – Specifies the Java truststore file that contains the certificate authority (CA) certificates used to validate the proxy server certificate, when required.
    • Truststore Password – Specifies the password associated with the truststore.
    • Keystore – Specifies the Java keystore file containing the client certificate and private key used for client authentication, when required.
    • Keystore Password – Specifies the password associated with the keystore.
    • SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password.

    Note:

    Configure the proxy and SSL settings only if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the Oracle API for MongoDB endpoint through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to the Oracle API for MongoDB endpoint, leave the Proxy Settings blank.
  9. Click Submit.
  10. On the DB Connections page, click DBLOGIN to validate the connection.

    Note:

    A successful DBLOGIN validates only the saved connection information. It does not validate the Extract or Replicat configuration. After successful validation, the connection is available for selection during Extract or Replicat creation.

10.6.4.4 Use an Oracle API for MongoDB Connection in Replicat

After the Oracle API for MongoDB connection has been successfully validated:

Use the Connection with Extract

  1. Create or edit an Extract.
  2. Select Oracle API for MongoDB as the source technology.
  3. Select the validated Oracle API for MongoDB connection.
  4. Complete the remaining Extract configuration.
  5. Create and start the Extract.

Use the Connection with Replicat

  1. Create or edit a Replicat.
  2. Select Oracle API for MongoDB as the target technology.
  3. Select the validated Oracle API for MongoDB connection.
  4. Complete the remaining Replicat configuration.
  5. Create and start the Replicat.

Related Topics