diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/registry')
3 files changed, 195 insertions, 0 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/registry/ERegistryException.java b/pki/base/common/src/com/netscape/certsrv/registry/ERegistryException.java new file mode 100644 index 000000000..6d9f89d5d --- /dev/null +++ b/pki/base/common/src/com/netscape/certsrv/registry/ERegistryException.java @@ -0,0 +1,39 @@ +// --- 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.*; + + +/** + * This represents a registry exception. + * + * @version $Revision$, $Date$ + */ +public class ERegistryException extends EBaseException { + + /** + * Constructs a registry exception. + * + * @param msg message carried along with the exception + */ + public ERegistryException(String msg) { + super(msg); + } +} diff --git a/pki/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java b/pki/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java new file mode 100644 index 000000000..b7bdfbf2c --- /dev/null +++ b/pki/base/common/src/com/netscape/certsrv/registry/IPluginInfo.java @@ -0,0 +1,65 @@ +// --- 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.*; +import com.netscape.certsrv.base.*; + + +/** + * 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/pki/base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java b/pki/base/common/src/com/netscape/certsrv/registry/IPluginRegistry.java new file mode 100644 index 000000000..d567e8f46 --- /dev/null +++ b/pki/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.*; +import com.netscape.certsrv.base.*; + + +/** + * 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 getTypeNames(); + + /** + * Returns a list of plugin identifiers of the given type. + * + * @param type plugin type + * @return a list of plugin IDs + */ + public Enumeration 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); +} |