summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/registry
diff options
context:
space:
mode:
authorEndi Sukma Dewata <edewata@redhat.com>2012-03-24 02:27:47 -0500
committerEndi Sukma Dewata <edewata@redhat.com>2012-03-26 11:43:54 -0500
commit621d9e5c413e561293d7484b93882d985b3fe15f (patch)
tree638f3d75761c121d9a8fb50b52a12a6686c5ac5c /base/common/src/com/netscape/certsrv/registry
parent40d3643b8d91886bf210aa27f711731c81a11e49 (diff)
downloadpki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.gz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.tar.xz
pki-621d9e5c413e561293d7484b93882d985b3fe15f.zip
Removed unnecessary pki folder.
Previously the source code was located inside a pki folder. This folder was created during svn migration and is no longer needed. This folder has now been removed and the contents have been moved up one level. Ticket #131
Diffstat (limited to 'base/common/src/com/netscape/certsrv/registry')
-rw-r--r--base/common/src/com/netscape/certsrv/registry/ERegistryException.java42
-rw-r--r--base/common/src/com/netscape/certsrv/registry/IPluginInfo.java61
-rw-r--r--base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java91
3 files changed, 194 insertions, 0 deletions
diff --git a/base/common/src/com/netscape/certsrv/registry/ERegistryException.java b/base/common/src/com/netscape/certsrv/registry/ERegistryException.java
new file mode 100644
index 000000000..5d2e2c91c
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/registry/ERegistryException.java
@@ -0,0 +1,42 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; version 2 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.certsrv.registry;
+
+import com.netscape.certsrv.base.EBaseException;
+
+/**
+ * This represents a registry exception.
+ *
+ * @version $Revision$, $Date$
+ */
+public class ERegistryException extends EBaseException {
+
+ /**
+ *
+ */
+ private static final long serialVersionUID = 8977050444820190765L;
+
+ /**
+ * Constructs a registry exception.
+ *
+ * @param msg message carried along with the exception
+ */
+ public ERegistryException(String msg) {
+ super(msg);
+ }
+}
diff --git a/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java b/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java
new file mode 100644
index 000000000..8e6a87365
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java
@@ -0,0 +1,61 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; version 2 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.certsrv.registry;
+
+import java.util.Locale;
+
+/**
+ * The plugin information includes name,
+ * class name, and description. The localizable
+ * name and description are information
+ * for end-users.
+ * <p>
+ *
+ * The class name can be used to create an instance of the plugin.
+ * <p>
+ *
+ * @version $Revision$, $Date$
+ */
+public interface IPluginInfo {
+
+ /**
+ * Retrieves the localized plugin name.
+ *
+ * @param locale end-user locale
+ * @return plugin name
+ */
+ public String getName(Locale locale);
+
+ /**
+ * Retrieves the localized plugin description.
+ *
+ * @param locale end-user locale
+ * @return plugin description
+ */
+ public String getDescription(Locale locale);
+
+ /**
+ * Retrieves the class name of the plugin.
+ * Instance of plugin can be created with
+ * <p>
+ * Class.forName(info.getClassName());
+ *
+ * @return java class name
+ */
+ public String getClassName();
+}
diff --git a/base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java b/base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java
new file mode 100644
index 000000000..1c85aeba9
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java
@@ -0,0 +1,91 @@
+// --- BEGIN COPYRIGHT BLOCK ---
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; version 2 of the License.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// (C) 2007 Red Hat, Inc.
+// All rights reserved.
+// --- END COPYRIGHT BLOCK ---
+package com.netscape.certsrv.registry;
+
+import java.util.Enumeration;
+
+import com.netscape.certsrv.base.IConfigStore;
+import com.netscape.certsrv.base.ISubsystem;
+
+/**
+ * This represents the registry subsystem that manages
+ * mulitple types of plugin information.
+ *
+ * The plugin information includes id, name,
+ * classname, and description.
+ *
+ * @version $Revision$, $Date$
+ */
+public interface IPluginRegistry extends ISubsystem {
+
+ public static final String ID = "registry";
+
+ /**
+ * Returns handle to the registry configuration file.
+ *
+ * @return configuration store of registry subsystem
+ */
+ public IConfigStore getFileConfigStore();
+
+ /**
+ * Returns all type names.
+ *
+ * @return a list of String-based names
+ */
+ public Enumeration<String> getTypeNames();
+
+ /**
+ * Returns a list of plugin identifiers of the given type.
+ *
+ * @param type plugin type
+ * @return a list of plugin IDs
+ */
+ public Enumeration<String> getIds(String type);
+
+ /**
+ * Retrieves the plugin information.
+ *
+ * @param type plugin type
+ * @param id plugin id
+ * @return plugin info
+ */
+ public IPluginInfo getPluginInfo(String type, String id);
+
+ /**
+ * Adds plugin info.
+ *
+ * @param type plugin type
+ * @param id plugin id
+ * @param info plugin info
+ * @exception ERegistryException failed to add plugin
+ */
+ public void addPluginInfo(String type, String id, IPluginInfo info)
+ throws ERegistryException;
+
+ /**
+ * Removes plugin info.
+ */
+ public void removePluginInfo(String type, String id)
+ throws ERegistryException;
+
+ /**
+ * Creates a pluginInfo
+ */
+ public IPluginInfo createPluginInfo(String name, String desc,
+ String classPath);
+}