|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.DirectoryServerPlugin<EntryUUIDPluginCfg>
org.opends.server.plugins.EntryUUIDPlugin
public final class EntryUUIDPlugin
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 | |
---|---|
EntryUUIDPlugin()
Creates a new instance of this Directory Server plugin. |
Method Summary | |
---|---|
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(java.util.Set<PluginType> pluginTypes,
EntryUUIDPluginCfg configuration)
Performs any initialization necessary for this plugin. |
boolean |
isConfigurationAcceptable(PluginCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this plugin. |
boolean |
isConfigurationChangeAcceptable(EntryUUIDPluginCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EntryUUIDPlugin()
super()
as its first element.
Method Detail |
---|
public final void initializePlugin(java.util.Set<PluginType> pluginTypes, EntryUUIDPluginCfg configuration) throws ConfigException
initializePlugin
in class DirectoryServerPlugin<EntryUUIDPluginCfg>
pluginTypes
- The set of plugin types that indicate the
ways in which this plugin will be invoked.configuration
- The configuration for this plugin.
ConfigException
- If the provided entry does not contain
a valid configuration for this plugin.public final void finalizePlugin()
finalizePlugin
in class DirectoryServerPlugin<EntryUUIDPluginCfg>
public final PluginResult.ImportLDIF doLDIFImport(LDIFImportConfig importConfig, Entry entry)
doLDIFImport
in class DirectoryServerPlugin<EntryUUIDPluginCfg>
importConfig
- The configuration used for the LDIF import.entry
- The entry that has been read to the LDIF
file.
public final PluginResult.PreOperation doPreOperation(PreOperationAddOperation addOperation)
doPreOperation
in class DirectoryServerPlugin<EntryUUIDPluginCfg>
addOperation
- The add operation to be processed.
public boolean isConfigurationAcceptable(PluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class DirectoryServerPlugin<EntryUUIDPluginCfg>
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.
true
if the provided configuration is acceptable
for this plugin, or false
if not.public boolean isConfigurationChangeAcceptable(EntryUUIDPluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<EntryUUIDPluginCfg>
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.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(EntryUUIDPluginCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<EntryUUIDPluginCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |