| Package | Description |
|---|---|
| org.apache.directory.api.ldap.model.entry | |
| org.apache.directory.api.ldap.model.schema |
Contains interfaces and base classes for representing the LDAP schema domain
model.
|
| org.apache.directory.api.ldap.model.schema.registries | |
| org.apache.directory.api.ldap.model.schema.syntaxCheckers |
| Modifier and Type | Method and Description |
|---|---|
boolean |
Value.isValid(SyntaxChecker syntaxChecker)
Uses the syntaxChecker associated with the attributeType to check if the
value is valid.
|
| Modifier and Type | Field and Description |
|---|---|
protected SyntaxChecker |
LdapSyntax.syntaxChecker
The associated SyntaxChecker
|
| Modifier and Type | Method and Description |
|---|---|
SyntaxChecker |
LdapSyntax.getSyntaxChecker()
Gets the SyntaxChecker used to validate values in accordance with this
Syntax.
|
SyntaxChecker |
SchemaManager.lookupSyntaxCheckerRegistry(String oid)
Lookup for a SyntaxChecker in the SyntaxChecker registry
|
| Modifier and Type | Method and Description |
|---|---|
Entry |
AttributesFactory.convert(SyntaxChecker syntaxChecker,
Schema schema,
SchemaManager schemaManager)
Convert a SyntaxChecker instance into an Entry
|
static String |
DescriptionUtils.getDescription(SyntaxChecker syntaxChecker)
Generates the SyntaxCheckerDescription for a SyntaxChecker.
|
void |
LdapSyntax.setSyntaxChecker(SyntaxChecker syntaxChecker)
Sets the associated SyntaxChecker
|
void |
LdapSyntax.updateSyntaxChecker(SyntaxChecker newSyntaxChecker)
Update the associated SyntaxChecker, even if the SchemaObject is readOnly
|
| Modifier and Type | Method and Description |
|---|---|
SyntaxChecker |
ImmutableSyntaxCheckerRegistry.get(String oid)
Gets the SchemaObject associated with a given OID.
|
SyntaxChecker |
ImmutableSyntaxCheckerRegistry.lookup(String oid)
Looks up a SchemaObject by its unique Object Identifier or by name.
|
SyntaxChecker |
SyntaxCheckerRegistry.unregister(String numericOid)
Removes the SyntaxChecker registered with this registry, using its
numeric OID.
|
SyntaxChecker |
ImmutableSyntaxCheckerRegistry.unregister(String numericOid)
Removes the SyntaxChecker registered with this registry, using its
numeric OID.
|
SyntaxChecker |
ImmutableSyntaxCheckerRegistry.unregister(SyntaxChecker schemaObject)
Removes the SchemaObject registered with this registry.
|
| Modifier and Type | Method and Description |
|---|---|
Iterator<SyntaxChecker> |
ImmutableSyntaxCheckerRegistry.iterator()
Gets an iterator over the registered schema objects in the registry.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SyntaxCheckerRegistry.register(SyntaxChecker syntaxChecker)
Registers a new SyntaxChecker with this registry.
|
void |
ImmutableSyntaxCheckerRegistry.register(SyntaxChecker syntaxChecker)
Registers a new SyntaxChecker with this registry.
|
private void |
Registries.resolve(SyntaxChecker syntaxChecker)
Attempts to resolve the SyntaxChecker
|
SyntaxChecker |
ImmutableSyntaxCheckerRegistry.unregister(SyntaxChecker schemaObject)
Removes the SchemaObject registered with this registry.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessPointSyntaxChecker
A SyntaxChecker which verifies that a value is an AccessPoint.
|
class |
AttributeTypeDescriptionSyntaxChecker
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.
|
class |
AttributeTypeUsageSyntaxChecker
A syntax checker which checks to see if an attributeType's type is either:
userApplications
directoryOperation
distributedOperation
dSAOperation
.*
The case is NOT ignored.
|
class |
AudioSyntaxChecker
A SyntaxChecker which verifies that a value is an Audio according to RFC 2252.
|
class |
BinarySyntaxChecker
A binary value (universal value acceptor) syntax checker.
|
class |
BitStringSyntaxChecker
A SyntaxChecker which verifies that a value is a Boolean according to RFC 4517.
|
class |
BooleanSyntaxChecker
A SyntaxChecker which verifies that a value is a Boolean according to RFC 4517.
|
class |
BootParameterSyntaxChecker
A SyntaxChecker which verifies that a value is a BootParameter according to
RFC 2307 :
bootparameter = key "=" server ":" path
key = keystring
server = keystring
path = keystring
|
class |
CertificateListSyntaxChecker
A SyntaxChecker which verifies that a value is a certificateList according to RFC 4523 :
"Due to changes made to the definition of a CertificateList through time,
no LDAP-specific encoding is defined for this syntax.
|
class |
CertificatePairSyntaxChecker
A SyntaxChecker which verifies that a value is a certificate pair according to RFC 4523 :
"Due to changes made to the definition of a CertificatePair through time,
no LDAP-specific encoding is defined for this syntax.
|
class |
CertificateSyntaxChecker
A SyntaxChecker which verifies that a value is a certificate according to RFC 4523 :
"Due to changes made to the definition of a Certificate through time,
no LDAP-specific encoding is defined for this syntax.
|
class |
ComparatorSyntaxChecker
A SyntaxChecker for the Comparator schema element
|
class |
CountrySyntaxChecker
A SyntaxChecker which verifies that a value is a country according to RFC 4517.
|
class |
CsnSidSyntaxChecker
An CSN SID syntax checker.
|
class |
CsnSyntaxChecker
An CSN syntax checker.
|
class |
DataQualitySyntaxSyntaxChecker
A SyntaxChecker which verifies that a value is a DataQualitySyntax.
|
class |
DeliveryMethodSyntaxChecker
A SyntaxChecker which verifies that a value is a delivery method
according to RFC 4517.
|
class |
DerefAliasSyntaxChecker
A SyntaxChecker which verifies that a value is a valid DerefAlias.
|
class |
DirectoryStringSyntaxChecker
A SyntaxChecker which verifies that a value is a Directory String according to RFC 4517.
|
class |
DitContentRuleDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
DIT content rule descripton syntax according to RFC 4512, par 4.2.6:
DITContentRuleDescription = LPAREN WSP
numericoid ; object identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
[ SP "AUX" SP oids ] ; auxiliary object classes
[ SP "MUST" SP oids ] ; attribute types
[ SP "MAY" SP oids ] ; attribute types
[ SP "NOT" SP oids ] ; attribute types
extensions WSP RPAREN ; extensions
|
class |
DitStructureRuleDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
DIT structure rule descripton syntax according to RFC 4512, par 4.2.7.1:
DITStructureRuleDescription = LPAREN WSP
ruleid ; rule identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
SP "FORM" SP oid ; NameForm
[ SP "SUP" ruleids ] ; superior rules
extensions WSP RPAREN ; extensions
ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
ruleidlist = ruleid *( SP ruleid )
ruleid = numbers
|
class |
DlSubmitPermissionSyntaxChecker
A SyntaxChecker which verifies that a value is a DLSubmitPermission.
|
class |
DnSyntaxChecker
A SyntaxChecker which verifies that a value is a valid
Dn. |
class |
DsaQualitySyntaxSyntaxChecker
A SyntaxChecker which verifies that a value is a DSAQualitySyntax according to
http://tools.ietf.org/id/draft-ietf-asid-ldapv3-attributes-03.txt, par 5.2.2.2 :
<DsaQualitySyntax> ::= <DSAKeyword> [ '#' <description> ]
<DSAKeyword> ::= 'DEFUNCT' | 'EXPERIMENTAL' | 'BEST-EFFORT' |
'PILOT-SERVICE' | 'FULL-SERVICE'
<description> ::= encoded as a PrintableString
|
class |
DseTypeSyntaxChecker
A SyntaxChecker which verifies that a value is a DSEType according to
http://tools.ietf.org/id/draft-ietf-asid-ldapv3-attributes-03.txt, par 6.2.1.5 :
<DSEType> ::= '(' <sp>* <DSEBit> <sp>* <DSEBitList> ')'
<DSEBitList> ::= '$' <sp>* <DSEBit> <sp>* <DSEBitList> | e
<DSEBit> ::= 'root' | 'glue' | 'cp' | 'entry' | 'alias' | 'subr' |
'nssr' | 'supr' | 'xr' | 'admPoint' | 'subentry' |
'shadow' | 'zombie' | 'immSupr' | 'rhob' | 'sa'
|
class |
EnhancedGuideSyntaxChecker
A SyntaxChecker which verifies that a value is an EnhancedGuide according to
RFC 4517.
|
class |
FacsimileTelephoneNumberSyntaxChecker
A SyntaxChecker which verifies that a value is a facsimile TelephoneNumber according
to ITU recommendation E.123 for the Telephone number part, and from RFC 4517, par.
3.3.11 :
fax-number = telephone-number *( DOLLAR fax-parameter )
telephone-number = PrintableString
fax-parameter = "twoDimensional" |
"fineResolution" |
"unlimitedLength" |
"b4Length" |
"a3Width" |
"b4Width" |
"uncompressed"
If needed, and to allow more syntaxes, a list of regexps has been added
which can be initialized to other values
|
class |
FaxSyntaxChecker
A SyntaxChecker which verifies that a value is a Fax according to RFC 4517.
|
class |
GeneralizedTimeSyntaxChecker
A SyntaxChecker which verifies that a value is a generalized time
according to RFC 4517.
|
class |
GuideSyntaxChecker
A SyntaxChecker which verifies that a value is a Guide according to RFC 4517.
|
class |
Ia5StringSyntaxChecker
A SyntaxChecker which verifies that a value is a IA5 String according to RFC 4517.
|
class |
IntegerSyntaxChecker
A SyntaxChecker which verifies that a value is an Integer according to RFC 4517.
|
class |
JavaByteSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Java primitive short or
the Short wrapper.
|
class |
JavaIntegerSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Java primitive int or
the Integer wrapper.
|
class |
JavaLongSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Java primitive long or
the Long wrapper.
|
class |
JavaShortSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Java primitive Short or
the Short wrapper.
|
class |
JpegSyntaxChecker
A SyntaxChecker which verifies that a value is a Jpeg according to RFC 4517.
|
class |
LdapSyntaxDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
LDAP syntax description syntax according to RFC 4512, par 4.2.2:
SyntaxDescription = LPAREN WSP
numericoid ; object identifier
[ SP "DESC" SP qdstring ] ; description
extensions WSP RPAREN ; extensions
|
class |
MailPreferenceSyntaxChecker
A SyntaxChecker which verifies that a value is a Boolean according to RFC 1778.
|
class |
MasterAndShadowAccessPointSyntaxChecker
A SyntaxChecker which verifies that a value is a
MasterAndShadowAccessPoint.
|
class |
MatchingRuleDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
matching rule description syntax according to RFC 4512, par 4.2.3:
MatchingRuleDescription = LPAREN WSP
numericoid ; object identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
SP "SYNTAX" SP numericoid ; assertion syntax
extensions WSP RPAREN ; extensions
extensions = *( SP xstring SP qdstrings )
xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
|
class |
MatchingRuleUseDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
matching rule use descripton syntax according to RFC 4512, par 4.2.4:
MatchingRuleUseDescription = LPAREN WSP
numericoid ; object identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
SP "APPLIES" SP oids ; attribute types
extensions WSP RPAREN ; extensions
|
class |
MhsOrAddressSyntaxChecker
A SyntaxChecker which verifies that a value is a
MHSORAddress.
|
class |
NameAndOptionalUIDSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Name and Optional UID.
|
class |
NameFormDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
name descripton syntax according to RFC 4512, par 4.2.7.2:
NameFormDescription = LPAREN WSP
numericoid ; object identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
SP "OC" SP oid ; structural object class
SP "MUST" SP oids ; attribute types
[ SP "MAY" SP oids ] ; attribute types
extensions WSP RPAREN ; extensions
|
class |
NisNetgroupTripleSyntaxChecker
A SyntaxChecker which verifies that a value is a NisNetGroupTriple according to
RFC 2307 :
nisnetgrouptriple = "(" hostname "," username "," domainname ")"
hostname = "" / "-" / keystring
username = "" / "-" / keystring
domainname = "" / "-" / keystring
|
class |
NormalizerSyntaxChecker
A SyntaxChecker for the Normalizer schema element
|
class |
NumberSyntaxChecker
A SyntaxChecker which verifies that a value is a Number according to RFC 4512.
|
class |
NumericOidSyntaxChecker
A SyntaxChecker which verifies that a value is a numeric oid
according to RFC 4512.
|
class |
NumericStringSyntaxChecker
A SyntaxChecker which verifies that a value is a Numeric String according to RFC 4517.
|
class |
ObjectClassDescriptionSyntaxChecker
A SyntaxChecker which verifies that a value follows the
object class descripton syntax according to RFC 4512, par 4.2.1:
ObjectClassDescription = LPAREN WSP
numericoid ; object identifier
[ SP "NAME" SP qdescrs ] ; short names (descriptors)
[ SP "DESC" SP qdstring ] ; description
[ SP "OBSOLETE" ] ; not active
[ SP "SUP" SP oids ] ; superior object classes
[ SP kind ] ; kind of class
[ SP "MUST" SP oids ] ; attribute types
[ SP "MAY" SP oids ] ; attribute types
extensions WSP RPAREN
kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
extensions = *( SP xstring SP qdstrings )
xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
|
class |
ObjectClassTypeSyntaxChecker
A syntax checker which checks to see if an objectClass' type is either:
AUXILIARY, STRUCTURAL, or ABSTRACT.
|
class |
ObjectNameSyntaxChecker
A SyntaxChecker which verifies that a name is valid for an ObjectClass
or an AttributeType
<m-name> = <keystring> <keystring> = <leadkeychar> *<keychar> <leadkeychar> = <ALPHA> <keychar> = <ALPHA> / <DIGIT> / <HYPHEN> / <SEMI> <ALPHA> = %x41-5A / %x61-7A ; "A"-"Z" / "a"-"z" <DIGIT> = %x30 / <LDIGIT ; "0"-"9" <LDIGIT> = %x31-39 ; "1"-"9" <HYPHEN> = %x2D ; hyphen ("-") <SEMI> = %x3B ; semicolon (";") |
class |
OctetStringSyntaxChecker
A SyntaxChecker which verifies that a value is a Octet String according to RFC 4517.
|
class |
OidLenSyntaxChecker
A SyntaxChecker which verifies that a value is a numeric oid and a length
constraint according to RFC 4512.
|
class |
OidSyntaxChecker
A SyntaxChecker which verifies that a value is an oid according to RFC 4512.
|
class |
OtherMailboxSyntaxChecker
A SyntaxChecker which verifies that a value is an OtherMailbox according to
RFC 4517 :
OtherMailbox = mailbox-type DOLLAR mailbox
mailbox-type = PrintableString
mailbox = IA5String
|
class |
PostalAddressSyntaxChecker
A SyntaxChecker which verifies that a value is a PostalAddress according to
RFC 4517 :
<postal-address> = <dstring> <dstring-list>
<dstring-list> = "$" <dstring> <dstring-list> | e
|
class |
PresentationAddressSyntaxChecker
A SyntaxChecker which verifies that a value is a PresentationAddressSyntax.
|
class |
PrintableStringSyntaxChecker
A SyntaxChecker which verifies that a value is a Printable String according to RFC 4517.
|
class |
ProtocolInformationSyntaxChecker
A SyntaxChecker which verifies that a value is a protocol information
according to RFC 2252.
|
class |
RegexSyntaxChecker
A SyntaxChecker implemented using Perl5 regular expressions to constrain
values.
|
class |
SearchScopeSyntaxChecker
A SyntaxChecker which verifies that a value is a valid Search Scope.
|
class |
SubstringAssertionSyntaxChecker
A SyntaxChecker which verifies that a value is a SubstringAssertion
according to RFC 4517.
|
class |
SubtreeSpecificationSyntaxChecker
A SyntaxChecker which verifies that a value is a subtree specification.
|
class |
SupplierAndConsumerSyntaxChecker
A SyntaxChecker which verifies that a value is a supplier and consumer according to RFC 2252.
|
class |
SupplierInformationSyntaxChecker
A SyntaxChecker which verifies that a value is a supplier information according to RFC 2252.
|
class |
SupplierOrConsumerSyntaxChecker
A SyntaxChecker which verifies that a value is a supplier or consummer according to RFC 2252.
|
class |
SupportedAlgorithmSyntaxChecker
A SyntaxChecker which verifies that a value is a SupportedAlgorithm according to RFC 2252.
|
class |
SyntaxCheckerSyntaxChecker
A SyntaxChecker for the SyntaxChecker schema element
|
class |
TelephoneNumberSyntaxChecker
A SyntaxChecker which verifies that a value is a TelephoneNumber according to ITU
recommendation E.123 (which is quite vague ...).
|
class |
TeletexTerminalIdentifierSyntaxChecker
A SyntaxChecker which verifies that a value is a TeletexTerminalIdentifier according to
RFC 4517 :
teletex-id = ttx-term *(DOLLAR ttx-param)
ttx-term = PrintableString ; terminal identifier
ttx-param = ttx-key COLON ttx-value ; parameter
ttx-key = "graphic" | "control" | "misc" | "page" | "private"
ttx-value = *ttx-value-octet
ttx-value-octet = %x00-23 | (%x5C "24") | %x25-5B | (%x5C "5C") | %x5D-FF
|
class |
TelexNumberSyntaxChecker
A SyntaxChecker which verifies that a value is a Telex Number according to
RFC 4517 :
telex-number = actual-number DOLLAR country-code DOLLAR answerback
actual-number = PrintableString
country-code = PrintableString
answerback = PrintableString
|
class |
UtcTimeSyntaxChecker
A SyntaxChecker which verifies that a value is a UTC time
according to RFC 4517.
|
class |
UuidSyntaxChecker
An UUID syntax checker.
|
Copyright © 2003–2022 The Apache Software Foundation. All rights reserved.