Package com.netscape.certsrv.base
Interface IPluginImpl
- All Known Subinterfaces:
ILdapPluginImpl
public interface IPluginImpl
This interface represents a plugin instance.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionString[]
Retrieves a list of configuration parameter names.Retrieves the configuration store.Return default parameters for a plugin implementation.Gets the description for this plugin instance.Returns the name of the plugin class.Returns the name of the plugin instance.Return configured parameters for a plugin instance.void
init
(ISubsystem sys, String instanceName, String className, ConfigStore config) Initializes this plugin instance.void
shutdown()
Shutdowns this plugin.
-
Field Details
-
PROP_IMPLNAME
- See Also:
-
-
Method Details
-
getDescription
String getDescription()Gets the description for this plugin instance.- Returns:
- The Description for this plugin instance.
-
getImplName
String getImplName()Returns the name of the plugin class.- Returns:
- The name of the plugin class.
-
getInstanceName
String getInstanceName()Returns the name of the plugin instance.- Returns:
- The name of the plugin instance. If none is set the name of the implementation will be returned.xxxx
-
init
void init(ISubsystem sys, String instanceName, String className, ConfigStore config) throws EBaseException Initializes this plugin instance.- Parameters:
sys
- parent subsysteminstanceName
- instance name of this pluginclassName
- class name of this pluginconfig
- configuration store- Throws:
EBaseException
- failed to initialize
-
shutdown
void shutdown()Shutdowns this plugin. -
getConfigStore
ConfigStore getConfigStore()Retrieves the configuration store.- Returns:
- configuration store
-
getInstanceParams
Return configured parameters for a plugin instance.- Returns:
- nvPairs A Vector of name/value pairs. Each name/value pair is constructed as a String in name=value format.
-
getConfigParams
String[] getConfigParams()Retrieves a list of configuration parameter names.- Returns:
- a list of parameter names
-
getDefaultParams
Return default parameters for a plugin implementation.- Returns:
- nvPairs A Vector of name/value pairs. Each name/value pair is constructed as a String in name=value.
-