org.opends.server.plugins

Class AttributeCleanupPlugin

java.lang.Object

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

org.opends.server.plugins.AttributeCleanupPlugin

All Implemented Interfaces:

ConfigurationChangeListener<AttributeCleanupPluginCfg>

public class AttributeCleanupPlugin
extends DirectoryServerPlugin<AttributeCleanupPluginCfg>
implements ConfigurationChangeListener<AttributeCleanupPluginCfg>

The attribute cleanup plugin implementation class. The plugin removes and/or renames the configured parameters from the incoming ADD and MODIFY requests.

Constructor Summary

Constructors

Constructor and Description
AttributeCleanupPlugin() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(AttributeCleanupPluginCfg config) Applies the configuration changes to this change listener.
PluginResult.PreParse	doPreParse(PreParseAddOperation addOperation) Performs any necessary processing that should be done before the Directory Server parses the elements of an add request.
PluginResult.PreParse	doPreParse(PreParseModifyOperation modifyOperation) Performs any necessary processing that should be done before the Directory Server parses the elements of a modify request.
void	finalizePlugin() Performs any necessary finalization for this plugin.
void	initializePlugin(Set<PluginType> pluginTypes, AttributeCleanupPluginCfg 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.
boolean	isConfigurationChangeAcceptable(AttributeCleanupPluginCfg config, List<LocalizableMessage> messages) Indicates whether the proposed change to the configuration is acceptable to this change listener.

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, doShutdown, doStartup, getPluginEntryDN, getPluginTypes, 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

AttributeCleanupPlugin

public AttributeCleanupPlugin()

Default constructor.

Method Detail

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(AttributeCleanupPluginCfg config)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<AttributeCleanupPluginCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

doPreParse

public PluginResult.PreParse doPreParse(PreParseAddOperation addOperation)

Performs any necessary processing that should be done before the Directory Server parses the elements of an add request.

Overrides:

doPreParse in class DirectoryServerPlugin<AttributeCleanupPluginCfg>

Parameters:

addOperation - The add operation that has been requested.

Returns:

Information about the result of the plugin processing.

doPreParse

public PluginResult.PreParse doPreParse(PreParseModifyOperation modifyOperation)

Performs any necessary processing that should be done before the Directory Server parses the elements of a modify request.

Overrides:

doPreParse in class DirectoryServerPlugin<AttributeCleanupPluginCfg>

Parameters:

modifyOperation - The modify operation that has been requested.

Returns:

Information about the result of the plugin processing.

finalizePlugin

public void finalizePlugin()

Performs any necessary finalization for this plugin. This will be called just after the plugin has been deregistered with the server but before it has been unloaded.

Overrides:

finalizePlugin in class DirectoryServerPlugin<AttributeCleanupPluginCfg>

initializePlugin

public void initializePlugin(Set<PluginType> pluginTypes,
                    AttributeCleanupPluginCfg configuration)
                      throws org.forgerock.opendj.config.server.ConfigException,
                             InitializationException

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<AttributeCleanupPluginCfg>

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:

org.forgerock.opendj.config.server.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 boolean isConfigurationAcceptable(PluginCfg configuration,
                                List<LocalizableMessage> unacceptableReasons)

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<AttributeCleanupPluginCfg>

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.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(AttributeCleanupPluginCfg config,
                                      List<LocalizableMessage> messages)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<AttributeCleanupPluginCfg>

Parameters:

config - The new configuration containing the changes.

messages - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.