Package 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 Description EntryUUIDPlugin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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(EntryUuidPluginCfg cfg, 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
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, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, processSubordinateDelete, processSubordinateModifyDN, setInvokeForInternalOperations
-
-
-
-
Method Detail
-
initializePlugin
public void initializePlugin(Set<PluginType> pluginTypes, EntryUuidPluginCfg configuration) throws 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 classDirectoryServerPlugin<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:
ConfigException
- If the provided entry does not contain a valid configuration for this plugin.
-
finalizePlugin
public 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 classDirectoryServerPlugin<EntryUuidPluginCfg>
-
doLDIFImport
public 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 classDirectoryServerPlugin<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 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 classDirectoryServerPlugin<EntryUuidPluginCfg>
- Parameters:
addOperation
- The add operation to be processed.- Returns:
- Information about the result of the plugin processing.
-
isConfigurationAcceptable
public boolean isConfigurationAcceptable(EntryUuidPluginCfg cfg, 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 classDirectoryServerPlugin<EntryUuidPluginCfg>
- Parameters:
cfg
- 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, orfalse
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 interfaceConfigurationChangeListener<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, orfalse
if it is not.
-
applyConfigurationChange
public ConfigChangeResult applyConfigurationChange(EntryUuidPluginCfg configuration)
Description copied from interface:ConfigurationChangeListener
Applies the configuration changes to this change listener.- Specified by:
applyConfigurationChange
in interfaceConfigurationChangeListener<EntryUuidPluginCfg>
- Parameters:
configuration
- The new configuration containing the changes.- Returns:
- Returns information about the result of changing the configuration.
-
-