Skip to content

API: The Module Manager Manifest

TheCrownedFox edited this page Jun 13, 2013 · 10 revisions

API: The Module Manager Manifest

The Module Manager uses an xml file to store information about the environment the Interface SDK is running in.

Technical Overview

The module manager manifest provides the core configuration details for running the manager. The xml file will provide the location for the default module, the path to a folder containing all the module jars, and the details for the configuration store. The basic format for the Module Manager manifest is like this:

<?xml version="1.0" encoding="utf-8"?>
<manifest>
  <module-manager
      default-module="com.examples.module"
      module-path="src/test/resources/modules" >
    <config-files>
      <config-file name="kinectopenni" path="src/test/resources/openni_config.xml" />
    </config-files>
  </module-manager>

</manifest>
<!-- vim:fenc=utf-8
  -->

The configuration store

Related pages: List

The configuration store provides the user to indicate where configuration files are stored, specific to functionalities within the program. Although drivers will primarily be using them, this functionality can also be extended for modules who may require configuration files.

Tag / Attribute Glossary

manifest

The root tag of the manifest. Has no attributes.

Sub Tags

module-manager

Stores information related to which modules the Module Manager will try to run. It has two attributes:

default-module
The package name of the module that will be set as the default
module-path
The path to the directory where the modules are stored

config-files

All configuration files that will be stored in the configuration store. This has no attributes.

Sub Tags

config-file

Stores information about the individual config files. This has two attributes:

name
The name of the type of config file
path
The path to the config file
Clone this wiki locally