public class ReferentialIntegrityPlugin extends DirectoryServerPlugin<ReferentialIntegrityPluginCfg> implements ConfigurationChangeListener<ReferentialIntegrityPluginCfg>, ServerShutdownListener
Modifier and Type | Field and Description |
---|---|
static String |
DELETE_DNS
Used to save a set in the delete operation attachment map that holds the subordinate entry DNs related to a
delete operation.
|
static String |
MODIFYDN_DNS
Used to save a map in the modifyDN operation attachment map that holds the old entry DNs and the new entry DNs
related to a modify DN rename to new superior operation.
|
Constructor and Description |
---|
ReferentialIntegrityPlugin() |
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(ReferentialIntegrityPluginCfg newConfiguration)
Applies the configuration changes to this change listener.
|
PluginResult.PostOperation |
doPostOperation(PostOperationDeleteOperation deleteOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for a delete operation but before the response has been sent to the client.
|
PluginResult.PostOperation |
doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done after the Directory Server has completed the core
processing for a modify DN operation but before the response has been sent to the client.
|
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(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.
|
String |
getShutdownListenerName()
Return the listener name.
|
void |
initializePlugin(Set<PluginType> pluginTypes,
ReferentialIntegrityPluginCfg pluginCfg)
Performs any initialization necessary for this plugin.
|
boolean |
isConfigurationAcceptable(ReferentialIntegrityPluginCfg pluginCfg,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this plugin.
|
boolean |
isConfigurationChangeAcceptable(ReferentialIntegrityPluginCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable
to this change listener.
|
void |
processServerShutdown(LocalizableMessage reason)
Process a server shutdown.
|
PluginResult.SubordinateDelete |
processSubordinateDelete(DeleteOperation deleteOperation,
Entry entry)
Performs any necessary processing that should be done whenever a subordinate entry is deleted as part of subtree
delete operation.
|
PluginResult.SubordinateModifyDN |
processSubordinateModifyDN(SubordinateModifyDNOperation modifyDNOperation,
Entry oldEntry,
Entry newEntry,
List<Modification> modifications)
Performs any necessary processing that should be done whenever a subordinate entry is moved or renamed as part of
a modify DN operation.
|
doLDIFExport, doLDIFImport, doLDIFImportBegin, doLDIFImportEnd, doPostConnect, doPostDisconnect, 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, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doPreParse, doShutdown, doStartup, getPluginEntryDN, getPluginTypes, getServerContext, initializeInternal, invokeForInternalOperations, processIntermediateResponse, processSearchEntry, processSearchReference, setInvokeForInternalOperations
public static final String MODIFYDN_DNS
public static final String DELETE_DNS
public final void initializePlugin(Set<PluginType> pluginTypes, ReferentialIntegrityPluginCfg pluginCfg) throws ConfigException
DirectoryServerPlugin
initializePlugin
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
pluginTypes
- The set of plugin types that indicate the ways in which this plugin will be invoked.pluginCfg
- The configuration for this plugin.ConfigException
- If the provided entry does not contain a valid configuration for this plugin.public ConfigChangeResult applyConfigurationChange(ReferentialIntegrityPluginCfg newConfiguration)
ConfigurationChangeListener
applyConfigurationChange
in interface ConfigurationChangeListener<ReferentialIntegrityPluginCfg>
newConfiguration
- The new configuration containing the changes.public boolean isConfigurationAcceptable(ReferentialIntegrityPluginCfg pluginCfg, List<LocalizableMessage> unacceptableReasons)
DirectoryServerPlugin
isConfigurationAcceptable
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
pluginCfg
- 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(ReferentialIntegrityPluginCfg configuration, List<LocalizableMessage> unacceptableReasons)
ConfigurationChangeListener
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<ReferentialIntegrityPluginCfg>
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 PluginResult.PostOperation doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
modifyDNOperation
- The modify DN operation for which processing has completed but no response has yet been sent.public PluginResult.PostOperation doPostOperation(PostOperationDeleteOperation deleteOperation)
DirectoryServerPlugin
doPostOperation
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
deleteOperation
- The delete operation for which processing has completed but no response has yet been sent.public PluginResult.SubordinateModifyDN processSubordinateModifyDN(SubordinateModifyDNOperation modifyDNOperation, Entry oldEntry, Entry newEntry, List<Modification> modifications)
DirectoryServerPlugin
processSubordinateModifyDN
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
modifyDNOperation
- The modify DN operation with which the subordinate entry is associated.oldEntry
- The subordinate entry prior to the move/rename operation.newEntry
- The subordinate enry after the move/rename operation.modifications
- A list into which any modifications made to the target entry should be placed.public PluginResult.SubordinateDelete processSubordinateDelete(DeleteOperation deleteOperation, Entry entry)
DirectoryServerPlugin
processSubordinateDelete
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
deleteOperation
- The delete operation with which the subordinate entry is associated.entry
- The subordinate entry being deleted.public String getShutdownListenerName()
getShutdownListenerName
in interface ServerShutdownListener
public final void finalizePlugin()
DirectoryServerPlugin
finalizePlugin
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
public void processServerShutdown(LocalizableMessage reason)
processServerShutdown
in interface ServerShutdownListener
reason
- The reason message for the shutdown.public PluginResult.PreOperation doPreOperation(PreOperationModifyOperation modifyOperation)
DirectoryServerPlugin
doPreOperation
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
modifyOperation
- The modify operation to be processed.public PluginResult.PreOperation doPreOperation(PreOperationAddOperation addOperation)
DirectoryServerPlugin
doPreOperation
in class DirectoryServerPlugin<ReferentialIntegrityPluginCfg>
addOperation
- The add operation to be processed.Copyright 2010-2020 ForgeRock AS.