ConversionQA REST server configuration

Host

The default host of the server is http://localhost:8080

To change this, set the host system property when starting the rest server:

CODE

java -Dhost=http://localhost:1234 -jar deltaxml-conversion-qa-1.0.0.jar start-rest-server

This cannot be used with Fixed Host REST licenses. If you need to change the port etc, contact DeltaXML.

HTTPS

To use HTTPS you will need to generate an SSL Certificate that can be verified with a Certificate Authority's keys that are included in the JDK. We have internally tested and recommend using Let's Encrypt (https://letsencrypt.org), using this guide to import a Let's Encrypt certificate into a Java KeyStore. One extra detail the guide doesn't tell you is you should also specify a password for the key itself (i.e. using the -destkeypass parameter)

You will need to use the same password for the KeyStore and the Key itself.

When starting up the REST service, use the Java system properties keystore and keypass to specify the location of the KeyStore, and the password for the KeyStore/Key, for example:

CODE

java -Dkeystore=/Users/exampleUser/rest/keystore.jks -Dkeypass=password -jar deltaxml-conversion-qa-1.0.0.jar

If using Postman to test the API - if you didn't use Let's Encrypt and chose to use a self-signed certificate, you may need to disable "SSL Certificate Verification" in the Postman Settings.

Logging

ConversionQA REST uses the standard java.util.logging logger with the package com.deltaxml.conversionqa.rest

For example a logging.properties file that can be placed in the installation directory. Alternatively the Java property java.util.logging.config.file can be used when starting the service, i.e.:

TEXT

java -Djava.util.logging.config.file=/path/to/logging.properties -jar deltajson-conversion-qa-x.y.z.jar

For example:

TEXT

handlers = java.util.logging.FileHandler, java.util.logging.ConsoleHandler
.level = OFF
com.deltaxml.conversionqa.rest.level = FINER
java.util.logging.FileHandler.level     = FINER
java.util.logging.FileHandler.pattern   = conversionqa.log

java.util.logging.ConsoleHandler.level     = FINE

Default Catalog

You can use the standard xml.catalog.files property (either as a Java system property or through the deltaxmlConfig.xml file - see Configuration Properties) to specify the catalog files to be used so you don't have to specify catalog on each request.

License Servers

Use the license-servers argument when starting the REST server to provide a comma separated list of license servers:

CODE

java -jar deltaxml-conversion-qa-1.0.0.jar start-rest-server license-servers=http://example.com/cqa-server

License Files

Use the license-files argument when starting the REST server to provide a comma separated list of license files:

CODE

java -jar deltaxml-conversion-qa-1.0.0.jar start-rest-server license-files=/path/to/deltaxml-conversion-qa-rest.lic