org.opends.server.api.plugin

Class InternalDirectoryServerPlugin

java.lang.Object

org.opends.server.api.plugin.DirectoryServerPlugin<PluginCfg>

org.opends.server.api.plugin.InternalDirectoryServerPlugin

Direct Known Subclasses:

AuthenticatedUsers, CryptoManagerSync, GroupManager, MultimasterReplication.CleanStaleHistoricalMetadataPlugin, SubentryManager

public abstract class InternalDirectoryServerPlugin
extends DirectoryServerPlugin<PluginCfg>

An internal directory server plugin which can be registered with the server without requiring any associated configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalDirectoryServerPlugin(Dn componentDN, Set<PluginType> pluginTypes, boolean invokeForInternalOps) Creates a new internal directory server plugin using the provided component name and plugin types.

Method Summary

Modifier and Type	Method and Description
void	initializePlugin(Set<PluginType> pluginTypes, PluginCfg configuration) Performs any initialization necessary for this plugin.
boolean	isConfigurationAcceptable(PluginCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this plugin.

Methods inherited from class org.opends.server.api.plugin.DirectoryServerPlugin

doLDIFExport, doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostConnect, doPostDisconnect, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostOperation, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostResponse, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPostSynchronization, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreOperation, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, finalizePlugin, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, processSubordinateDelete, processSubordinateModifyDN, setInvokeForInternalOperations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InternalDirectoryServerPlugin

protected InternalDirectoryServerPlugin(Dn componentDN,
                                        Set<PluginType> pluginTypes,
                                        boolean invokeForInternalOps)

Creates a new internal directory server plugin using the provided component name and plugin types.

Parameters:

componentDN - The configuration entry name of the component associated with this internal plugin.

pluginTypes - The set of plugin types for which this internal plugin is registered.

invokeForInternalOps - Indicates whether this internal plugin should be invoked for internal operations.

Method Detail

initializePlugin

public final void initializePlugin(Set<PluginType> pluginTypes,
                                   PluginCfg configuration)
                            throws ConfigException,
                                   InitializationException

Description copied from class: DirectoryServerPlugin

Performs any initialization necessary for this plugin. This will be called as soon as the plugin has been loaded and before it is registered with the server.

Specified by:

initializePlugin in class DirectoryServerPlugin<PluginCfg>

Parameters:

pluginTypes - The set of plugin types that indicate the ways in which this plugin will be invoked.

configuration - The configuration for this plugin.

Throws:

ConfigException - If the provided entry does not contain a valid configuration for this plugin.

InitializationException - If a problem occurs while initializing the plugin that is not related to the server configuration.

isConfigurationAcceptable

public final boolean isConfigurationAcceptable(PluginCfg configuration,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from class: DirectoryServerPlugin

Indicates whether the provided configuration is acceptable for this plugin. It should be possible to call this method on an uninitialized plugin instance in order to determine whether the plugin would be able to use the provided configuration.

Overrides:

isConfigurationAcceptable in class DirectoryServerPlugin<PluginCfg>

Parameters:

configuration - The plugin configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this plugin, or false if not.