esdlmapeditoressim/esdl-drive repository overview

⁠ESDL Drive API

⁠Introduction

This project provides a REST interface for Eclipse CDO (Connected Data Objects) and can be integrated in the MapEditor.

There is also a commandline tool available to interact with the ESDLDrive and is available from its Github repository⁠.

It uses Open Liberty as Java server runtime. It supports Eclipse Microprofile and openIdConnect out of the box.

⁠Environmental variables

The software can be configured using microprofile.properties, server.env and server.xml files. Additionally a keycloak.xml is used to configure keycloak. The default configuration is made for the localhost setup with a keycloak server hosted on your local machine.

Some settings can be changed by using Environmental variables using the following properties:

⁠CDO server host and port:

CDO_SERVER_HOST=localhost:2036

⁠Repository name at the CDO server

CDO_REPOSITORY_NAME=esdldrive

⁠KEYCLOAK realm

KEYCLOAK_REALM defaults to http://keycloak:8080/auth/realms/esdl-mapeditor

⁠KEYCLOAK external accessible URL

In localhost deployements of keycloak in docker you need to make a difference between the external accessible URL and the internal one.

keycloak_realm_external defaults to {keycloak_realm}

⁠KEYCLOAK client secret for cdo-mondaine

The ESDL Drive uses cdo-mondaine as client. It secret is defined using: keycloak_client_secret. It defaults to the one used for the localhost deployment in docker. Users need the group of cdo_read to read and write to the ESDLDrive.

⁠Keytool password

All keys and certificates (see certificates/certificate.md) are stored in a java keystore. You need the keytool password to access this keystore. (see also server.xml)