Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

BYOK REST APIs

Deploy BYOK War File

search

Please Note:

Deploy BYOK War File

The CADP for Java sfbyok.war file can be deployed on a web server. This article describes how to deploy the sfbyok.war file on a web server running Tomcat version 9.

Prerequisites

To deploy BYOK for AWS ensure that:

  1. Tomcat version 9 or higher is installed.

  2. Any of the supported Java version is installed on your machine. Refer to General system architecture for details.

    In case of Java 11 or higher, copy the following jar files to the Tomcat’s lib directory:

    • jaxb-api-2.3.1

    • jaxb-core-2.3.0.1

    • jaxb-impl-2.3.1

    • activation- 1.1.1

  3. The /jre/lib/ext directory should not have the CADP for Java provider jar files.

Note

We are migrating BYOK REST API support to open-source as integration. To handle this migration, 8.15.0 release onward, the sfbyok.war file will not be bundled with the CADP for Java package. Soon, BYOK REST API support will be available as open-source.

Steps to deploy

  1. Extract the file using any standard archive utility.

    Extracting the archive creates the following directory structure:

    For information on directory structure and its content, refer to Directory Structure.

  2. Configure the location of the CADP_for_JAVA.properties file from the \CADP_for_JAVA\lib\ext directory by creating an environment variable with the name INGRIAN_CONF_PATH as shown below.

    Environment Variable

    On Linux machines, run the following command to set the environment variable for INGRIAN_CONF_PATH:

    
export INGRIAN_CONF_PATH=/

  3. Copy the sfbyok.war file from the \CADP_for_JAVA\webservices\sfbyok directory to the %CATALINA_HOME%\webapps directory. If Tomcat is already running, it may automatically extract the contents to the %CATALINA_HOME%\webapps\sfbyok directory.

    If INGRIAN_CONF_PATH is not set, the CADP_for_JAVA.properties file stored at the %CATALINA_HOME%\webapps\sfbyok\WEB-INF\classes directory is used.

    Note

    The Tomcat server should be configured with a Fully Qualified Domain Name (FQDN) and SSL certificate for SSL communication. The Named Credential in Salesforce accepts only (FQDN) and SSL certificate. This step is applicable to Salesforce only.

  4. Add the log4j-api-2.19.0 and log4j-core-2.19.0.jar files to the classpath.

  5. Restart the Apache-Tomcat server. While deploying the sfbyok.war, if a folder with same sfbyok name already exists in the webapps folder, then delete the existing folder for clean deployment before starting the Tomcat server.

  6. Edit the following parameters in the CADP_for_JAVA.properties file:

    NAE_IP.1NAE_PORTProtocol
    Client_Cert_AliasClient_Cert_PassphraseKey_Store_Location
    Key_Store_Location

  1. Extract the file using any standard archive utility.

    Extracting the archive creates the following directory structure:

    For information on directory structure and its content, refer to Directory Structure.

  2. Configure the location of the CADP_for_JAVA.properties file from the \CADP_for_JAVA\lib\ext directory by creating an environment variable with the name INGRIAN_CONF_PATH as shown below.

    Environment Variable

    On Linux machines, run the following command to set the environment variable for INGRIAN_CONF_PATH:

    
export INGRIAN_CONF_PATH=/

    If INGRIAN_CONF_PATH is not set, the CADP_for_JAVA.properties file stored at the %CATALINA_HOME%\webapps\sfbyok\WEB-INF\classes directory is used.

  3. Create a folder named webapps-javaee in the Apache Tomcat 10 directory.

    While deploying the sfbyok.war, if a folder with same sfbyok name already exists in the webapps folder, then delete the existing folder for clean deployment before starting the Tomcat server.

  4. Place the sfbyok.war file in the webapps-javaee folder.

  5. Add the log4j-api-2.19.0 and log4j-core-2.19.0.jar files to the classpath.

  6. Run the startup batch file placed in the bin directory of Apache 10.

  7. Shutdown the Tomcat server.

  8. Navigate to the webapps\sfbyok\WEB-INF\lib directory and replace the existing CADP_for_Java-8.14.0.001.jar with the one present in the ext directory of the CADP for Java SDK package.

  9. Restart the Tomcat server.

  10. Edit the following parameters in the CADP_for_JAVA.properties file:

    NAE_IP.1NAE_PORTProtocol
    Client_Cert_AliasClient_Cert_PassphraseKey_Store_Location
    Key_Store_Location

Important Notes

  • The Tomcat server must be restarted after making changes in the CADP_for_JAVA.properties file.

  • The CADP for Java BYOK is supported in remote mode only.

  • For logging, the log.file path parameter must be set in the application.properties file located in the %CATALINA_HOME%\webapps\sfbyok\WEB-INF\classes directory.

On this page