Font size:

module.properties

Overview

Overview

This file contains the metadata describing the module. Command handlers can read the file using the following code. Note that the ${module.dir} property will be defined by the command dispatcher.

<property file="${module.dir}/module.properties"/>

Common

The table below lists the properties defined for any module

Property	Description
module.name	Name of the module
module.commands	Comma separated list of commands.
modules.description	Description of the module and its use.
module.notify	If true sends notifications.
module.notify.email	Email address to send notifications.
module.version	Module version number.

Example

module.name=Apache
module.commands=Start, Update, Status, Stop, PackagesGetAll, Configure
module.description=Module for controlling apache deployments
module.transforms.dir=/usr/local/httpd/var
module.notify=true
module.notify.email=admin@domain
module.version=55

Super Modules

This table lists the properties that are required to describe super module dependencies.

Property	Description
module.supermodules	Comma separated list of super modules.
module.supermodule.module-name.version	Version number of super module, module-name.
module.commands.command-name.inherited	Name of super module command-name is inherited from.

Example

module.supermodules=Packages
module.commands.PackagesGetAll.inherited=Packages
module.supermodule.Packages.version=4