Compiling the sample Java custom credential user exits (UNIX and Linux)

The CDC Replication Engine for InfoSphere® DataStage provides sample custom data formats that can be extended or modified to suit the required environment.

About this task

The sample files are located in the samples directory within the CDC Replication Engine for InfoSphere DataStage® installation. The file includes the following samples:
  • ExternalCredentialStorageS3UserexitSample.java—Implements a credentials user exit for connecting to S3.
  • ExternalCredentialStorageAzureUserexitSample.java—Implements a credentials user exit for connecting to Azure Data Lake Storage.

Procedure

  1. Before the CDC instance configuration tool, start by copying the custom credentials user exit of your choice into <installation_directory>/lib/com/datamirror/ts/external/keystore.
  2. Update the sample custom credentials user exit.

    There are comments added in the user exit to help users with its working.

  3. Compile the modified custom credentials user exit. For instance, if you want to compile ExternalCredentialStorageS3UserexitSample.java, open a command window, navigate to the lib folder and issue the following command: javac -classpath .:./* com/datamirror/ts/external/keystore/ExternalCredentialStorageS3UserexitSample.java.

    If this command runs successfully, there is no output on the screen.

    Prerequisite: Your system must have the Java JDK to run this command.

    Note: It is recommended to compile user exits with Java 17. Compiling user exits with Java 16 and lower is not supported.
  4. After running the command successfully, navigate to the following directory and confirm that you have created a ExternalCredentialStorageS3UserexitSample.class file: <installation_directory>/lib/com/datamirror/ts/external/keystore/.
  5. Start to create a cdc instance.

    The instance configuration tool will prompt to provide

  6. At last, specify the fully qualified path to ExternalCredentialStorageS3UserexitSample in Instance configuration tool. For instance, com.datamirror.ts.external.keystore.ExternalCredentialStorageS3UserExitAPISample.
    Note: Avoid specifying the .class extension.

    When the Java class is modified or changed, the CDC Replication Engine for InfoSphere DataStage instance must be restarted to pick up the changed user exit.

What to do next

Note: When the Java class is modified, the CDC Replication instance must be restarted to pick up the updated user exit.
Note: If you plan to use the sample custom credentials user exit in production environments, test the samples before deploying. IBM is not liable for adverse outcomes caused by changes to custom data formats.