Overview

The Rule Registry (org.eclipse.smarthome.automation.RuleRegistry) is designed to provide basic functionality for managing Rules. It can be used to:

• Add rules into Rule Engine with the add(Rule) method.
• Get the existing rules with the getByTag(String), getByTags(String[]) methods.
• Update the existing rules with the update(Rule) method.
• Remove rules with the remove(String) method.
• Manage the state (enabled, disabled) of the rules with the setEnabled(String, boolean) method. A newly added Rule is always enabled.
• Check the rule's state (enabled, disabled) with the isEnabled(String) method.
• Get info of the status of the rules with the getStatusInfo(String) method.

Registering Bundle

The Rule Registry implementation is in the org.eclipse.smarthome.automation.core bundle, together with the Rule Engine implementation. It is declared as an immediate service component.

Dependencies

To be able to manage the state of the rules (enabling, disabling), the Rule Registry depends on the Storage service. To be able to manage rules (adding, updating, removing), the Rule Registry depends on the Managed Rule Provider service.