Skip to main content
Version: 1.17

Deployment using JAR file

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

ADS supports the following commands:

  • check

    To parse and validate the deployment configuration of the application.

  • server

    To initialize the service.

Before proceeding to the deployment of ADS make sure that you have properly configured deployment.yaml as described in Basic configuration.

Validate the deployment configuration file​

Use the check command to validate your deployment.yaml file:

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

This verifies that the deployment configuration, user file, and license file are correctly set.

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 occur, an OK message is displayed.

Deploy the application​

ADS is a Java application and requires specifying the necessary resources in the classpath during startup.

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

The main class for the ADS application is com.axiomatics.ads.App.

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.17.0.jar;[attribute-connector-name].jar;[JDBC-driver-name].jar" server [path_to_file]/deployment.yaml

For Linux:

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

For more information on attribute connectors, see Attribute Connectors.

Important considerations​

  • When adding a .jar file to the classpath, ensure that all of its dependencies are included.
  • 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.
  • When configuring the classpath with multiple .jar files, it's important to ensure compatibility. Place either the ADS .jar file or the slf4j-api-2.x.jar file at the beginning of your classpath in the java command. This arrangement helps to avoid potential compatibility issues. For more information refer to the Compatibility for slf4j-api versions section.
  • 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, the operating system and the Java environment.

Verify 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 endpoint for more information.

See System information endpoint about how to access system information data through an administration endpoint.

Next steps​

  • Further customize the basic deployment configuration file (deployment.yaml) to suit your specific needs. Refer to Basic configuration for more information.
  • Consider using the ADS caching features to further improve the system's performance. See the Attribute caching section for more information.
  • Explore additional configuration options to optimize your ADS implementation. See the section Additional configurations for more information.