From 2af78cedd82a08046324ea13eb4973d65c80010f Mon Sep 17 00:00:00 2001
From: Fraser Tweedale <ftweedal@redhat.com>
Date: Tue, 22 Jul 2014 00:03:47 -0400
Subject: Add ability to enable/disable dynamic subsystems

The CA installation process requires starting with the profile
subsystem disabled, then enabling it once profiles have been loaded
into the database.  Accordingly, to avoid hacks with hardcoded
offsets, add the "enabled" CS.cfg configuration parameter along with
methods to enable or disable a subsystem based on the subsystem ID.

A disabled subsystem does not have its `init` method called, but it
is still instantiated and added to the registry so that other code
can look up a subsystem by name and find out its class.

Subsystems are enabled by default.

This commit also removes an assumption that the subsystem config
sub-store names are sequential numbers beginning at `0`.
---
 base/common/src/com/netscape/certsrv/apps/CMS.java | 22 ++++++++++++++++++++++
 .../src/com/netscape/certsrv/apps/ICMSEngine.java  |  9 +++++++++
 2 files changed, 31 insertions(+)

(limited to 'base/common/src/com')

diff --git a/base/common/src/com/netscape/certsrv/apps/CMS.java b/base/common/src/com/netscape/certsrv/apps/CMS.java
index 8b4bac2c0..85c8e58ca 100644
--- a/base/common/src/com/netscape/certsrv/apps/CMS.java
+++ b/base/common/src/com/netscape/certsrv/apps/CMS.java
@@ -508,6 +508,28 @@ public final class CMS {
         return _engine.getSubsystem(name);
     }
 
+    /**
+     * Enable the subsystem with the given ID.
+     *
+     * Does not start the subsystem.
+     *
+     * @param id Subsystem ID.
+     */
+    public static void enableSubsystem(String id) throws EBaseException {
+        _engine.setSubsystemEnabled(id, true);
+    }
+
+    /**
+     * Disable the subsystem with the given ID.
+     *
+     * Does not stop the subsystem.
+     *
+     * @param id Subsystem ID.
+     */
+    public static void disableSubsystem(String id) throws EBaseException {
+        _engine.setSubsystemEnabled(id, false);
+    }
+
     /**
      * Retrieves the localized user message from UserMessages.properties.
      *
diff --git a/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java b/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java
index 74fa09003..5c78a7c0f 100644
--- a/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java
+++ b/base/common/src/com/netscape/certsrv/apps/ICMSEngine.java
@@ -170,6 +170,15 @@ public interface ICMSEngine extends ISubsystem {
      */
     public Enumeration<ISubsystem> getSubsystems();
 
+    /**
+     * Set whether the given subsystem is enabled.
+     *
+     * @param id The subsystem ID.
+     * @param enabled Whether the subsystem is enabled
+     */
+    public void setSubsystemEnabled(String id, boolean enabled)
+        throws EBaseException;
+
     /**
      * Retrieves the registered subsytem with the given name.
      *
-- 
cgit