org.opends.server.schema

Class LDAPSyntaxDescriptionSyntax

java.lang.Object

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

org.opends.server.schema.LDAPSyntaxDescriptionSyntax

public class LDAPSyntaxDescriptionSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class defines the LDAP syntax description syntax, which is used to hold attribute syntax definitions in the server schema. The format of this syntax is defined in RFC 2252.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static LDAPSyntaxDescription	decodeLDAPSyntax(org.forgerock.opendj.ldap.ByteSequence value, ServerContext serverContext, Schema schema, boolean allowUnknownElements, boolean forDelete) Decodes the contents of the provided byte sequence as an ldap syntax definition according to the rules of this syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getApproximateMatchingRule() Retrieves the default approximate matching rule that will be used for attributes with this syntax.
String	getDescription() Retrieves a description for this attribute syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getEqualityMatchingRule() Retrieves the default equality matching rule that will be used for attributes with this 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.MatchingRule	getOrderingMatchingRule() Retrieves the default ordering matching rule that will be used for attributes with this syntax.
org.forgerock.opendj.ldap.schema.Syntax	getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema) Returns the SDK Syntax equivalent to this syntax.
org.forgerock.opendj.ldap.schema.MatchingRule	getSubstringMatchingRule() Retrieves the default substring matching rule that will be used for attributes with this syntax.

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

equals, finalizeSyntax, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptable

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSyntaxDescriptionSyntax

public LDAPSyntaxDescriptionSyntax()

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

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<AttributeSyntaxCfg>

Parameters:

schema - Schema to use to retrieve the syntax

Returns:

the equivalent SDK syntax.

getName

public String getName()

Retrieves the common name for this attribute syntax.

Specified by:

getName in class AttributeSyntax<AttributeSyntaxCfg>

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<AttributeSyntaxCfg>

Returns:

The OID for this attribute syntax.

getDescription

public String getDescription()

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

getEqualityMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getEqualityMatchingRule()

Retrieves the default equality matching rule that will be used for attributes with this syntax.

Overrides:

getEqualityMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default equality matching rule that will be used for attributes with this syntax, or null if equality matches will not be allowed for this type by default.

getOrderingMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getOrderingMatchingRule()

Retrieves the default ordering matching rule that will be used for attributes with this syntax.

Overrides:

getOrderingMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default ordering matching rule that will be used for attributes with this syntax, or null if ordering matches will not be allowed for this type by default.

getSubstringMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getSubstringMatchingRule()

Retrieves the default substring matching rule that will be used for attributes with this syntax.

Overrides:

getSubstringMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default substring matching rule that will be used for attributes with this syntax, or null if substring matches will not be allowed for this type by default.

getApproximateMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getApproximateMatchingRule()

Retrieves the default approximate matching rule that will be used for attributes with this syntax.

Overrides:

getApproximateMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

The default approximate matching rule that will be used for attributes with this syntax, or null if approximate matches will not be allowed for this type by default.

decodeLDAPSyntax

public static LDAPSyntaxDescription decodeLDAPSyntax(org.forgerock.opendj.ldap.ByteSequence value,
                                     ServerContext serverContext,
                                     Schema schema,
                                     boolean allowUnknownElements,
                                     boolean forDelete)
                                              throws DirectoryException

Decodes the contents of the provided byte sequence as an ldap syntax definition according to the rules of this syntax. Note that the provided byte sequence value does not need to be normalized (and in fact, it should not be in order to allow the desired capitalization to be preserved).

Parameters:

value - The byte sequence containing the value to decode (it does not need to be normalized).

serverContext - The server context.

schema - The schema to use to resolve references to other schema elements.

allowUnknownElements - Indicates whether to allow values that are not defined in the server schema. This should only be true when called by valueIsAcceptable. Not used for LDAP Syntaxes

forDelete - true if used for deletion.

Returns:

The decoded ldapsyntax definition.

Throws:

DirectoryException - If the provided value cannot be decoded as an ldapsyntax definition.