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

Interface SevenBitCleanPluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface SevenBitCleanPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying 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
ManagedObjectDefinition<? extends SevenBitCleanPluginCfgClient,? extends SevenBitCleanPluginCfg>	definition()	Get the configuration definition associated with this Seven Bit Clean Plugin.
SortedSet<ValueOrExpression<AttributeType>>	getAttributeType()	Gets the "attribute-type" property.
SortedSet<ValueOrExpression<Dn>>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>	getPluginType()	Gets the "plugin-type" property.
void	setAttributeType(Collection<ValueOrExpression<AttributeType>> values)	Sets the "attribute-type" property.
void	setBaseDn(Collection<ValueOrExpression<Dn>> values)	Sets the "base-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)	Sets the "plugin-type" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.PluginCfgClient

isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations

Method Details

definition

ManagedObjectDefinition<? extends SevenBitCleanPluginCfgClient,? extends SevenBitCleanPluginCfg> definition()

Get the configuration definition associated with this Seven Bit Clean Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

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

getAttributeType

@MandatoryProperty
SortedSet<ValueOrExpression<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 the values of the "attribute-type" property.

setAttributeType

@MandatoryProperty
void setAttributeType(Collection<ValueOrExpression<AttributeType>> values)
               throws PropertyException

Sets 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.

Parameters:

values - The values of the "attribute-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getBaseDn

SortedSet<ValueOrExpression<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 the values of the "base-dn" property.

setBaseDn

void setBaseDn(Collection<ValueOrExpression<Dn>> values)
        throws PropertyException

Sets 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.

Parameters:

values - The values of the "base-dn" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 PluginCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface PluginCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getPluginType

@MandatoryProperty
SortedSet<ValueOrExpression<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 PluginCfgClient

Returns:

Returns the values of the "plugin-type" property.

setPluginType

@MandatoryProperty
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
            throws PropertyException

Sets 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.

Specified by:

setPluginType in interface PluginCfgClient

Parameters:

values - The values of the "plugin-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.