org.opends.server.admin.std.client
Interface DirectoryStringAttributeSyntaxCfgClient

All Superinterfaces:
AttributeSyntaxCfgClient, ConfigurationClient

public interface DirectoryStringAttributeSyntaxCfgClient
extends AttributeSyntaxCfgClient

A client-side interface for reading and modifying Directory String Attribute Syntax settings.

The Directory String Attribute Syntax defines an attribute syntax for storing arbitrary string (and sometimes binary) data.


Method Summary
 ManagedObjectDefinition<? extends DirectoryStringAttributeSyntaxCfgClient,? extends DirectoryStringAttributeSyntaxCfg> definition()
          Get the configuration definition associated with this Directory String Attribute Syntax.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isAllowZeroLengthValues()
          Gets the "allow-zero-length-values" property.
 void setAllowZeroLengthValues(java.lang.Boolean value)
          Sets the "allow-zero-length-values" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.std.client.AttributeSyntaxCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends DirectoryStringAttributeSyntaxCfgClient,? extends DirectoryStringAttributeSyntaxCfg> definition()
Get the configuration definition associated with this Directory String Attribute Syntax.

Specified by:
definition in interface AttributeSyntaxCfgClient
Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Directory String Attribute Syntax.

isAllowZeroLengthValues

boolean isAllowZeroLengthValues()
Gets the "allow-zero-length-values" property.

Indicates whether zero-length (that is, an empty string) values are allowed.

This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

Returns:
Returns the value of the "allow-zero-length-values" property.

setAllowZeroLengthValues

void setAllowZeroLengthValues(java.lang.Boolean value)
                              throws IllegalPropertyValueException
Sets the "allow-zero-length-values" property.

Indicates whether zero-length (that is, an empty string) values are allowed.

This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

Parameters:
value - The value of the "allow-zero-length-values" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

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

Specifies the fully-qualified name of the Java class that provides the Directory String Attribute Syntax implementation.

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException,
                         PropertyIsReadOnlyException
Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Directory String Attribute Syntax implementation.

This property is read-only and can only be modified during creation of a Directory String Attribute Syntax.

Specified by:
setJavaClass in interface AttributeSyntaxCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Directory String Attribute Syntax is not being initialized.