|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.plugin.DirectoryServerPlugin<SevenBitCleanPluginCfg>
org.opends.server.plugins.SevenBitCleanPlugin
public final class SevenBitCleanPlugin
This class implements a Directory Server plugin that can be used to ensure that the values for a specified set of attributes (optionally, below a specified set of base DNs) are 7-bit clean (i.e., contain only ASCII characters).
Constructor Summary | |
---|---|
SevenBitCleanPlugin()
Creates a new instance of this Directory Server plugin. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(SevenBitCleanPluginCfg 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.PreParse |
doPreParse(PreParseAddOperation addOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of an add request. |
PluginResult.PreParse |
doPreParse(PreParseModifyDNOperation modifyDNOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a modify DN request. |
PluginResult.PreParse |
doPreParse(PreParseModifyOperation modifyOperation)
Performs any necessary processing that should be done before the Directory Server parses the elements of a modify request. |
void |
finalizePlugin()
Performs any necessary finalization for this plugin. |
void |
initializePlugin(java.util.Set<PluginType> pluginTypes,
SevenBitCleanPluginCfg 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(SevenBitCleanPluginCfg 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 SevenBitCleanPlugin()
super()
as its first element.
Method Detail |
---|
public final void initializePlugin(java.util.Set<PluginType> pluginTypes, SevenBitCleanPluginCfg configuration) throws ConfigException
initializePlugin
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
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<SevenBitCleanPluginCfg>
public final PluginResult.ImportLDIF doLDIFImport(LDIFImportConfig importConfig, Entry entry)
doLDIFImport
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
importConfig
- The configuration used for the LDIF import.entry
- The entry that has been read to the LDIF
file.
public final PluginResult.PreParse doPreParse(PreParseAddOperation addOperation)
doPreParse
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
addOperation
- The add operation that has been requested.
public final PluginResult.PreParse doPreParse(PreParseModifyOperation modifyOperation)
doPreParse
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
modifyOperation
- The modify operation that has been
requested.
public final PluginResult.PreParse doPreParse(PreParseModifyDNOperation modifyDNOperation)
doPreParse
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
modifyDNOperation
- The modify DN operation that has been
requested.
public boolean isConfigurationAcceptable(PluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class DirectoryServerPlugin<SevenBitCleanPluginCfg>
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(SevenBitCleanPluginCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<SevenBitCleanPluginCfg>
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(SevenBitCleanPluginCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<SevenBitCleanPluginCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |