@PublicAPI(stability=UNCOMMITTED)

Package org.opends.server.api.plugin

Defines the Directory Server plugin API.

See:
          Description

Class Summary
DirectoryServerPlugin<T extends PluginCfg> This class defines the set of methods and structures that are available for use in Directory Server plugins.
PluginResult This class defines a data structure that holds information about the result of processing by a plugin.
PluginResult.ImportLDIF Defines a LDIF plugin result for import from LDIF processing consisting of either continue, skip further plugins, or stop processing with an error message.
PluginResult.IntermediateResponse Defines an intermediate response plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.
PluginResult.PostConnect Defines a post connect plugin result for client connection processing consisting of either continue, skip further plugins, or stop.
PluginResult.PostDisconnect Defines a post disconnect plugin result for client connection processing consisting of either continue or skip further plugins.
PluginResult.PostOperation Defines a post operation plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.
PluginResult.PostResponse Defines a post response plugin result for core server operation processing consisting of either continue or skip further plugins.
PluginResult.PreOperation Defines a pre operation plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.
PluginResult.PreParse Defines a pre parse plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.
PluginResult.Startup Defines a startup plugin result consisting of either continue skip further plugins, or stop startup with an error message.
PluginResult.SubordinateModifyDN Defines a subordinate modify DN plugin result for core server operation processing consisting of either continue, skip further plugins, or stop operation processing with a result code, matched DN, referral URLs, and error message.
 

Enum Summary
PluginType This class defines an enumeration containing the types of plugins that are supported for use in the Directory Server.
 

Package org.opends.server.api.plugin Description

Defines the Directory Server plugin API. Plugins are classes containing user-defined code that will be executed at specific times points during operation processing. In particular, the plugin points for operation processing include:


These plugins may be invoked for most kinds of operations, although certain types of operations like abandon and unbind do not have responses and therefore there is no ability to invoke post-response plugins for those kinds of operations.

Other plugin Directory Server plugin points include: