|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginCfg
A server-side interface for querying Plugin settings.
Plugins provide a mechanism for executing custom code at specified points in operation processing and in the course of other events like connection establishment and termination, server startup and shutdown, and LDIF import and export.
Method Summary | |
---|---|
void |
addChangeListener(ConfigurationChangeListener<PluginCfg> listener)
Register to be notified when this Plugin is changed. |
java.lang.Class<? extends PluginCfg> |
configurationClass()
Gets the configuration class associated with this Plugin. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.util.SortedSet<PluginCfgDefn.PluginType> |
getPluginType()
Gets the "plugin-type" property. |
boolean |
isEnabled()
Gets the "enabled" property. |
boolean |
isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property. |
void |
removeChangeListener(ConfigurationChangeListener<PluginCfg> listener)
Deregister an existing Plugin configuration change listener. |
Methods inherited from interface org.opends.server.admin.Configuration |
---|
dn |
Method Detail |
---|
java.lang.Class<? extends PluginCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<PluginCfg> listener)
listener
- The Plugin configuration change listener.void removeChangeListener(ConfigurationChangeListener<PluginCfg> listener)
listener
- The Plugin configuration change listener.boolean isEnabled()
Indicates whether the plug-in is enabled for use.
boolean isInvokeForInternalOperations()
Indicates whether the plug-in should be invoked for internal operations.
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |