Preparation
DTS produces Webservices in the form of WebARchives, which contain all the necessary libraries for the service to run. As such, most Application Servers should be able to deploy and run the DTS Webservices.
To prepare the Application Server for DTS Webservices, the environment variables which direct specify the DTS connection point need to be set within the server's configuration files. These variables are:
DTS_REDIS_HOST_NAME |
The host name for the DTS Redis Server |
DTS_REDIS_PORT |
The port for the DTS Redis Server |
DTS_SYNC_INIT |
[true/false] Whether the Webservice client will initialize the project synchronously (i.e. delay the first request until initialization is done and a response can be provided). Default is false. |
Different Application Servers will have different ways of setting these variables. Here are some common examples:
Application Server |
OS |
Instructions |
Tomcat |
Linux |
•edit or create the [CATALINA_HOME]/bin/setenv.sh file •add the following: # DTS export DTS_REDIS_HOST_NAME=[...] export DTS_REDIS_PORT=[...]
•save the file and restart Tomcat |
Windows |
•edit or create the [CATALINA_HOME]\bin\setenv.bat file •add the following: # DTS set DTS_REDIS_HOST_NAME=[...] set DTS_REDIS_PORT=[...]
•save the file and restart Tomcat |
|
JBoss/Wildfly |
Linux |
•edit the [JBOSS_HOME]/bin/standalone.sh file •add the following (preferably at the beginning): # DTS export DTS_REDIS_HOST_NAME=[...] export DTS_REDIS_PORT=[...]
•save the file and restart JBoss/Wildfly |
Windows |
•edit the [JBOSS_HOME]\bin\standalone.bat file •add the following (preferably at the beginning): # DTS set DTS_REDIS_HOST_NAME=[...] set DTS_REDIS_PORT=[...]
•save the file and restart JBoss/Wildfly |
For instructions regarding other Application Servers, please consult the vendor's documentation.
If the Application Server is configured together with DTS using docker-compose, the environment variables can usually be set there.
Being based on the Client Java Library, Webservices also respond to all other environment variables specified there.
Additionally, the DTS Webservice responds to certain environment variables for configuring specific logging parameters (see Webservice Logging).
If the security scheme is enabled in the DTS cluster, the Webservice must also implement it. See Security Setup for details.
Exploded Deployment
DTS Webservices need to be able to dynamically load libraries at runtime. While all the required libraries are bundled inside a service WAR, these need to be accessible after deployment, so the WAR must be exploded.
Depending on the Application Server and deployment method, this will either be done automatically, or may require some extra steps. Here are some common examples:
Application Server |
DTS Deployment |
Exploding |
Tomcat |
SCP/Samba (automatic copy) |
Done automatically by the Application Server |
Tomcat |
WAR (web console / manual copy) |
Done automatically by the Application Server on WAR deployment |
Tomcat |
TomcatHTTP |
Done automatically by the Application Server |
JBoss/Wildfly |
SCP/Samba (automatic copy) |
Not done automatically - exploded flag must be set in the App Server Parameters to instruct DTS to do it |
JBoss/Wildfly |
WAR (web console / manual copy) |
The WAR file must be unzipped into a directory with the same name (including ".war") and the directory must be copied into the deployments folder of the Application Server
|
JBoss/Wildfly |
JBossCLI |
Done automatically by DTS
|
See App Server Parameters for details on all the supported deployment methods.