public final class SubtreeSpecificationSyntax extends AttributeSyntax<AttributeSyntaxCfg>
Constructor and Description |
---|
SubtreeSpecificationSyntax()
Creates a new instance of this syntax.
|
Modifier and Type | Method and Description |
---|---|
static SchemaBuilder |
addSubtreeSpecificationSyntax(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.
|
Syntax |
getSDKSyntax(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(ByteSequence value,
LocalizableMessageBuilder invalidReason)
Indicates whether the provided value is acceptable for use in an
attribute with this syntax.
|
equals, finalizeSyntax, getApproximateMatchingRule, getEqualityMatchingRule, getOrderingMatchingRule, getSubstringMatchingRule, hashCode, isConfigurationAcceptable, toString
public SubtreeSpecificationSyntax()
initializeSyntax
method.public void initializeSyntax(AttributeSyntaxCfg configuration, ServerContext serverContext) throws ConfigException, DirectoryException
AttributeSyntax
initializeSyntax
in class AttributeSyntax<AttributeSyntaxCfg>
configuration
- The configuration to use to initialize this attribute syntax.serverContext
- The server context.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.public static SchemaBuilder addSubtreeSpecificationSyntax(SchemaBuilder builder)
builder
- where to add the subtree specification syntaxpublic Syntax getSDKSyntax(Schema schema)
AttributeSyntax
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.
getSDKSyntax
in class AttributeSyntax<AttributeSyntaxCfg>
schema
- Schema to use to retrieve the syntaxpublic String getName()
AttributeSyntax
getName
in class AttributeSyntax<AttributeSyntaxCfg>
public String getOID()
AttributeSyntax
getOID
in class AttributeSyntax<AttributeSyntaxCfg>
public String getDescription()
AttributeSyntax
getDescription
in class AttributeSyntax<AttributeSyntaxCfg>
public boolean valueIsAcceptable(ByteSequence value, LocalizableMessageBuilder invalidReason)
AttributeSyntax
valueIsAcceptable
in class AttributeSyntax<AttributeSyntaxCfg>
value
- The value for which to make the
determination.invalidReason
- The buffer to which the invalid reason
should be appended.true
if the provided value is acceptable for use
with this syntax, or false
if not.public boolean isBEREncodingRequired()
AttributeSyntax
isBEREncodingRequired
in class AttributeSyntax<AttributeSyntaxCfg>
true
if this syntax required BER encoding.public boolean isHumanReadable()
AttributeSyntax
isHumanReadable
in class AttributeSyntax<AttributeSyntaxCfg>
true
if this syntax is human readable.Copyright 2010-2017 ForgeRock AS.