summaryrefslogtreecommitdiffstats
path: root/base/common/src/com/netscape/certsrv/base/IPluginImpl.java
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/base/IPluginImpl.java
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/base/IPluginImpl.java')
-rw-r--r--base/common/src/com/netscape/certsrv/base/IPluginImpl.java104
1 files changed, 104 insertions, 0 deletions
diff --git a/base/common/src/com/netscape/certsrv/base/IPluginImpl.java b/base/common/src/com/netscape/certsrv/base/IPluginImpl.java
new file mode 100644
index 000000000..a7a0560b5
--- /dev/null
+++ b/base/common/src/com/netscape/certsrv/base/IPluginImpl.java
@@ -0,0 +1,104 @@
+// --- 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.base;
+
+import java.util.Vector;
+
+/**
+ * This interface represents a plugin instance.
+ *
+ * @version $Revision$, $Date$
+ */
+public interface IPluginImpl {
+
+ public static final String PROP_IMPLNAME = "implName";
+
+ /**
+ * Gets the description for this plugin instance.
+ * <P>
+ *
+ * @return The Description for this plugin instance.
+ */
+ public String getDescription();
+
+ /**
+ * Returns the name of the plugin class.
+ * <P>
+ *
+ * @return The name of the plugin class.
+ */
+ public String getImplName();
+
+ /**
+ * Returns the name of the plugin instance.
+ * <P>
+ *
+ * @return The name of the plugin instance. If none is set
+ * the name of the implementation will be returned.xxxx
+ */
+ public String getInstanceName();
+
+ /**
+ * Initializes this plugin instance.
+ *
+ * @param sys parent subsystem
+ * @param instanceName instance name of this plugin
+ * @param className class name of this plugin
+ * @param config configuration store
+ * @exception EBaseException failed to initialize
+ */
+ public void init(ISubsystem sys, String instanceName, String className,
+ IConfigStore config)
+ throws EBaseException;
+
+ /**
+ * Shutdowns this plugin.
+ */
+ public void shutdown();
+
+ /**
+ * Retrieves the configuration store.
+ *
+ * @return configuration store
+ */
+ public IConfigStore getConfigStore();
+
+ /**
+ * Return configured parameters for a plugin instance.
+ *
+ * @return nvPairs A Vector of name/value pairs. Each name/value
+ * pair is constructed as a String in name=value format.
+ */
+ public Vector<String> getInstanceParams();
+
+ /**
+ * Retrieves a list of configuration parameter names.
+ *
+ * @return a list of parameter names
+ */
+ public String[] getConfigParams();
+
+ /**
+ * Return default parameters for a plugin implementation.
+ *
+ * @return nvPairs A Vector of name/value pairs. Each name/value
+ * pair is constructed as a String in name=value.
+ */
+ public Vector<String> getDefaultParams();
+
+}