com.netscape.certsrv.base
Interface IPluginImpl

All Known Subinterfaces:
ILdapPluginImpl

public interface IPluginImpl

This interface represents a plugin instance.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String PROP_IMPLNAME
           
 
Method Summary
 java.lang.String[] getConfigParams()
          Retrieves a list of configuration parameter names.
 IConfigStore getConfigStore()
          Retrieves the configuration store.
 java.util.Vector getDefaultParams()
          Return default parameters for a plugin implementation.
 java.lang.String getDescription()
          Gets the description for this plugin instance.
 java.lang.String getImplName()
          Returns the name of the plugin class.
 java.lang.String getInstanceName()
          Returns the name of the plugin instance.
 java.util.Vector getInstanceParams()
          Return configured parameters for a plugin instance.
 void init(ISubsystem sys, java.lang.String instanceName, java.lang.String className, IConfigStore config)
          Initializes this plugin instance.
 void shutdown()
          Shutdowns this plugin.
 

Field Detail

PROP_IMPLNAME

static final java.lang.String PROP_IMPLNAME
See Also:
Constant Field Values
Method Detail

getDescription

java.lang.String getDescription()
Gets the description for this plugin instance.

Returns:
The Description for this plugin instance.

getImplName

java.lang.String getImplName()
Returns the name of the plugin class.

Returns:
The name of the plugin class.

getInstanceName

java.lang.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,
          java.lang.String instanceName,
          java.lang.String className,
          IConfigStore config)
          throws EBaseException
Initializes this plugin instance.

Parameters:
sys - parent subsystem
instanceName - instance name of this plugin
className - class name of this plugin
config - configuration store
Throws:
EBaseException - failed to initialize

shutdown

void shutdown()
Shutdowns this plugin.


getConfigStore

IConfigStore getConfigStore()
Retrieves the configuration store.

Returns:
configuration store

getInstanceParams

java.util.Vector 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

java.lang.String[] getConfigParams()
Retrieves a list of configuration parameter names.

Returns:
a list of parameter names

getDefaultParams

java.util.Vector 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.