J661 extension manifest properties

    1  Mandatory properties
    2  Optional properties
       2.1  Basic properties
          2.1.1  General properties
          2.1.2  Server properties
          2.1.3  Editor properties
       2.2  Advanced properties
          2.2.1  Advanced General properties
          2.2.2  Advanced Server properties
     Advanced 3D Server properties
          2.2.3  Supported Properties format
          2.2.4  Extending the reference Schema
          2.2.5  Layer Size density
          2.2.6  Server widgets UI
    3  See also

As explained in J661 extensions article, J661 extensions are jar files which allow to extend the behavior of the Server or Client. Extensions have:

Note that J661 extensions are jar files, so the Manifest format specification apply to their development. For example, the Class−Path attribute in the manfest allows to specify Jar dependencies.

Mandatory properties

The mandatory properties only allow to register the extension. All these properties are Strings, and J661 modules do not enforce any consistency for these Stringsd, excepts that two Extensions must not have the same ExtensionID.
Note that it is not a problem to have Manifest properties not used by a particular J661 module. THese properties will simply be skipped for the associated module. For example, specific Server properties will be skipped if the extension is registered by the Client.

Optional properties

The optional properties are used for all the characteristics which are extended. The following lists are separated into basic and advanced properties, although there are no fundamental differences between these two kinds of properties. Note that all properties which refer to an URL path refer to a classpath in the exctension jar file. For example:
      Widgets: myPackage/myWidgets.xml
specifies that we will find the myWidgets.xml URL in the myPackage package in the jar file.

Basic properties

General properties

These properties are for both the Client and Server.

Server properties

These properties are for the Server only.

Editor properties

These properties are for the Editor only.

Advanced properties

Advanced General properties

These properties are for both the Client and Server.

Advanced Server properties

These properties are for the Server only.
Advanced 3D Server properties
These properties are for the Server only, for 3D Maps. Note that 3D Maps are still not standardized in the ARINC 661 stndard as of supplement 6.

Supported Properties format

The format of this property is <property1, property2, ...: <ExtensionPropertyLoader classPath>. The first part of the String is the list of property names which the extension support, the second part (after the colon) represent the ClassPath of the ExtensionPropertyLoader which will be responsible of loading the properties of the specified names.
For example, for the following attribute in an extension Manifest: prop, prop2: arinc.ext.MyPropertyLoader: The extension supports two properties ("prop1" and "prop2". This support is performed through an instance of the class arinc.ext.MyPropertyLoader which will be lazily instantiated if one of these properties is present in the properties file.
See Extensions manifest properties for more informations on how to define these properties.

Extending the reference Schema

The reference Schema for XML Definition File validation is built−in, but it is possible to use a custom one, or even better, to extend the built−in reference one. The http://j661.sourceforge.net/schemas/arinc.xsd" location allows to specify the virtual location for the reference Schema to extend it. For example, for adding the "myNewElement" at the end of the "a661_df" element children:
   <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
      <xs:redefine schemaLocation="http://j661.sourceforge.net/schemas/arinc.xsd">
         <xs:complexType name="a661_df">
               <xs:extension base="a661_df" >
                     <xs:element ref="myNewElement" minOccurs="0"/>

Layer Size density

This property sets if the Layer size is specified in XML Definition Files as Pixels rather than 100th of millimeters. There are two possibilities to specify this property: If this property is set, the width and height of Layers in the XML Definition Fiels will be defined using this specified density rather than in 100th of mm. Note that widgets positions and sizes in the XML Definition FIles will still be defined in 100th of mm.
Note that the server.layerSizeDensity configuration property will only be taken into account if an extension has set this manifest property.

Server widgets UI

The "ServerWidgetsUI" property specifies the path to the XML Server renderers configuration file for the extension. A basic example is:
      ServerWidgetsUI: the/path/to/my/package/renderersConfig.xml
It is also possible to define two different paths, depending on the active UI framework. In this case the format of the property will be one of the followings: For example:
      ServerWidgetsUI: my/swingPackage/swingRenderers.xml;javaFX:my/javafxPackage/javafxRenderers.xml

See Also

Category:server Category:extensions Category:dev Category:client

Copyright 2016 Dassault Aviation. All Rights Reserved. Documentation and source under the GPL v2 licence

Project Web Hosted by SourceForge.net Copyright 1999-2010 - Geeknet, Inc., All Rights Reserved About - Legal - Help