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

All Superinterfaces:
AttributeSyntaxCfgClient, ConfigurationClient

public interface AttributeTypeDescriptionAttributeSyntaxCfgClient
extends AttributeSyntaxCfgClient

A client-side interface for reading and modifying Attribute Type Description Attribute Syntax settings.

Attribute Type Description Attribute Syntaxes describe the format of the directory schema attribute type definitions.


Method Summary
 ManagedObjectDefinition<? extends AttributeTypeDescriptionAttributeSyntaxCfgClient,? extends AttributeTypeDescriptionAttributeSyntaxCfg> definition()
          Get the configuration definition associated with this Attribute Type Description Attribute Syntax.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isStripSyntaxMinUpperBound()
          Gets the "strip-syntax-min-upper-bound" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setStripSyntaxMinUpperBound(java.lang.Boolean value)
          Sets the "strip-syntax-min-upper-bound" 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 AttributeTypeDescriptionAttributeSyntaxCfgClient,? extends AttributeTypeDescriptionAttributeSyntaxCfg> definition()
Get the configuration definition associated with this Attribute Type Description Attribute Syntax.

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

getJavaClass

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

Specifies the fully-qualified name of the Java class that provides the Attribute Type Description 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 Attribute Type Description Attribute Syntax implementation.

This property is read-only and can only be modified during creation of a Attribute Type Description 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 Attribute Type Description Attribute Syntax is not being initialized.

isStripSyntaxMinUpperBound

boolean isStripSyntaxMinUpperBound()
Gets the "strip-syntax-min-upper-bound" property.

Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.

When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

Returns:
Returns the value of the "strip-syntax-min-upper-bound" property.

setStripSyntaxMinUpperBound

void setStripSyntaxMinUpperBound(java.lang.Boolean value)
                                 throws IllegalPropertyValueException
Sets the "strip-syntax-min-upper-bound" property.

Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.

When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

Parameters:
value - The value of the "strip-syntax-min-upper-bound" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.