|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.DirectoryServerPlugin<UniqueAttributePluginCfg>
org.opends.server.plugins.UniqueAttributePlugin
public class UniqueAttributePlugin
This class implements a Directory Server plugin that can be used to ensure that all values for a given attribute or set of attributes are unique within the server (or optionally, below a specified set of base DNs). It will examine all add, modify, and modify DN operations to determine whether any new conflicts are introduced. If a conflict is detected then the operation will be rejected, unless that operation is being applied through synchronization in which case an alert will be generated to notify administrators of the problem.
Constructor Summary | |
---|---|
UniqueAttributePlugin()
|
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(UniqueAttributePluginCfg newConfiguration)
Applies the configuration changes to this change listener. |
void |
doPostSynchronization(PostSynchronizationAddOperation addOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for an add operation performed via synchronization. |
void |
doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a modify DN operation performed via synchronization. |
void |
doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
Performs any necessary processing that should be done after the Directory Server has completed processing for a modify operation performed via synchronization. |
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. |
PluginResult.PreOperation |
doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify DN operation. |
PluginResult.PreOperation |
doPreOperation(PreOperationModifyOperation modifyOperation)
Performs any necessary processing that should be done just before the Directory Server performs the core processing for a modify operation. |
void |
finalizePlugin()
Performs any necessary finalization for this plugin. |
java.util.LinkedHashMap<java.lang.String,java.lang.String> |
getAlerts()
Retrieves information about the set of alerts that this generator may produce. |
java.lang.String |
getClassName()
Retrieves the fully-qualified name of the Java class for this alert generator implementation. |
DN |
getComponentEntryDN()
Retrieves the DN of the configuration entry with which this alert generator is associated. |
void |
initializePlugin(java.util.Set<PluginType> pluginTypes,
UniqueAttributePluginCfg 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(UniqueAttributePluginCfg 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 UniqueAttributePlugin()
Method Detail |
---|
public final void initializePlugin(java.util.Set<PluginType> pluginTypes, UniqueAttributePluginCfg configuration) throws ConfigException
initializePlugin
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
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<UniqueAttributePluginCfg>
public final PluginResult.PreOperation doPreOperation(PreOperationAddOperation addOperation)
doPreOperation
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
addOperation
- The add operation to be processed.
public final PluginResult.PreOperation doPreOperation(PreOperationModifyOperation modifyOperation)
doPreOperation
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
modifyOperation
- The modify operation to be processed.
public final PluginResult.PreOperation doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
doPreOperation
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
modifyDNOperation
- The modify DN operation to be
processed.
public final void doPostSynchronization(PostSynchronizationAddOperation addOperation)
doPostSynchronization
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
addOperation
- The synchronized add operation for which
processing has been completed.public final void doPostSynchronization(PostSynchronizationModifyOperation modifyOperation)
doPostSynchronization
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
modifyOperation
- The synchronized modify operation for
which processing has been completed.public final void doPostSynchronization(PostSynchronizationModifyDNOperation modifyDNOperation)
doPostSynchronization
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
modifyDNOperation
- The synchronized modify DN operation
for which processing has been
completed.public boolean isConfigurationAcceptable(PluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class DirectoryServerPlugin<UniqueAttributePluginCfg>
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(UniqueAttributePluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<UniqueAttributePluginCfg>
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(UniqueAttributePluginCfg newConfiguration)
applyConfigurationChange
in interface ConfigurationChangeListener<UniqueAttributePluginCfg>
newConfiguration
- The new configuration containing the changes.
public DN getComponentEntryDN()
getComponentEntryDN
in interface AlertGenerator
public java.lang.String getClassName()
getClassName
in interface AlertGenerator
public java.util.LinkedHashMap<java.lang.String,java.lang.String> getAlerts()
getAlerts
in interface AlertGenerator
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |