Skip to main content
Version: 1.14

Deployment using jar file

This section describes how to run the Access Decision Service (ADS) application using the .jar file.

Download the jar file​

After configuring your AWS CLI account, run the following command in the terminal to download the jar file:

aws s3api get-object --bucket axiomatics-customer-artifacts --key releases/com/axiomatics/access-decision-service/access-decision-service/1.14.0/access-decision-service-1.14.0.jar access-decision-service-1.14.0.jar

This downloads the selected file to your computer.

Deploy the application​

ADS is a Java application and needs to be started with the required resources added to the classpath.

java -jar access-decision-service-1.14.0.jar server <path_to_file>/deployment.yaml

The main class is com.axiomatics.ads.App.

Important

1. When adding a jar file to the classpath, all of its dependencies must be included.

2. When using the classpath option to retrieve files, the files must either be packaged in a jar or zip file, or accessed using the directory reference to where the file is located.

3. When using the classpath option for multiple .jar files, make sure that the ADS .jar file is always first in the java command.

When the message "Application command 'server' was executed successfully." is displayed in the console, the application is running.

You can use extra resources in your deployment, such as attribute connectors, by adding them in the classpath.

Adding additional resourcess

The following example displays the java command to deploy ADS with an attribute connector and a JDBC driver:

For Windows:

java -cp "access-decision-service-1.14.0.jar;[attribute-connector-name].jar;[JDBC-driver-name].jar" server [path_to_file]/deployment.yaml

For Linux:

java -cp access-decision-service-1.14.0.jar:[attribute-connector-name].jar:[JDBC-driver-name].jar server [path_to_file]\deployment.yaml

For more information, refer to Attribute Connectors.

Configuration validation​

The check command parses and validates the configuration of the application.

java -jar access-decision-service-1.14.0.jar check <path_to_file>/deployment.yaml

It can be used to verify that the deployment configuration file, user file, and the license file are correct.

By default, errors are output to stderr, for example:

<path_to_file>/deployment.yaml has an error:
* license License is corrupt or not valid: <path_to_file>/file

If no errors are found, an OK message is given.

Application version information​

The default logging level for ADS is WARN. If set to INFO, during start-up, ADS will log one line with version information about the application and the operating system, etc. The logged information includes:

  • Application Name
  • Application Vendor
  • Application Version
  • Application Build Version
  • CLI Arguments
  • Java Home Directory
  • Java Vendor
  • Java Version
  • Operating System Architecture
  • Operating System Name
  • Operating System Version

The information may be useful to have when communicating with customer support. See System information about how to access this data via an administration endpoint.

Checking that ADS is running​

To verify that ADS is running smoothly, you can run a simple healthcheck by running a GET request:

  GET http://localhost:8081/healthcheck

This will result in Status: 200 OK and a JSON reply, like the following:

{
  "Access Decision Service Health": {
    "healthy": true,
    ...
  },
  "deadlocks": {
    "healthy": true,
    ...
  }
}

See also the section Healthcheck for more information.

Next steps​

  • The instructions above assume ADS is started with a basic deployment configuration file. This file can be further edited to adapt to your configuration requirements. See the section Deployment configuration for more information.
  • You can use the distributed cache feature to further improve the system's performance. See the Distributed cache section for more information on this feature.
  • There are also additional configurations you may want to consider for your implementation of ADS. See the section Additional configurations for more information.