9.4.9. Configuration activation internals

Overview

This tutorial describes how configuration changes are activated in Airlock IAM.

Scope

This information is about the configuration that is editable in the Config Editor. This is the configuration that is stored as XML file (usually "medusa-configuration.xml") in the Airlock IAM instance directory.

This is not about the configuration of web servers or the low-level instance configuration stored in 8.1. application parameters.

Configuration changes are activated in the following steps:

No.
Step
Who
Description
1
Storing Configuration
Config Editor
External Component 
The configuration is written to the configuration file (usually "medusa-configuration.xml" in the instance folder) or any file included by the configuration file.
The file is usually saved by the Config Editor but it may also be a different component writing the configuration (example: you may manually edit and save the configuration file).
2
Configuration Monitoring
Modules
(loginapp, adminapp, ...) 
All modules constantly monitor their configuration (also the included configuration). If the configuration file changes, the corresponding module performs the following steps.
3
Configuration Activation
Modules
(loginapp, adminapp, ...) 
The new configuration is validated and - only if valid - activated. During this step, the module writes the configuration activation state files (see below) in order to inform the Config Editor (and possibly other components) about the progress of the configuration activation.
4
Feedback
Config Editor
External Component 
After storing the new configuration, the Config Editor (or other external Component) monitors the "activation directory" (see below) for "configuration activation state files" (see below). Reading the configuration activation states, it learns from each Module, whether the new configuration has been successfully applied or not or whether the activation is still in progress.

Configuration activation states

In order to give feedback about the configuration activation process, each module (e.g. the loginapp) writes configuration activation states. These files are read by the Config Editor (or other external component). 

The configuration activation state files are XML files written to the configuration activation folder: this is the folder .activated-configs within the instance directory (e.g. ./instances/test/.activated-configs).