Module Deployment

Chapter Index:

• Deployed Module Format
• Module Deployment Checklist

Deployed Module Format

The BEAM module manager accesses a remote module repository, currently hosted at Brockmann Consult. It contains deployed modules: current BEAM modules, updates and extensions. The file format of a deployed module in the repository differs from its "raw", installed form. The deployed form is a directory which contains the actual module itself plus some meta data extracted from it. In order to convert a raw module into its deployable form, we use the ceres-deploy tool, which is part of the ceres project. The tool's command-line usage is

com.bc.ceres.deploy.DeployMain <moduleJar>|<modulesDir> <repositoryDir>

The command converts a single module <moduleJar> or all modules found in <modulesDir> to their deployable form in <repositoryDir>. The "raw" module as outputted by the Maven build process is converted into the deployable form as follows:

Format of an installed module (Maven build output):

+- <modulesDir>
   |
   +- <myModule>/      (or <myModule.jar>)
      |
      |- org/esa/beam/...
      |- module.xml
      |- about.html (optional)
      `- LICENSE.txt (optional)

Format of a deployed module (repository layout):

+- <repositoryDir>
   |
   +- <manifest.symbolicName>-<manifest.version>/
      |
      +- <manifest.symbolicName>-<manifest.version>.jar
      |  +- org/esa/beam/...
      |  |- module.xml
      |  |- about.html
      |  `- LICENSE.txt
      |
      |- module.xml
      |- about.html
      `- LICENSE.txt

where <manifest.symbolicName> and <manifest.version> are taken from the module.xml manifest file.

Module Deployment Checklist

1. Check module manifest:
   1. Use the correct version numbering, refer to Module Configuration
   2. Provide all module deltas since the last deployment in the changelog element
   3. Provide at least the following optional meta data: name, description, vendor, contactAddress, copyright
   4. Provide license information: either provide licenseUrl or provide a LICENSE.txt file.
   5. Check spelling in meta data!
2. Check accompanying files are available: about.html, LICENSE.txt
3. Make sure module versions in Maven project file (pom.xml) and module manifest (module.xml) are identical