Skip to content

Configuration Document Store Connector

The configuration store connectors contain the connector implementations that manage the storage of Configuration Documents for OMAG Servers.

Configuration Document Store Connector

There is one configuration document store connector defined for each OMAG Server Platform.

The configuration document's persistence is managed by the configuration document store connector.

By default, the configuration document is stored as an encrypted JSON in a file under the default directory for the OMAG Server Platform that creates them.

Configuration documents may contain security certificates and passwords and so should be treated as sensitive. It is possible to change the storage location of configuration documents - or even the type of store.

Configuration document store connector interface

The admin-services-api module provides the interface definition for this connector. Its interface is simple -- consisting of save, retrieve and delete operations:

```java
/**
 * OMAGServerConfigStore provides the interface to the configuration for an OMAG Server.  This is accessed
 * through a connector.
 */
public interface OMAGServerConfigStore
{
    /**
     * Save the server configuration.
     * 
     * @param configuration configuration properties to save
     */
    void saveServerConfig(OMAGServerConfig   configuration);


    /**
     * Retrieve the configuration saved from a previous run of the server.
     *
     * @return server configuration
     */
    OMAGServerConfig  retrieveServerConfig();


    /**
     * Remove the server configuration.
     */
    void removeServerConfig();
}
```

The configuration document is represented by the OMAGServerConfig structure. The name of the server is stored in the localServerName property in OMAGServerConfig.

Sample implementations

The implementations of this connector provided by Egeria are found in the configuration-store-connectors module. There are two connectors:

It is also possible to write your own implementation.

Configuring the connector

See configuring the configuration document store for the command to install a particular configuration document store connector into the OMAG Server Platform.