org.apache.directory.shared.ldap.schema
Interface Syntax

All Superinterfaces:
SchemaObject
All Known Implementing Classes:
AbstractSyntax

public interface Syntax
extends SchemaObject

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.
 

Version:
$Rev: 379008 $
Author:
Apache Directory Project
See Also:
RFC2252 Section 4.3.3, ldapbis [MODELS], DescriptionUtils.getDescription(Syntax)

Method Summary
 SyntaxChecker getSyntaxChecker()
          Gets the SyntaxChecker used to validate values in accordance with this Syntax.
 boolean isHumanReadible()
          Gets whether or not the Syntax is human readible.
 
Methods inherited from interface org.apache.directory.shared.ldap.schema.SchemaObject
getDescription, getName, getNames, getOid, isObsolete
 

Method Detail

isHumanReadible

public boolean isHumanReadible()
Gets whether or not the Syntax is human readible.

Returns:
true if the syntax can be interpretted by humans, false otherwise

getSyntaxChecker

public SyntaxChecker getSyntaxChecker()
                               throws javax.naming.NamingException
Gets the SyntaxChecker used to validate values in accordance with this Syntax.

Returns:
the SyntaxChecker
Throws:
javax.naming.NamingException


Copyright © 2003-2006 . All Rights Reserved.