# Client architecture

## Components

Orion aims to provide independently useful web components with minimal coupling between them, so that application developers can choose to deploy only the subsets of interest to their applications. Each component is represented by a JavaScript library (typically a single JavaScript file) and any directly associated resources like style sheets or images. With Orion we consciously do not mandate the use of a special packaging format or component library requirement so you can for example use your favorite DOM manipulation library as is.

Dependencies between components in Orion are managed using the CommonJS AMD module format. However, as alluded to above, web components are not forced into using this model. For more loosely coupled functional interactions Orion provides a service registry similar to the OSGi service model, but with some of the declarative characteristics of Eclipse extension and extension points.

## Services

References between client library objects are directed through a service registry. Library objects are provided with a service registry object on construction, allowing a developer using the library to override what service implementations are used by any given library object. For example, while the default implementation of the Preferences object uses the remote preference service over HTTP, a client could provide an implementation that uses HTML5 local storage, cookies, etc.

Here is a simplified example of the `Explorer` object using a service to prompt the user to confirm a file deletion:

      function Explorer(serviceRegistry, ...) {
          this.registry = serviceRegistry;
          ...
       }
       ...
       deleteFile: function(itemId) {
          var item = this.myTree.getItem(itemId);
          var service = registry.getService("orion.page.dialog");
          var message = "Are you sure you want to delete '" + item.Name + "'?";
          service.confirm(message, function(doit) {
            /* perform deletion */
          });
       }

The `getService` function takes the service name as argument, and returns either the service instance or null. For this example we're assuming the service is present. However you should check for `null`, especially when using services dynamically contributed from a plugin.

### Communication with Services

In Orion, all service calls through the service registry are ''asynchronous'' and return a Promise object. You cannot assume that the service function will have been executed by the time the service function returns, and instead must chain any follow-on calls to the promise using its `then()` method. This inherent asynchronicity allows the service implementation to employ a variety of long-running techniques to execute the service, such as calls to a remote web service, cross-domain postMessage, HTML5 web workers, etc.

Plugin communication with the host page operates on the "don't call us, we'll call you" principle: the host Orion page initiates a service call, and the provider is merely responsible for fulfilling the contract of the service call. Providers cannot initiate this process themselves. However, the host page may choose to expose certain callable functions to service providers through Object References, which permit a limited form of callback-style communication with the host page. These callbacks are also asynchronous.

### Service definitions

A service definition includes both a declarative aspect, and optionally a concrete service object. Declarative service properties can be cached by the Orion service registry, avoiding loading of the plugin providing that service until it is needed. The following is an example of a very simple service definition:

      var provider = new orion.PluginProvider();
      var serviceImpl = {
        run : function(text) {
          return text.toUpperCase();
        }
      };
      var serviceProps = {
        name : "UPPERCASE",
        img : "/images/gear.gif",
        key : [ "u", true ]
      };
      provider.registerService("orion.edit.command", serviceImpl, serviceProps);
      provider.connect();

This service registers a new command in the editor. The service implementation has a single `run` method that converts the provided text to upper case. The service properties specify the name of the command, the icon, and key binding. This way the editor can display the command in the toolbar using the cached service properties, without actually loading the plugin.

### Object References

Orion 4.0 introduces Object References, which allow two-way communication between a service provider running in a plugin, and the host Orion page. An Object Reference exposes functions that a service provider can call to help it fulfill a service contract. Like everything in the service framework, Object References work asynchronously: all functions return Promises and the caller must wait for them to fulfill to an actual value. An Object Reference is valid only during the lifetime of its parent service call. Once the provider has fulfilled the service call, any Object References created for that call are unregistered by the framework, and cannot be used thereafter. This preserves the "don't call us, we'll call you" design approach.

In Orion 4.0, Object References are used to enhance many of the editor extension points.

## Extensions

Orion implements the Eclipse concept of extensions and extension points using the Orion service registry. An extension point is simply a service interface that clients are expected to implement. Each instance of that service is an extension. You will often see the terms "extension" and "service" used interchangeably in the Orion documentation. There is no technical difference between them; rather, it is an expression of how the service is intended to be used. Services provided by clients are conceptually extensions, and services used by clients are simply called services.

## Plugins

Services and extensions that reside on different web domains from the host Orion server are contributed to Orion by registering <dfn>plugins</dfn>. A plugin is declared via an HTML file, is opened in a headless child `IFrame` and uses `window.postMessage` to advertise capabilities in the form of services and extensions back to Orion. Orion persists plugin information, and at a later date when functionality is requested, the plugin will be loaded in a `IFrame` with limited permissions. Here is an example of a simple plugin:

    <!DOCTYPE html>
    <html>
    <head>
        <!-- Dependencies -->
        <!-- <script src="./orion/Deferred.js"></script> -->
        <script src="./orion/plugin.js"></script>
        <script>
          window.onload = function() {
            // Service declarations go here
          };
        </script>
    </head>
    <body>
    </body>
    </html>

A simple plugin can consist of only the plugin's HTML file, and the required `plugin.js` script from Orion. A plugin that makes use of Object References must also load the `Deferred.js` library, as the framework will need to instantiate promises in the plugin's window. Complex plugins will typically be broken into several script files containing the concrete service implementation objects. See Orion's Simple plugin tutorial for a step-by-step guide.

Plugins are installed or uninstalled from the Settings page within the Orion user interface.