Class AttributeTypeDescriptionSyntaxChecker
- java.lang.Object
-
- org.apache.directory.api.ldap.model.schema.AbstractSchemaObject
-
- org.apache.directory.api.ldap.model.schema.LoadableSchemaObject
-
- org.apache.directory.api.ldap.model.schema.SyntaxChecker
-
- org.apache.directory.api.ldap.model.schema.syntaxCheckers.AttributeTypeDescriptionSyntaxChecker
-
- All Implemented Interfaces:
Serializable
,SchemaObject
public final class AttributeTypeDescriptionSyntaxChecker extends SyntaxChecker
A SyntaxChecker which verifies that a value follows the attribute type descripton syntax according to RFC 4512, par 4.2.2:AttributeTypeDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active [ SP "SUP" SP oid ] ; supertype [ SP "EQUALITY" SP oid ] ; equality matching rule [ SP "ORDERING" SP oid ] ; ordering matching rule [ SP "SUBSTR" SP oid ] ; substrings matching rule [ SP "SYNTAX" SP noidlen ] ; value syntax [ SP "SINGLE-VALUE" ] ; single-value [ SP "COLLECTIVE" ] ; collective [ SP "NO-USER-MODIFICATION" ] ; not user modifiable [ SP "USAGE" SP usage ] ; usage extensions WSP RPAREN ; extensions usage = "userApplications" / ; user "directoryOperation" / ; directory operational "distributedOperation" / ; DSA-shared operational "dSAOperation" ; DSA-specific operational extensions = *( SP xstring SP qdstrings ) xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) Each attribute type description must contain at least one of the SUP or SYNTAX fields. COLLECTIVE requires usage userApplications. NO-USER-MODIFICATION requires an operational usage.
- Author:
- Apache Directory Project
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AttributeTypeDescriptionSyntaxChecker.Builder
A static Builder for this class-
Nested classes/interfaces inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker
SyntaxChecker.SCBuilder<SC>
-
-
Field Summary
Fields Modifier and Type Field Description static AttributeTypeDescriptionSyntaxChecker
INSTANCE
A static instance of AttributeTypeDescriptionSyntaxChecker-
Fields inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker
serialVersionUID
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AttributeTypeDescriptionSyntaxChecker.Builder
builder()
boolean
isValidSyntax(Object value)
Determines if the attribute's value conforms to the attribute syntax.-
Methods inherited from class org.apache.directory.api.ldap.model.schema.SyntaxChecker
equals, setSchemaManager, toString
-
Methods inherited from class org.apache.directory.api.ldap.model.schema.LoadableSchemaObject
copy, getBytecode, getFqcn, hashCode, isValid, setBytecode, setFqcn
-
Methods inherited from class org.apache.directory.api.ldap.model.schema.AbstractSchemaObject
addExtension, addExtension, addName, clear, copy, getDescription, getExtension, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hasExtension, isDisabled, isEnabled, isObsolete, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setSchemaName, setSpecification, unlock
-
-
-
-
Field Detail
-
INSTANCE
public static final AttributeTypeDescriptionSyntaxChecker INSTANCE
A static instance of AttributeTypeDescriptionSyntaxChecker
-
-
Method Detail
-
builder
public static AttributeTypeDescriptionSyntaxChecker.Builder builder()
- Returns:
- An instance of the Builder for this class
-
isValidSyntax
public boolean isValidSyntax(Object value)
Determines if the attribute's value conforms to the attribute syntax.- Overrides:
isValidSyntax
in classSyntaxChecker
- Parameters:
value
- the value of some attribute with the syntax- Returns:
- true if the value is in the valid syntax, false otherwise
-
-