org.opends.server.schema

Class DirectoryStringSyntax

java.lang.Object

org.opends.server.api.AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

org.opends.server.schema.DirectoryStringSyntax

All Implemented Interfaces:

ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>

public class DirectoryStringSyntax
extends AttributeSyntax<DirectoryStringAttributeSyntaxCfg>
implements ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>

This class defines the directory string attribute syntax, which is simply a set of UTF-8 characters. By default, they will be treated in a case-insensitive manner, and equality, ordering, substring, and approximate matching will be allowed.

Constructor Summary

Constructors

Constructor and Description
DirectoryStringSyntax() Creates a new instance of this syntax.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowZeroLengthValues() Indicates whether zero-length values will be allowed.
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(DirectoryStringAttributeSyntaxCfg configuration) Applies the configuration changes to this change listener.
void	finalizeSyntax() Performs any finalization that may be necessary for this attribute syntax.
String	getDescription() Retrieves a description for this attribute syntax.
String	getName() Retrieves the common name for this attribute syntax.
String	getOID() Retrieves the OID for this attribute syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.
void	initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration, ServerContext serverContext) Initializes this attribute syntax based on the information in the provided configuration entry.
boolean	isConfigurationChangeAcceptable(DirectoryStringAttributeSyntaxCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.

Methods inherited from class org.opends.server.api.AttributeSyntax

equals, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectoryStringSyntax

public DirectoryStringSyntax()

Creates a new instance of this syntax. Note that the only thing that should be done here is to invoke the default constructor for the superclass. All initialization should be performed in the initializeSyntax method.

Method Detail

initializeSyntax

public void initializeSyntax(DirectoryStringAttributeSyntaxCfg configuration,
                    ServerContext serverContext)
                      throws org.forgerock.opendj.config.server.ConfigException

Initializes this attribute syntax based on the information in the provided configuration entry.

Overrides:

initializeSyntax in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

Parameters:

configuration - The configuration to use to initialize this attribute syntax.

serverContext - The server context.

Throws:

org.forgerock.opendj.config.server.ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

getSDKSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)

Returns the SDK Syntax equivalent to this syntax.

This method allow smooth migration to SDK syntax. It will disappear once the the migration to SDK schema is complete, together with this class and all its implementation.

Specified by:

getSDKSyntax in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

finalizeSyntax

public void finalizeSyntax()

Performs any finalization that may be necessary for this attribute syntax.

Overrides:

finalizeSyntax in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

Returns:

The common name for this attribute syntax.

getOID

public String getOID()

Retrieves the OID for this attribute syntax.

Specified by:

getOID in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<DirectoryStringAttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

allowZeroLengthValues

public boolean allowZeroLengthValues()

Indicates whether zero-length values will be allowed. This is technically forbidden by the LDAP specification, but it was allowed in earlier versions of the server, and the discussion of the directory string syntax in RFC 2252 does not explicitly state that they are not allowed.

Returns:

true if zero-length values should be allowed for attributes with a directory string syntax, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(DirectoryStringAttributeSyntaxCfg configuration,
                                      List<LocalizableMessage> unacceptableReasons)

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>

Parameters:

configuration - The new configuration containing the changes.

unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(DirectoryStringAttributeSyntaxCfg configuration)

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg>

Parameters:

configuration - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.