org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends SevenBitCleanPluginCfgClient,? extends SevenBitCleanPluginCfg> definition()
          Get the configuration definition associated with this Seven Bit Clean Plugin.
 java.util.SortedSet<AttributeType> getAttributeType()
          Gets the "attribute-type" property.
 java.util.SortedSet<DN> getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 void setAttributeType(java.util.Collection<AttributeType> values)
          Sets the "attribute-type" property.
 void setBaseDN(java.util.Collection<DN> values)
          Sets the "base-dn" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

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

java.util.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.

Returns:
Returns the values of the "attribute-type" property.

setAttributeType

void setAttributeType(java.util.Collection<AttributeType> values)
                      throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.

getBaseDN

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

setBaseDN

void setBaseDN(java.util.Collection<DN> values)
               throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface PluginCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getPluginType

java.util.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.

Specified by:
getPluginType in interface PluginCfgClient
Returns:
Returns the values of the "plugin-type" property.

setPluginType

void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.