Deploy the web servlet

Use this procedure to deploy the staged HTTP servlet on a supported web server application. See Staged HTTP files to deploy to find the servlet files in Interchange directory tree. The servlet has been validated against the following web servers:

  • Apache Tomcat 8.0.15
  • Oracle WebLogic 12c
  • IBM WebSphere 8.5.5

After deploying the servlet on the web server, do not edit any of the servlet files, except as recommended by the user documentation or technical support. In particular, do not change or move the activation.xml file. This is the license file for the servlet. Changing this file makes the servlet inoperable.

The servlet uses three file system directories for processing messages and logging information. Servlet files control the paths for these directories. The following are the default directory paths. The name of the file that defines each path also is listed. You can change the path by editing the file.

Directory type

Default path

File that defines path

Message
processing

Windows:
C:\opt\cyclone\data\stagedhttp

Unix:
/opt/cyclone/data/stagedhttp

conf\
configurationrules.
xml

Message
temporary

Windows:
C:\opt\cyclone\tmp\mailbox-data

Unix:
/opt/cyclone/tmp/mailbox-data

conf\
webmailboxconfig.
xml

The message directories are created when the servlet is deployed and running. On UNIX make sure the user has permissions to add directories.

Deploy on WebLogic

Use the following steps to deploy the staged HTTP servlet on a WebLogic web server. These steps are provided as guidelines. See the web server user documentation for specifics about deploying servlets.

  1. Create a directory called /logs inside the “domain_name” (default: mydomain) folder that the staged http application will be a part of. Logging related to the staged HTTP application is written into this /logs folder.
  2. Log on to the weblogic administration UI.
  3. Create users for communityadmin, ecengine, mailboxadmin, and remoteuser. Do not create roles for these users.
  4. Deploy the servlet by pointing to the war file or to the extracted tar file contents.
  5. Use default options for deploying. In particular, the security model option must be DD Only: Use only roles and policies that are defined in the deployment descriptors.

6. Once deployed, enable start servicing all requests from the summary of deployments page.

7. When the previous steps are complete, confirm that the user can log on to the servlet’s UI.

Deploy on Apache Tomcat

Use the following steps to deploy the staged HTTP servlet on an Apache Tomcat web server. These steps are provided as guidelines. See the web server user documentation for specifics about deploying servlets.

  1. Create a folder called /logs inside the bin folder. This is the folder where you invoke the startup scripts. Logging related to the stagedhttp application is written into this /logs folder.
  2. On the Tomcat installation folder, edit the tomcat-users.xml file, adding the following users and roles. Follow the format suggested in the file: first declare the roles, and then map the roles to the user and password.
  3. Map the user...

    ...to the role

    mailboxadmin

    mailboxadmin_role

    ecengine

    ecengine_role

    remoteuser

    remoteuser_role

    communityadmin

    communityadmin_role

  4. Logon to the Tomcat UI. Access the “Manager App”.
  5. If you do not have logon credentials, you can manage them in the file tomcat-users.xml.
  6. Deploy the staged http servlet by pointing to the war file.
  7. Log on to the servlet UI.

Deploy on WebSphere

Use the following steps to deploy the staged HTTP servlet on a WebSphere web server. These steps are provided as guidelines. See the web server user documentation for specifics about deploying servlets.

  1. Stagedhttp-related logging is written into the /logs folder that resides in the profile_root directory. For example, if the profile name is appserver01, the logs directory is …profiles/appserver01/logs. This logging directory is created automatically.
  2. Log on to the WebSphere administration UI.
  3. Working in the Users section of the UI, create the following users. Do not create their corresponding roles:
    • ecengine
    • communityadmin
    • mailboxadmin
    • remoteuser
  4. Deploy a new enterprise application by pointing to the stagedhttp.war. Provide the context root when prompted. The default string for the context root is stagedhttp.
  5. Map the newly-created users to the roles that are added as the servlet is deployed:
  6. Map the user...

    ...to the role

    mailboxadmin

    mailboxadmin_role

    ecengine

    ecengine_role

    remoteuser

    remoteuser_role

    communityadmin

    communityadmin_role

  7. Save changes when prompted.
  8. Start the application ‘stagedhttp’ from the Applications list page.

Log on to the servlet UI.

Related topics

Related Links