Package org.apache.directory.api.ldap.model.schema

Class LdapSyntax

  • All Implemented Interfaces:
    Serializable, SchemaObject
    public class LdapSyntax
extends AbstractSchemaObject
    A syntax definition. Each attribute stored in a directory has a defined syntax (i.e. data type) which constrains the structure and format of its values. The description of each syntax specifies how attribute or assertion values conforming to the syntax are normally represented when transferred in LDAP operations. This representation is referred to as the LDAP-specific encoding to distinguish it from other methods of encoding attribute values.

    According to ldapbis [MODELS]: 

      4.1.5. LDAP Syntaxes
 
    LDAP Syntaxes of (attribute and assertion) values are described in
    terms of ASN.1 [X.680] and, optionally, have an octet string encoding
    known as the LDAP-specific encoding.  Commonly, the LDAP-specific
    encoding is constrained to string of Universal Character Set (UCS)
    [ISO10646] characters in UTF-8 [UTF-8] form.
 
    Each LDAP syntax is identified by an object identifier (OID).
 
    LDAP syntax definitions are written according to the ABNF:
 
      SyntaxDescription = LPAREN WSP
          numericoid                ; object identifier
          [ SP "DESC" SP qdstring ] ; description
          extensions WSP RPAREN     ; extensions
 
    where:
      [numericoid] is object identifier assigned to this LDAP syntax;
      DESC [qdstring] is a short descriptive string; and
      [extensions] describe extensions.
    Author:
    Apache Directory Project
    See Also:
    RFC2252 Section 4.3.3, ldapbis [MODELS], Serialized Form

    • Constructor Detail

      • LdapSyntax

        public LdapSyntax​(String oid)
        Creates a Syntax object using a unique OID.
        Parameters:
        oid - the OID for this Syntax

      • LdapSyntax

        public LdapSyntax​(String oid,
                  String description)
        Creates a Syntax object using a unique OID.
        Parameters:
        oid - the OID for this syntax
        description - the description for this syntax

      • LdapSyntax

        public LdapSyntax​(String oid,
                  String description,
                  boolean isHumanReadable)
        Creates a Syntax object using a unique OID.
        Parameters:
        oid - the OID for this syntax
        description - the description for this syntax
        isHumanReadable - true if this syntax is human readable