Installation is done using the Software AG Installer. The Adabas REST administration is part of Adabas but does not have to be installed with Adabas. If another Adabas installation is on the installation host, this can be used, if the Adabas version is greater than or equal to Adabas Version 6.5.
Access to Adabas RESTful resources is protected using authentication. There are two possibilities to use passwords. The first possibility is to manage the configuration file realm.properties, which contains a list of users and passwords. The second possibility is the configuration of the JAAS infrastructure to provide access to LDAP, for example. The configuration of JAAS is managed in configuration/security.conf. It is recommended to use the LDAP approach, or to use any other plugin alternatives of JAAS.
This document is organized as follows:
During installation, you will be prompted by a dialog box to set the initial admin password. This password-setting feature is available from version 7.0.1 onwards.
If for any reason you need to reset the initial password at a later stage, you can do so by deleting the realm.properties configuration file in the configuration directory, and then recreating the file by running the service script as follows:
./service.bat init
You can add new user and password entries to configuration/realm.properties. The service script provides you with the functionality to add an additional user as follows:
./service.bat add_user
The Adabas RESTful server is able to manage different version of Adabas. Up to two minor version are support downwards. In this case, the Adabas Version 6.7 based Adabas RESTful server supports managing Adabas Version 6.6 and Adabas Version 6.5 databases. A prerequisite for this is to provide a corresponding Adabas version installation. The Adabas installation location has to be added to the Adabas RESTful server configuration.
The service script provides you with the functionality to add additional Adabas installations. The current status is displayed by using the following command:
./service.bat add_env
The output of this example out would look something like this:
2019-02-14 10:54:02 - Load default configuration from file /opt/softwareag/AdabasRestAdministration/configuration/config.xml Current defined configurations: ---------------------------- ADADATADIR : /data/SAG/Adabas --------------------------------------------- Location : /opt/softwareag ADAPROGDIR : /opt/softwareag/Adabas Version : V67002 Structure level : 21 ---------------------------------------------
Use the following command to add a new Software AG installation:
./service.bat add_env <Installation location>
This will add the Adabas installation to the Adabas RESTful configuration.
By default, the Adabas Data directory (ADADATADIR) is the Adabas installation
directory. You can change the default location of the Adabas Data directory with the
change_adadatadir.sh or
change_adadatadir.bat command. For details on how to change
the Adabas Data directory, see Installation on Windows > Completing the
Installation or Installation on Linux >
Completing the
Installation.
You can then modify the location of the Adabas Data directory used by the Adabas REST server in the REST server configuration with the following service script:
./service.sh data_dir <new Adabas Data directory location>
Inside the installation directory of the Adabas REST administration, a bin directory can be found. The bin directory contains all of the start scripts required to start the Adabas REST administration. All scripts will provide reference information about valid parameters in case no argument is entered.
For example, to start the REST server on Windows just start:
./service.bat run
To check if the server works correctly, you can either use your favorite web browser or use curl. By default, the username is admin and the password is manage.
Use the following command to check whether the server is running:
http://<host>:<port>/adabas/database
where <host> and <port>
correspond to your environment. The following are some example REST calls:
| URL | Function | Result |
|---|---|---|
| http://localhost:8120/adabas/database | List databases | List all databases known to the REST server |
| http://localhost:8120/adabas/database/24 | Database Info | Returns the database information for database 24 |
| http://localhost:8120/adabas/database/24/file | List database files | List all files defined in the database 24 |
Using curl, the following command would correspond to the first example:
curl -vv --user admin:manage http://localhost:8120/adabas/database