org.opends.server.schema

Class SubtreeSpecificationSyntax

java.lang.Object

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

org.opends.server.schema.SubtreeSpecificationSyntax

public final class SubtreeSpecificationSyntax
extends AttributeSyntax<AttributeSyntaxCfg>

This class defines the subtree specification attribute syntax, which is used to specify the scope of sub-entries (RFC 3672).

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static org.forgerock.opendj.ldap.schema.SchemaBuilder	addSubtreeSpecificationSyntax(org.forgerock.opendj.ldap.schema.SchemaBuilder builder) Adds the subtree specification syntax to the provided schema builder.
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(AttributeSyntaxCfg configuration, ServerContext serverContext) Initializes this attribute syntax based on the information in the provided configuration entry.
boolean	isBEREncodingRequired() Indicates whether this attribute syntax requires BER encoding.
boolean	isHumanReadable() Indicates whether this attribute syntax is human readable.
boolean	valueIsAcceptable(org.forgerock.opendj.ldap.ByteSequence value, LocalizableMessageBuilder invalidReason) Indicates whether the provided value is acceptable for use in an attribute with this syntax.

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

equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, isConfigurationAcceptable, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SubtreeSpecificationSyntax

public SubtreeSpecificationSyntax()

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(AttributeSyntaxCfg configuration,
                    ServerContext serverContext)
                      throws org.forgerock.opendj.config.server.ConfigException,
                             DirectoryException

Description copied from class: AttributeSyntax

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

Overrides:

initializeSyntax in class AttributeSyntax<AttributeSyntaxCfg>

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.

DirectoryException - If an unrecoverable problem arises in the process of performing the initialization.

addSubtreeSpecificationSyntax

public static org.forgerock.opendj.ldap.schema.SchemaBuilder addSubtreeSpecificationSyntax(org.forgerock.opendj.ldap.schema.SchemaBuilder builder)

Adds the subtree specification syntax to the provided schema builder.

Parameters:

builder - where to add the subtree specification syntax

Returns:

the provided builder

getSDKSyntax

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

Description copied from class: AttributeSyntax

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()

Description copied from class: AttributeSyntax

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()

Description copied from class: AttributeSyntax

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()

Description copied from class: AttributeSyntax

Retrieves a description for this attribute syntax.

Specified by:

getDescription in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

A description for this attribute syntax.

valueIsAcceptable

public boolean valueIsAcceptable(org.forgerock.opendj.ldap.ByteSequence value,
                        LocalizableMessageBuilder invalidReason)

Description copied from class: AttributeSyntax

Indicates whether the provided value is acceptable for use in an attribute with this syntax. If it is not, then the reason may be appended to the provided buffer.

Overrides:

valueIsAcceptable in class AttributeSyntax<AttributeSyntaxCfg>

Parameters:

value - The value for which to make the determination.

invalidReason - The buffer to which the invalid reason should be appended.

Returns:

true if the provided value is acceptable for use with this syntax, or false if not.

isBEREncodingRequired

public boolean isBEREncodingRequired()

Description copied from class: AttributeSyntax

Indicates whether this attribute syntax requires BER encoding.

Overrides:

isBEREncodingRequired in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

true if this syntax required BER encoding.

isHumanReadable

public boolean isHumanReadable()

Description copied from class: AttributeSyntax

Indicates whether this attribute syntax is human readable.

Overrides:

isHumanReadable in class AttributeSyntax<AttributeSyntaxCfg>

Returns:

true if this syntax is human readable.