oracle.oud.plugin

Interface ManagedPlugin

All Superinterfaces:

Plugin, RequestManager

All Known Implementing Classes:

AbstractPlugin

public interface ManagedPlugin
extends Plugin

This interface defines a managed plugin. Plugins must implement this interface and provide a public sole constructor (no argument).

Method Summary

Modifier and Type	Method and Description
void	finalizePlugin() This method is called when this plugin is stopped.
java.lang.String	getVersion() Returns the version of the plugin Api expected by this plugin.
void	handleConfigurationChange(PluginConfiguration configuration) This method is called each time the configuration of this plugin is changed.
void	initializePlugin(PluginConfiguration configuration, PluginContext context) This method is called when this plugin is initialized.

Methods inherited from interface oracle.oud.plugin.Plugin

getName

Methods inherited from interface oracle.oud.RequestManager

handleAdd, handleBind, handleCompare, handleDelete, handleExtended, handleModify, handleModifyDN, handleSearch

Method Detail

initializePlugin

void initializePlugin(PluginConfiguration configuration,
                      PluginContext context)
               throws PluginException

This method is called when this plugin is initialized.

Parameters:

configuration - the configuration of this plugin.

context - the context of this plugin

Throws:

PluginException - when the plugin failed to initialize successfully.

finalizePlugin

void finalizePlugin()

This method is called when this plugin is stopped.

handleConfigurationChange

void handleConfigurationChange(PluginConfiguration configuration)
                        throws PluginException

This method is called each time the configuration of this plugin is changed.

Parameters:

configuration - the configuration of the plugin.

Throws:

PluginException - if the new configuration can not be applied.

getVersion

java.lang.String getVersion()

Returns the version of the plugin Api expected by this plugin.

This method attempts to read the file named "plugin.properties" embedded in the jar file that contained this plugin class and located at the root. If that file exists, the value associated to the key plugin.<plugin-name>.version is returned if that key exists.
Otherwise, the value associated to the key plugin.version is returned.
If the properties file could not be read or if none of the keys described above is found then null is returned.

If null is returned, this means that this plugin does not expect a particular behavior of the plugin Api.
In case this plugin expects a particular behavior of the plugin Api, the version of the server at time this plugin was built must be returned.
The version of the server is returned by the command 'start-ds -V'.
The plugin Api was released in version "11.1.2.1.0".

Returns:

the version of the plugin Api expected by this plugin.