FX Sales JNDI configuration

This page lists the JNDI environment entries that must be present in FX Sales' J2EE web container context.

FX Sales' deployment descriptor (web.xml) contains definitions for the full set of required JNDI entries. The environment values in the deployment descriptor are not suitable for production use, and you must override these values in the web container context as part of deploying FX Sales.

JNDI environment entries

If any of the JNDI environment entries below are missing from the J2EE web container’s context, then FX Sales will raise an error.

Name Datatype Default Description

CAPLIN.DEV.MODE

String

false

Set to true to allow a liberator host and port to be specified at run time in the query string of the web application URL like this: ?liberatorHost=lib3.caplin.com&liberatorPort=18081.

CAPLIN.LOGIN.ENABLED

String

true

Enable the FX Sales built-in login page.

CAPLIN.LOGOUT.REDIRECT

String

The login page URL to redirect unauthenticated users to.

LIBERATOR.DOMAIN

String

caplin.com

Domain on which the Liberator servers are deployed.

LIBERATOR.PRIMARY.ADDRESS

String

localhost

Fully-qualified hostname of the primary Liberator server.

LIBERATOR.PRIMARY.PORT

String

18080

Primary port of the primary Liberator server.

LIBERATOR.PRIMARY.HTTPS.PORT

String

18081

HTTPS port of the primary Liberator server.

LIBERATOR.SECONDARY.ADDRESS

String

localhost

Fully-qualified hostname of the secondary (failover) Liberator server.

LIBERATOR.SECONDARY.PORT

String

18080

Primary port of the secondary (failover) Liberator server.

LIBERATOR.SECONDARY.HTTPS.PORT

String

18081

HTTPS port of the secondary (failover) Liberator server.

KEYMASTER.LOCATION

String

servlet/StandardKeyMaster

The URL of the KeyMaster servlet. The URL can be absolute or relative.

SESSION.POLL.LOCATION

String

servlet/Poll

The URL of the KeyMaster poll servlet. The URL can be absolute or relative.

caplin.keymaster.privatekey.filename

String

/WEB-INF/cfg/keymaster/privatekey.pem

Name of the private key that the KeyMaster servlet uses to sign authentication tokens.

Example configuration for Tomcat

This section shows Environment entries in an example or an FX Sales web-application context in Apache Tomcat.

The override attribute of each Environment element is set to false to prevent the value attribute from being overridden by an equivalent environment entry in FX Sales' web application deployment descriptor (web.xml). For more information on the override attribute, see The Context Container on the Apache Tomcat website.

<Context>
  <Environment name="CAPLIN.DEV.MODE"
    value="false"
    type="java.lang.String"
    override="false" />
  <Environment name="CAPLIN.LOGIN.ENABLED"
    value="true"
    type="java.lang.String"
    override="false" />
  <Environment name="CAPLIN.LOGOUT.REDIRECT"
    value=""
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.DOMAIN"
    value="example.com"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.PRIMARY.ADDRESS"
    value="lib1.example.com"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.PRIMARY.PORT"
    value="18080"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.PRIMARY.HTTPS.PORT"
    value="18081"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.SECONDARY.ADDRESS"
    value="lib2.example.com"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.SECONDARY.PORT"
    value="18080"
    type="java.lang.String"
    override="false" />
  <Environment name="LIBERATOR.SECONDARY.HTTPS.PORT"
    value="18081"
    type="java.lang.String"
    override="false" />
  <Environment name="KEYMASTER.LOCATION"
    value="servlet/StandardKeyMaster"
    type="java.lang.String"
    override="false" />
  <Environment name="SESSION.POLL.LOCATION"
    value="servlet/Poll"
    type="java.lang.String"
    override="false" />
  <Environment name="caplin.keymaster.privatekey.filename"
    value="../../conf/keymaster/privatekey.pem"
    type="java.lang.String"
    override="false" />
</Context>