The most recent patch for this version is 26.2.1.  Learn more

Skip to main content
Version: 26.2

Deploy as a JAR

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

For initial configuration, see Configure ADS.

Prerequisites​

Before you deploy, make sure you have the following:

  • Java SE 17 (64-bit) or Java SE 21 (64-bit) installed on the host machine
  • ADS JAR file: the .jar file you downloaded from Axiomatics
  • Deployment configuration file: a deployment.yaml file that references a valid domain and a valid license (see Configure ADS)
  • Axiomatics license file: provided separately by Axiomatics

Prepare the deployment​

Arrange your files in the following structure before you start ADS:

├─ access-decision-service-26.2.1.jar
├─ deployment.yaml
├─ lib                          ← optional; required only for additional drivers
    ├─ custom-attribute-connector.jar
    ├─ jdbc-driver.jar
caution

Place deployment.yaml in the same folder as the ADS JAR file. ADS looks for deployment.yaml in the current working directory at startup.

Create a minimal deployment.yaml​

The following example is the minimum configuration ADS needs to start:

# deployment.yaml — minimal configuration

engine:
  mode: ads

license: file:axiomatics_ADS.license

domain:
  path: domain.yaml

spring:
  security:
    user:
      name: admin
      password: changeme
tip

Store passwords as environment variables rather than plain text. Use the syntax ${MY_ENV_VAR:default_value} anywhere in deployment.yaml.

For a complete reference of all configuration properties, see Configuration reference.

Include additional JAR files (optional)​

If your deployment requires additional resources, for example a JDBC driver or custom Attribute Connectors, place all relevant .jar files in a lib folder at the same level as the ADS JAR.

note

The SQL and Table Attribute Connectors require a JDBC driver to connect to the database.

See Attribute Connectors for more information.

Run the JAR​

Run the following command from the directory that contains deployment.yaml and the lib folder:

java -jar <path_to_file>\access-decision-service-26.2.1.jar
caution

Run the java command from the directory that contains the deployment.yaml file and the lib folder. If you run it from a different directory, ADS will not find your configuration.

To load deployment.yaml from a different location, pass the path explicitly:

java -jar access-decision-service-26.2.1.jar \
  --spring.config.location=file:/path/to/deployment.yaml

Verify the service​

After you start ADS, confirm it is running by sending a GET request to the health endpoint:

GET http://localhost:8080/health
note

By default, management endpoints (including /health) are accessible on server.port (default: 8080). If you have configured a separate management.server.port, use that port instead. See Configuration reference.

A successful response returns 200 OK with a JSON body that shows the overall status and individual component states:

{
    "status": "UP",
    "components": {
        "diskSpace": {
            "status": "UP",
            "details": { }
        },
        "liveness": {
            "status": "UP",
            "details": { }
        },
        "ping": {
            "status": "UP"
        },
        "readiness": {
            "status": "UP",
            "details": { }
        },
        "startup": {
            "status": "UP"
        }
    },
    "groups": [
        "customProbes"
    ]
}
note

If the response shows "status": "DOWN", check the application logs for errors related to the license file, domain path, or authentication configuration.

For more information, see Healthcheck endpoints and System information endpoint.

Next steps​

After you verify that ADS is running, explore additional configuration options: