Jump to: navigation, search

Orion/Documentation/Developer Guide/Configuration services

Overview of configuration services

Orion provides a number of service APIs related to service configuration. This page explains the service configuration APIs. For a basic overview of Orion's service architecture, see Architecture.

Managed Services

A service may need configuration information before it can perform its intended functionality. Such services are called Managed Services. A Managed Service implements a method, updated(), which is called by the Orion configuration framework to provide configuration data to the service. As with all service methods, updated() is called asynchronously. The configuration data takes the form of a dictionary of key-value pairs, called properties. If no configuration data exists for the Managed Service, null properties are passed.

A Managed Service needs to receive its configuration information before the service is invoked to perform other work. For example, a configurable validation service would want to receive any custom validation options (or null, if no custom options were configured) before actually performing any validation. For this reason, the framework guarantees that a Managed Service's updated() method will be called prior to any other service methods the service may implement.

To contribute a Managed Service, we register a service having the name orion.cm.managedservice. Every Managed Service must provide a service property named "pid" which gives a PID (persistent identifier). The PID serves as primary key, uniquely identifying the configuration information of a Managed Service.

The Orion concept of a Managed Service is analogous to the OSGi Managed Service.

Meta Typing

A Metatype describes the shape of configuration data*. In other words, it specifies what property names can appear in the properties dictionary, and what data types their values may have (string, boolean, number, etc). Metatype information is defined in terms of Object Class Definitions (OCDs), which can be reused. Metatype information is associated with a Managed Service's PID. Metatype information is optional, so not every Managed Service need have Metatype information associated with it.

Metatype information can be contributed by registering a service with the orion.cm.metatype service name.

The Orion concept of a Metatype is analogous to the OSGi Metatype.

* In this page we discuss Metatype information solely in the context of configuration management. Strictly speaking, Metatypes are generic, and can be used for other purposes.

Configuration management

Configuration data is managed by a ConfigurationAdmin service, which maintains a database of Configuration objects. The ConfigurationAdmin monitors the service registry and provides configuration data to Managed Services that are registered. Orion's implementation of ConfigurationAdmin persists configuration data to a Preferences Service.

In JavaScript code, configuration information is represented as Configuration objects, which are returned by the ConfigurationAdmin's service methods. (Refer to "orion.cm.Configuration" in the client API reference for JSDoc.) Because the ConfigurationAdmin service is currently only accessible to code running in the same window as the service registry, Configuration objects cannot be directly interacted with by external services. Managed Services can only receive configuration information via their updated() method.

The Orion ConfigurationAdmin service is analogous to the OSGi ConfigurationAdmin.

Settings

On top of the basic configuration and metatype APIs, Orion also provides a higher-level Settings API. See Plugging into the settings page for details.

orion.cm.configadmin

The orion.cm.configadmin service, also called ConfigurationAdmin, provides management of configuration information. Internally, the ConfigurationAdmin service is used by the Settings page to manage the values of plugin Settings.

The service methods are:

getConfiguration(pid)
Returns the Configuration with the given PID from the database. If no such Configuration exists, a new one is created and then returned.
listConfigurations()
Returns an array of all current Configuration objects from the database.

Refer to orion.cm.ConfigurationAdmin in the client API reference for a full description of this service's API methods.

Here is an example of how to use the ConfigurationAdmin service to print out all existing configurations and their property values:

var configurations = serviceRegistry.getService("orion.cm.configadmin").listConfigurations().then(function(configurations) {
        configurations.forEach(function(configuration) {
            var properties = configuration.getProperties();
            var propertyInfo = Object.keys(properties).map(function(propertyName) {
                if (propertyName !== "pid") {
                    return "\n        " + propertyName + ": " + JSON.stringify(properties[propertyName]) + "\n";
                }
            }).join("");
            console.log("Configuration pid: " + configuration.getPid() + "\n"
                      + "  properties: {" + propertyInfo + "\n"
                      + "  }");
        });
});

The result might look something like this:

Configuration pid: nonnls.config
  properties: {
        enabled: false
  }
Configuration pid: jslint.config
  properties: {
        options: "laxbreak:true, maxerr:50"
  }

orion.cm.managedservice

Contributes a Managed Service. A Managed Service is a service that can receive configuration data.

Service properties

A Managed Service must define the following property:

pid
String Gives the PID for this Managed Service.

Service methods

A Managed Service must implement the following method:

updated(properties)
The ConfigurationAdmin invokes this method to provide configuration to this Managed Service. If no configuration exists for this Managed Service's PID, properties is null. Otherwise, properties is a dictionary containing the service's configuration data.

Examples

This minimal example shows the implementation of a plugin which registers a Managed Service under the PID "example.pid". When its updated() method is called, it simply prints out what it received:

define(["orion/plugin"], function(PluginProvider) {
    var provider = new PluginProvider();
    provider.registerService(["orion.cm.managedservice"],
        {  pid: "example.pid"
        },
        {  updated: function(properties) {
               if (properties === null) {
                 console.log("We have no properties :(");
               } else {
                 console.log("We got properties!");
                 console.dir(properties);
               }
           }
        });
    provider.connect();
});

Here is a larger example, showing how a validation service (a spellchecker that checks for any occurrences of the misspelling "definately") might accept options through its configuration properties. The service implementation in this example is both a validator and a Managed Service.

define(["orion/plugin"], function(PluginProvider) {
    var provider = new PluginProvider();
    var options;
    provider.registerService(["orion.cm.managedservice", "orion.edit.validator"],
        {  pid: "example.validator",
           contentType: ["text/plain"]
        },
        {  updated: function(properties) {
               if (properties === null) {
                   // No configuration, use default
                   options = { enabled: true };
               } else {
                   options = { enabled: !!properties.enabled };
               }
           },
           checkSyntax: function(title, contents) {
               if (!options.enabled) {
                   return { problems: [] };
               }
               var problems = [];
               contents.split(/\r?\n/).forEach(function(line, i) {
                   var index;
                   if ((index = line.indexOf("definately") !== -1) {
                       problems.push({
                           description: "Misspelled word",
                           line: i+1,
                           start: index,
                           end: index+10,
                           severity: "warning"
                       });
                   }
               });
               return { problems: problems };
           }
        });
    provider.connect();
});

The updated() method here checks its configuration dictionary for a boolean enabled property that determines whether the validator is active. In the case of null properties, the service uses a reasonable default. (It's a best practice for configurable services to behave sanely when no configuration has been defined for them.)

Note that, by virtue of the configuration framework's guarantee that updated() is called before all other service methods, our checkSyntax() method can safely assume that the options variable has been set.

orion.cm.metatype

The orion.cm.metatype service contributes Metatype information. Metatype information is based around Object Class Definitions (OCDs), which are first-class reusable elements. An OCD contains one or more Attribute Definitions. An Attribute Definition defines an individual property that can appear within a particular instance of the containing OCD.

The orion.cm.metatype service serves two purposes:

Object Classes are analogous to OSGi Object Class Definitions, and Attribute Definitions to OSGi Attribute Definitions. In OO terms, Object Classes are similar to classes, and Attribute Definitions are similar to fields or instance variables.

Service properties

There are two top-level properties: classes (defines an OCD), and designates (associates an OCD with a PID). Either of these properties, or both of them, may be specified.

Define an OCD

To define one or more Object Class Definitions, the classes service property is used:

classes
ObjectClass[]. Defines Object Classes. Object Classes defined here can be referenced elsewhere by their ID. Each ObjectClass element has the following shape:
id
String. Uniquely identifies this OCD.
name
String. Optional. The name of this OCD.
properties
AttributeDefinition[]. Defines the Attribute Definitions that can appear in instances of this OCD. Each AttributeDefinition element has the following shape:
id
String. The property id. This is unique within the containing OCD.
name
String. Optional. The name of this property.
type
'string' | 'number' | 'boolean'. Optional, defaults to 'string'. The data type.
defaultValue
Object. Optional, defaults to null. The default value of this property. This is a literal whose type matches the property's type.
options
PropertyOption[]. Optional, defaults to null. If nonnull, gives an enumeration of allowed values that this property can take. Each PropertyOption element has the following shape:
value
Object. The value of this option. This is a literal value whose type matches the property's type.
label
String. The label for this option.

Associate an OCD with a PID

To create PID-to-Object-Class associations, the designates service property is used:

designates
Designate[]. Each Designate element has the following shape:
pid
String. The PID for which OCD information will be associated.
classId
String. References an OCD by ID. The referenced OCD will be associated with the PID.

Object Classes are publicly visible, so the OCD referenced by a Designate element may be defined by a different Metatype service. The order in which Metatype services are registered does not matter.

Service methods

None. This service is purely declarative.

Examples

This example shows how to define an OCD with ID example.customer. The OCD has two AttributeDefinitions.

define(['orion/plugin'], function(PluginProvider) {
    var pluginProvider = new PluginProvider();
    pluginProvider.registerService('orion.cm.metatype',
        {},
        {  classes: [
               {  id: 'example.customer',
                  properties: [
                      {  id: 'fullname',
                         name: 'Full Name',
                         type: 'string'
                      },
                      {  id: 'address',
                         name: 'Mailing Address',
                         type: 'string'
                      }
                  ]
               }
           ]
        });
    provider.connect();
});

Building on the previous example, here's how we would use a designates to associate the example.customer OCD with a PID named example.pid.

define(['orion/plugin'], function(PluginProvider) {
    var pluginProvider = new PluginProvider();
    pluginProvider.registerService('orion.cm.metatype',
        {},
        {  classes: [
               {  id: 'example.customer',
                  properties: [
                      {  id: 'fullname',
                         name: 'Full Name',
                         type: 'string'
                      },
                      {  id: 'address',
                         name: 'Mailing Address',
                         type: 'string'
                      }
                  ]
               }
           ]
        });
    // New code starts here
    pluginProvider.registerService('orion.cm.metatype',
        {},
        {  designates: [
               {  pid: 'example.pid',
                  classId: 'example.customer'
               }
           ]
        });
    provider.connect();
});

Alternatively, we can use a single service registration, with both classes and designates, to achieve the same effect:

define(['orion/plugin'], function(PluginProvider) {
    var pluginProvider = new PluginProvider();
    pluginProvider.registerService('orion.cm.metatype',
        {},
        {  classes: [
               {  id: 'example.customer',
                  properties: [
                      {  id: 'fullname',
                         name: 'Full Name',
                         type: 'string'
                      },
                      {  id: 'address',
                         name: 'Mailing Address',
                         type: 'string'
                      }
                  ]
               }
           ],
           designates: [
               {  pid: 'example.pid',
                  classId: 'example.customer'
               }
           ]
        });
    provider.connect();
});

See also

orion.core.setting