org.opends.server.schema

Class DITStructureRuleSyntax

java.lang.Object

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

org.opends.server.schema.DITStructureRuleSyntax

public class DITStructureRuleSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class implements the DIT structure rule description syntax, which is used to hold DIT structure rule definitions in the server schema. The format of this syntax is defined in RFC 2252.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static DITStructureRule	decodeDITStructureRule(org.forgerock.opendj.ldap.ByteSequence value, Schema schema, boolean allowUnknownElements) Decodes the contents of the provided ASN.1 octet string as a DIT structure rule definition according to the rules of this 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.

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

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, 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

DITStructureRuleSyntax

public DITStructureRuleSyntax()

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.

decodeDITStructureRule

public static DITStructureRule decodeDITStructureRule(org.forgerock.opendj.ldap.ByteSequence value,
                                      Schema schema,
                                      boolean allowUnknownElements)
                                               throws DirectoryException

Decodes the contents of the provided ASN.1 octet string as a DIT structure rule definition according to the rules of this syntax. Note that the provided octet string 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 ASN.1 octet string containing the value to decode (it does not need to be normalized).

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

allowUnknownElements - Indicates whether to allow values that reference a name form and/or superior rules which are not defined in the server schema. This should only be true when called by valueIsAcceptable.

Returns:

The decoded DIT structure rule definition.

Throws:

DirectoryException - If the provided value cannot be decoded as an DIT structure rule definition.