sampledoc

Cfg Handler Development

The Cfg plugin offers multiple handlers to handle different entries in different ways. Writing a new Cfg handler is a relatively simple way to add significant new features to Cfg.

Each new Cfg handler must be contained in its own module in Bcfg2.Server.Plugins.Cfg, and the module and class name must be identical. The name should start with Cfg, and should clearly indicate which of the handler types it is. A handler class may implement more than one handler type.

Cfg Handler Types

There are several different types of Cfg handlers. A new handler must inherit either from one of these classes, or from an existing handler.

Cfg Handler Base Class

In addition to the interfaces defined above, all Cfg handlers inherit from CfgBaseFileMatcher.

Cfg Exceptions

Cfg handlers may produce the following exceptions:

In addition, Cfg handlers may produce the following base plugin exceptions:

Existing Cfg Handlers

Generators

Creators

Info Handlers

Verifiers

Other Cfg Objects

These other objects comprise the remainder of the Cfg plugin, and are included for completeness.