org.opends.server.plugins

Class EntryUUIDPlugin

java.lang.Object

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

org.opends.server.plugins.EntryUUIDPlugin

All Implemented Interfaces:

ConfigurationChangeListener<EntryUUIDPluginCfg>

public final class EntryUUIDPlugin
extends DirectoryServerPlugin<EntryUUIDPluginCfg>
implements ConfigurationChangeListener<EntryUUIDPluginCfg>

This class implements a Directory Server plugin that will add the entryUUID attribute to an entry whenever it is added or imported as per RFC 4530. For entries added over LDAP, the entryUUID will be based on a semi-random UUID (which is still guaranteed to be unique). For entries imported from LDIF, the UUID will be constructed from the entry DN using a repeatable algorithm. This will ensure that LDIF files imported in parallel across multiple systems will have identical entryUUID values.

Constructor Summary

Constructors

Constructor and Description
EntryUUIDPlugin() Mandatory default constructor of this Directory Server plugin.

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(EntryUUIDPluginCfg configuration) Applies the configuration changes to this change listener.
PluginResult.ImportLDIF	doLDIFImport(LDIFImportConfig importConfig, Entry entry) Performs any necessary processing that should be done during an LDIF import operation immediately after reading an entry and confirming that it should be imported based on the provided configuration.
PluginResult.PreOperation	doPreOperation(PreOperationAddOperation addOperation) Performs any necessary processing that should be done just before the Directory Server performs the core processing for an add operation.
void	finalizePlugin() Performs any necessary finalization for this plugin.
void	initializePlugin(Set<PluginType> pluginTypes, EntryUUIDPluginCfg 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(EntryUUIDPluginCfg configuration, List<LocalizableMessage> unacceptableReasons) 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, 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, doPreParse, doPreParse, 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

EntryUUIDPlugin

public EntryUUIDPlugin()

Mandatory default constructor of this Directory Server plugin.

Method Detail

initializePlugin

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

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

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.

finalizePlugin

public final void finalizePlugin()

Description copied from class: DirectoryServerPlugin

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

doLDIFImport

public final PluginResult.ImportLDIF doLDIFImport(LDIFImportConfig importConfig,
                                   Entry entry)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done during an LDIF import operation immediately after reading an entry and confirming that it should be imported based on the provided configuration.

Overrides:

doLDIFImport in class DirectoryServerPlugin<EntryUUIDPluginCfg>

Parameters:

importConfig - The configuration used for the LDIF import.

entry - The entry that has been read to the LDIF file.

Returns:

The result of the plugin processing.

doPreOperation

public final PluginResult.PreOperation doPreOperation(PreOperationAddOperation addOperation)

Description copied from class: DirectoryServerPlugin

Performs any necessary processing that should be done just before the Directory Server performs the core processing for an add operation. This method is not called when processing synchronization operations.

Overrides:

doPreOperation in class DirectoryServerPlugin<EntryUUIDPluginCfg>

Parameters:

addOperation - The add operation to be processed.

Returns:

Information about the result of the plugin processing.

isConfigurationAcceptable

public 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<EntryUUIDPluginCfg>

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(EntryUUIDPluginCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

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

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<EntryUUIDPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - 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.

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(EntryUUIDPluginCfg configuration)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<EntryUUIDPluginCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.