Package org.forgerock.opendj.server.config.server

Interface SevenBitCleanPluginCfg

All Superinterfaces:

Configuration, PluginCfg

public interface SevenBitCleanPluginCfg
extends PluginCfg

A server-side interface for querying Seven Bit Clean Plugin settings.

The Seven Bit Clean Plugin ensures that values for a specified set of attributes are 7-bit clean.

Method Summary

Modifier and Type	Method	Description
void	addSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener)	Register to be notified when this Seven Bit Clean Plugin is changed.
Class<? extends SevenBitCleanPluginCfg>	configurationClass()	Gets the configuration class associated with this Seven Bit Clean Plugin.
SortedSet<AttributeType>	getAttributeType()	Gets the "attribute-type" property.
SortedSet<Dn>	getBaseDn()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<PluginCfgDefn.PluginType>	getPluginType()	Gets the "plugin-type" property.
void	removeSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener)	Deregister an existing Seven Bit Clean Plugin configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.PluginCfg

addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener

Method Detail

configurationClass

Class<? extends SevenBitCleanPluginCfg> configurationClass()

Gets the configuration class associated with this Seven Bit Clean Plugin.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface PluginCfg

Returns:

Returns the configuration class associated with this Seven Bit Clean Plugin.

addSevenBitCleanChangeListener

void addSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener)

Register to be notified when this Seven Bit Clean Plugin is changed.

Parameters:

listener - The Seven Bit Clean Plugin configuration change listener.

removeSevenBitCleanChangeListener

void removeSevenBitCleanChangeListener(ConfigurationChangeListener<SevenBitCleanPluginCfg> listener)

Deregister an existing Seven Bit Clean Plugin configuration change listener.

Parameters:

listener - The Seven Bit Clean Plugin configuration change listener.

getAttributeType

SortedSet<AttributeType> getAttributeType()

Gets the "attribute-type" property.

Specifies the name or OID of an attribute type for which values should be checked to ensure that they are 7-bit clean.

Default values: uid, mail, userPassword

Returns:

Returns an unmodifiable set containing the values of the "attribute-type" property.

getBaseDn

SortedSet<Dn> getBaseDn()

Gets the "base-dn" property.

Specifies the base DN below which the checking is performed.

Any attempt to update a value for one of the configured attributes below this base DN must be 7-bit clean for the operation to be allowed.

Returns:

Returns an unmodifiable set containing the values of the "base-dn" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Default value: org.opends.server.plugins.SevenBitCleanPlugin

Specified by:

getJavaClass in interface PluginCfg

Returns:

Returns the value of the "java-class" property.

getPluginType

SortedSet<PluginCfgDefn.PluginType> getPluginType()

Gets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Default values: ldifimport, preparseadd, preparsemodify, preparsemodifydn

Specified by:

getPluginType in interface PluginCfg

Returns:

Returns an unmodifiable set containing the values of the "plugin-type" property.