10.8.4 Generic JMS

10.8.4.1 About Generic JMS Connections

A Generic JMS connection stores the information that Oracle GoldenGate uses to connect to a Java Message Service (JMS) provider. After the connection is created and validated, you can reuse it when configuring Replicat processes that publish transactional messages to JMS destinations.

The connection stores the JMS connection information, optional JNDI configuration, security settings, and runtime configuration independently of the Replicat configuration. This enables multiple Replicat processes to reuse the same validated connection.

10.8.4.2 Before You Begin

Before creating a Generic JMS connection, ensure that you have the following:

  • An Oracle GoldenGate deployment.
  • Network connectivity between the Oracle GoldenGate deployment and the JMS provider.
  • A JMS connection URL.
  • A JMS connection factory name.
  • Authentication credentials, if required by the JMS provider.
  • JNDI configuration information, if the deployment uses JNDI.
  • Truststore and keystore files if the JMS provider uses TLS or mutual TLS (mTLS).
  • Common runtime settings, such as the runtime classpath, if additional JMS client libraries are required.
  • Proxy information if the Oracle GoldenGate deployment accesses the JMS provider through an HTTP proxy.

10.8.4.3 Create and Validate a Generic JMS Connection

Use the Add Connection page to create a Generic JMS 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 Generic JMS.
  5. In the Technology Settings section, provide the Generic JMS connection information.

    Configure the following technology settings:

    • Use JNDI – Specifies whether Oracle GoldenGate for Distributed Applications and Analytics obtains JMS resources by using the Java Naming and Directory Interface (JNDI).
    • Connection URL – Specifies the JMS provider connection URL. Configure this field when Use JNDI is disabled.
    • Connection Factory – Specifies the JMS connection factory. Configure this field when Use JNDI is disabled.
    • Username – Specifies the JMS user name, if required by the JMS provider.
    • Password – Specifies the password associated with the JMS user name. This field is treated as sensitive information and is displayed as a password field.

      Note:

      When Use JNDI is enabled, Oracle GoldenGate for Distributed Applications and Analytics uses the JNDI configuration instead of the direct JMS connection settings.
  6. Configure the JNDI Settings section if Use JNDI is enabled.

    Configure the following JNDI settings:

    • JNDI Connection Factory – Specifies the JNDI name of the JMS connection factory.
    • JNDI Provider URL – Specifies the URL of the JNDI provider.
    • JNDI Initial Context Factory – Specifies the fully qualified Java class name that implements the initial context factory.
    • JNDI Security Principal – Specifies the principal used for JNDI authentication.
    • JNDI Security Credentials – Specifies the credentials used for JNDI authentication. This field is treated as sensitive information.
  7. Configure the Security Settings section, if secure communication is required.

    Configure the following security settings:

    • Security Protocol – Specifies the communication protocol. Supported values are PLAIN, TLS, and MTLS.
    • Truststore – Specifies the truststore file used to validate the JMS server certificate. Configure this field when Security Protocol is TLS or MTLS.
    • Truststore Password – Specifies the password associated with the truststore, if applicable.
    • Keystore – Specifies the keystore containing the client certificate and private key. Configure this field when Security Protocol is MTLS.
    • Keystore Password – Specifies the password associated with the keystore, if applicable.

    Note:

    Configure only the security properties required by the selected security protocol.
  8. Configure Common Settings, if additional runtime configuration is required.

    Configure the following common settings:

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

    Note:

    • Download the supported JMS client libraries by using the Dependency Downloader for Generic JMS.
    • Configure the runtime classpath to reference the downloaded client libraries before starting the Replicat process.
  9. (Optional) Configure Proxy Settings if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses the JMS provider 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 JMS provider.
    • 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 JMS provider through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to the JMS provider, leave the Proxy Settings blank.
  10. Click Submit.
  11. 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 Replicat configuration or Generic JMS Handler configuration. After successful validation, the connection is available for selection during Replicat creation.

10.8.4.4 Use a Generic JMS Connection in Replicat

After the Generic JMS connection has been successfully validated:

  1. Create or edit a Replicat.
  2. Select Generic JMS as the target technology.
  3. Select the validated Generic JMS connection.
  4. Complete the remaining Replicat configuration.
  5. Create and start the Replicat.