public class LDAPSyntaxDescriptionSyntax extends AttributeSyntax<AttributeSyntaxCfg>
| Constructor and Description |
|---|
LDAPSyntaxDescriptionSyntax()
Creates a new instance of this syntax.
|
| 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.
|
equals, finalizeSyntax, hashCode, initializeSyntax, isBEREncodingRequired, isConfigurationAcceptable, isHumanReadable, toString, toString, valueIsAcceptablepublic LDAPSyntaxDescriptionSyntax()
initializeSyntax method.public org.forgerock.opendj.ldap.schema.Syntax getSDKSyntax(org.forgerock.opendj.ldap.schema.Schema schema)
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()
getName in class AttributeSyntax<AttributeSyntaxCfg>public String getOID()
getOID in class AttributeSyntax<AttributeSyntaxCfg>public String getDescription()
getDescription in class AttributeSyntax<AttributeSyntaxCfg>public org.forgerock.opendj.ldap.schema.MatchingRule getEqualityMatchingRule()
getEqualityMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>null if equality
matches will not be allowed for this type by default.public org.forgerock.opendj.ldap.schema.MatchingRule getOrderingMatchingRule()
getOrderingMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>null if ordering
matches will not be allowed for this type by default.public org.forgerock.opendj.ldap.schema.MatchingRule getSubstringMatchingRule()
getSubstringMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>null if substring
matches will not be allowed for this type by default.public org.forgerock.opendj.ldap.schema.MatchingRule getApproximateMatchingRule()
getApproximateMatchingRule in class AttributeSyntax<AttributeSyntaxCfg>null if approximate
matches will not be allowed for this type by default.public static LDAPSyntaxDescription decodeLDAPSyntax(org.forgerock.opendj.ldap.ByteSequence value, ServerContext serverContext, Schema schema, boolean allowUnknownElements, boolean forDelete) throws DirectoryException
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 SyntaxesforDelete - true if used for deletion.DirectoryException - If the provided value cannot be decoded as an
ldapsyntax definition.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.