| Package | Description |
|---|---|
| org.apache.directory.api.ldap.model.entry | |
| org.apache.directory.api.ldap.model.filter | |
| org.apache.directory.api.ldap.model.ldif | |
| org.apache.directory.api.ldap.model.ldif.anonymizer | |
| org.apache.directory.api.ldap.model.message | |
| org.apache.directory.api.ldap.model.name | |
| 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.comparators | |
| org.apache.directory.api.ldap.model.schema.normalizers | |
| org.apache.directory.api.ldap.model.schema.syntaxCheckers | |
| org.apache.directory.api.ldap.model.subtree |
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
DefaultEntry.schemaManager
The SchemaManager
|
| Modifier and Type | Method and Description |
|---|---|
private Entry |
DefaultEntry.createEntry(SchemaManager schemaManager,
Object... elements) |
| Constructor and Description |
|---|
DefaultEntry(SchemaManager schemaManager)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
Dn dn)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
Dn dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
DefaultEntry(SchemaManager schemaManager,
Entry entry)
Creates a new instance of DefaultEntry, copying
another entry.
|
DefaultEntry(SchemaManager schemaManager,
String dn)
Creates a new instance of DefaultEntry, schema aware.
|
DefaultEntry(SchemaManager schemaManager,
String dn,
Object... elements)
Creates a new instance of DefaultEntry, with a
Dn and a list of IDs.
|
DefaultModification(SchemaManager schemaManager,
Modification modification)
Creates a new instance of DefaultModification.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
BranchNormalizedVisitor.getNormalizedFilter(SchemaManager schemaManager,
String filter)
Normalizes a filter expression to a canonical representation while
retaining logical meaning of the expression.
|
static ExprNode |
FilterParser.parse(SchemaManager schemaManager,
byte[] filter) |
private static ExprNode |
FilterParser.parse(SchemaManager schemaManager,
byte[] filter,
boolean relaxed) |
static ExprNode |
FilterParser.parse(SchemaManager schemaManager,
String filter) |
static ExprNode |
FilterParser.parse(SchemaManager schemaManager,
String filter,
org.apache.directory.api.util.Position pos) |
private static Value<?> |
FilterParser.parseAssertionValue(SchemaManager schemaManager,
byte[] filter,
org.apache.directory.api.util.Position pos)
An assertion value :
assertionvalue = valueencoding
valueencoding = 0*(normal / escaped)
normal = UTF1SUBSET / UTFMB
escaped = '\' HEX HEX
HEX = '0'-'9' / 'A'-'F' / 'a'-'f'
UTF1SUBSET = %x01-27 / %x2B-5B / %x5D-7F (Everything but '\0', '*', '(', ')' and '\')
UTFMB = UTF2 / UTF3 / UTF4
UTF0 = %x80-BF
UTF2 = %xC2-DF UTF0
UTF3 = %xE0 %xA0-BF UTF0 / %xE1-EC UTF0 UTF0 / %xED %x80-9F UTF0 / %xEE-EF UTF0 UTF0
UTF4 = %xF0 %x90-BF UTF0 UTF0 / %xF1-F3 UTF0 UTF0 UTF0 / %xF4 %x80-8F UTF0 UTF0
With the specific constraints (RFC 4515):
"The
|
private static Value<?> |
FilterParser.parseAssertionValue(SchemaManager schemaManager,
String attribute,
byte[] filter,
org.apache.directory.api.util.Position pos)
An assertion value :
assertionvalue = valueencoding
valueencoding = 0*(normal / escaped)
normal = UTF1SUBSET / UTFMB
escaped = '\' HEX HEX
HEX = '0'-'9' / 'A'-'F' / 'a'-'f'
UTF1SUBSET = %x01-27 / %x2B-5B / %x5D-7F (Everything but '\0', '*', '(', ')' and '\')
UTFMB = UTF2 / UTF3 / UTF4
UTF0 = %x80-BF
UTF2 = %xC2-DF UTF0
UTF3 = %xE0 %xA0-BF UTF0 / %xE1-EC UTF0 UTF0 / %xED %x80-9F UTF0 / %xEE-EF UTF0 UTF0
UTF4 = %xF0 %x90-BF UTF0 UTF0 / %xF1-F3 UTF0 UTF0 UTF0 / %xF4 %x80-8F UTF0 UTF0
With the specific constraints (RFC 4515):
"The
|
private static ExprNode |
FilterParser.parseBranchNode(SchemaManager schemaManager,
ExprNode node,
byte[] filter,
org.apache.directory.api.util.Position pos,
boolean relaxed)
Parse AND, OR and NOT nodes :
and = '&' filterlist
or = '|' filterlist
not = '!' filter
filterlist = 1*filter
|
private static ExprNode |
FilterParser.parseExtensible(SchemaManager schemaManager,
String attribute,
byte[] filter,
org.apache.directory.api.util.Position pos,
boolean relaxed)
Parse an extensible
extensible = ( attr [":dn"] [':' oid] ":=" assertionvalue )
/ ( [":dn"] ':' oid ":=" assertionvalue )
matchingrule = ":" oid
|
private static ExprNode |
FilterParser.parseFilterComp(SchemaManager schemaManager,
byte[] filter,
org.apache.directory.api.util.Position pos,
boolean relaxed)
filtercomp = and / or / not / item
and = '&' WSP* filterlist
or = '|' WSP* filterlist
not = '!' WSP* filter
item = simple / present / substring / extensible
simple = attr WSP* filtertype WSP* assertionvalue
present = attr WSP* EQUALS ASTERISK
substring = attr WSP* EQUALS WSP* [initial] any [final]
extensible = ( attr [dnattrs]
[matchingrule] COLON EQUALS assertionvalue )
/ ( [dnattrs]
matchingrule COLON EQUALS assertionvalue )
|
private static ExprNode |
FilterParser.parseFilterInternal(SchemaManager schemaManager,
byte[] filter,
org.apache.directory.api.util.Position pos,
boolean relaxed)
Parse the grammar rule :
filter ::= WSP* '(' WSP* filterComp WSP* ')' WSP*
|
private static ExprNode |
FilterParser.parseItem(SchemaManager schemaManager,
byte[] filter,
org.apache.directory.api.util.Position pos,
byte b,
boolean relaxed)
Parse the following grammar :
item = simple / present / substring / extensible
simple = attr WSP* filtertype assertionvalue
filtertype = '=' / '~=' / '>=' / '<='
present = attr WSP* '=' '*'
substring = attr WSP* '=' [initial] any [final]
extensible = ( attr [":dn"] [':' oid] ":=" assertionvalue )
/ ( [":dn"] ':' oid ":=" assertionvalue )
matchingrule = ":" oid
An item starts with an attribute or a colon.
|
private static ExprNode |
FilterParser.parsePresenceEqOrSubstring(SchemaManager schemaManager,
String attribute,
byte[] filter,
org.apache.directory.api.util.Position pos)
Here is the grammar to parse :
simple ::= '=' assertionValue
present ::= '=' '*'
substring ::= '=' [initial] any [final]
initial ::= assertionValue
any ::= '*' ( assertionValue '*')*
As we can see, there is an ambiguity in the grammar : attr=* can be
seen as a present or as a substring.
|
private static ExprNode |
FilterParser.parseSubstring(SchemaManager schemaManager,
String attribute,
Value<?> initial,
byte[] filter,
org.apache.directory.api.util.Position pos)
Parse a substring
|
| Modifier and Type | Field and Description |
|---|---|
protected SchemaManager |
LdifReader.schemaManager
The SchemaManager instance, if any
|
| Modifier and Type | Method and Description |
|---|---|
protected LdifEntry |
LdifReader.createLdifEntry(SchemaManager schemaManager)
Creates a schema aware LdifEntry
|
private Entry |
LdifAttributesReader.parseEntry(SchemaManager schemaManager)
Parse a ldif file.
|
Entry |
LdifAttributesReader.parseEntry(SchemaManager schemaManager,
String ldif)
A method which parses a ldif string and returns an Entry.
|
private void |
LdifAttributesReader.parseEntryAttribute(SchemaManager schemaManager,
Entry entry,
String line,
String lowerLine)
Parse an AttributeType/AttributeValue
|
void |
LdifReader.setSchemaManager(SchemaManager schemaManager) |
| Constructor and Description |
|---|
LdifEntry(SchemaManager schemaManager)
Creates a new schema aware LdifEntry object.
|
LdifReader(File file,
SchemaManager schemaManager)
A constructor which takes a File and a SchemaManager.
|
LdifReader(SchemaManager schemaManager)
Creates a Schema aware reader
|
| Modifier and Type | Field and Description |
|---|---|
protected SchemaManager |
AbstractAnonymizer.schemaManager
The SchemaManager instance
|
| Modifier and Type | Method and Description |
|---|---|
void |
Anonymizer.setSchemaManager(SchemaManager schemaManager)
Inject a SchemaManager instance in this Anonymizer
|
void |
AbstractAnonymizer.setSchemaManager(SchemaManager schemaManager)
Inject a SchemaManager instance in this Anonymizer
|
| Modifier and Type | Method and Description |
|---|---|
void |
SearchParams.normalize(SchemaManager schemaManager)
Normalize the ReturningAttributes.
|
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
Rdn.schemaManager
the schema manager
|
private SchemaManager |
Dn.schemaManager
the schema manager
|
private SchemaManager |
Ava.schemaManager
the schema manager
|
| Modifier and Type | Method and Description |
|---|---|
SchemaManager |
Dn.getSchemaManager()
Get the associated SchemaManager if any.
|
| Modifier and Type | Method and Description |
|---|---|
(package private) void |
Rdn.addAVA(SchemaManager schemaManager,
Ava value)
Add an Ava to the current schema aware Rdn
|
private void |
Rdn.addAVA(SchemaManager schemaManager,
String upType,
String type,
Value<?> value)
Add an Ava to the current Rdn
|
Rdn |
Rdn.apply(SchemaManager schemaManager)
Transform a Rdn by changing the value to its OID counterpart and
normalizing the value accordingly to its type.
|
Dn |
Dn.apply(SchemaManager schemaManager)
Normalizes the Dn using the given the schema manager, unless the Dn is already normalized
|
void |
Ava.apply(SchemaManager schemaManager)
Apply a SchemaManager to the Ava.
|
Dn |
Dn.apply(SchemaManager schemaManager,
boolean force)
Normalizes the Dn using the given the schema manager.
|
private static Ava |
Dn.atavOidToName(Ava atav,
SchemaManager schemaManager)
Normalize the Ava
|
private void |
Ava.createAva(SchemaManager schemaManager,
String upType,
Value<?> value)
Construct a schema aware Ava.
|
(package private) static void |
Dn.rdnOidToName(Rdn rdn,
SchemaManager schemaManager)
No qualifier
|
| Constructor and Description |
|---|
Ava(SchemaManager schemaManager)
Constructs an empty schema aware Ava.
|
Ava(SchemaManager schemaManager,
String upType,
byte[] upValue)
Construct a schema aware Ava containing a binary value.
|
Ava(SchemaManager schemaManager,
String upType,
String upValue)
Construct a schema aware Ava with a String value.
|
Ava(SchemaManager schemaManager,
String upType,
String normType,
Value<?> value)
Construct an Ava.
|
Dn(SchemaManager schemaManager)
Construct an empty Schema aware Dn object
|
Dn(SchemaManager schemaManager,
Rdn... rdns)
Creates a Schema aware Dn from a list of Rdns.
|
Dn(SchemaManager schemaManager,
String... upRdns)
Creates a new instance of schema aware Dn, using varargs to declare the RDNs.
|
Dn(SchemaManager schemaManager,
String upName,
String normName,
Rdn... rdns)
Create a schema aware Dn while deserializing it.
|
Rdn(SchemaManager schemaManager)
Creates a new schema aware instance of Rdn.
|
Rdn(SchemaManager schemaManager,
Ava... avas)
A constructor that constructs a Schema aware Rdn from some values.
|
Rdn(SchemaManager schemaManager,
String rdn)
A constructor that parse a String representing a schema aware Rdn.
|
Rdn(SchemaManager schemaManager,
String upType,
String upValue)
A constructor that constructs a schema aware Rdn from a type and a value.
|
| Modifier and Type | Method and Description |
|---|---|
Entry |
AttributesFactory.convert(AttributeType attributeType,
Schema schema,
SchemaManager schemaManager)
objectclass ( 1.3.6.1.4.1.18060.0.4.0.3.3
NAME 'metaAttributeType'
DESC 'meta definition of the AttributeType object'
SUP metaTop
STRUCTURAL
MUST ( m-name $ m-syntax )
MAY ( m-supAttributeType $ m-obsolete $ m-equality $ m-ordering $
m-substr $ m-singleValue $ m-collective $ m-noUserModification $
m-usage $ m-extensionAttributeType )
)
|
Entry |
AttributesFactory.convert(DitContentRule dITContentRule,
Schema schema,
SchemaManager schemaManager)
Converts a DitContentRule into an Entry
|
Entry |
AttributesFactory.convert(DitStructureRule ditStructureRule,
Schema schema,
SchemaManager schemaManager)
Converts a DitStructureRule into an Entry
|
Entry |
AttributesFactory.convert(LdapSyntax syntax,
Schema schema,
SchemaManager schemaManager)
Convert a Syntax instance into an Entry
|
Entry |
AttributesFactory.convert(MatchingRule matchingRule,
Schema schema,
SchemaManager schemaManager)
Converts a MatchingRule into an Entry
|
Entry |
AttributesFactory.convert(MatchingRuleUse matchingRuleUse,
Schema schema,
SchemaManager schemaManager)
Converts a MatchingRuleUse into an Entry
|
Entry |
AttributesFactory.convert(NameForm nameForm,
Schema schema,
SchemaManager schemaManager)
Converts a NameForm into an Entry
|
Entry |
AttributesFactory.convert(ObjectClass objectClass,
Schema schema,
SchemaManager schemaManager)
Creates the attributes of an entry representing an objectClass.
|
Entry |
AttributesFactory.convert(Schema schema,
SchemaManager schemaManager)
Converts a Schema to an Entry
|
Entry |
AttributesFactory.convert(String oid,
LdapComparator<? super Object> comparator,
Schema schema,
SchemaManager schemaManager)
Convert a LdapComparator instance into an Entry
|
Entry |
AttributesFactory.convert(String oid,
Normalizer normalizer,
Schema schema,
SchemaManager schemaManager)
Convert a Normalizer instance into an Entry
|
Entry |
AttributesFactory.convert(SyntaxChecker syntaxChecker,
Schema schema,
SchemaManager schemaManager)
Convert a SyntaxChecker instance into an Entry
|
Entry |
AttributesFactory.getAttributes(SchemaObject obj,
Schema schema,
SchemaManager schemaManager)
Get a SchemaObject as an Entry
|
private void |
AttributesFactory.injectCommon(SchemaObject object,
Entry entry,
SchemaManager schemaManager) |
private void |
AttributesFactory.injectNames(List<String> names,
Entry entry,
SchemaManager schemaManager) |
void |
SyntaxChecker.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
Normalizer.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
LdapComparator.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
UniqueMemberComparator.schemaManager
A reference to the schema manager
|
private SchemaManager |
SerializableComparator.schemaManager
A reference to the schema manager
|
private SchemaManager |
DnComparator.schemaManager
A reference to the schema manager
|
| Modifier and Type | Method and Description |
|---|---|
void |
UniqueMemberComparator.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
SerializableComparator.setSchemaManager(SchemaManager schemaManager) |
void |
DnComparator.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
UniqueMemberNormalizer.schemaManager
A reference to the schema manager used to normalize the Dn
|
private SchemaManager |
NameOrNumericIdNormalizer.schemaManager
A reference to the schema manager used to normalize the Name
|
private SchemaManager |
DnNormalizer.schemaManager
A reference to the schema manager used to normalize the Dn
|
private SchemaManager |
ConcreteNameComponentNormalizer.schemaManager
the schemaManager used to dynamically resolve Normalizers
|
| Modifier and Type | Method and Description |
|---|---|
void |
UniqueMemberNormalizer.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
NameOrNumericIdNormalizer.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
DnNormalizer.setSchemaManager(SchemaManager schemaManager)
Store the SchemaManager in this instance.
|
void |
CachingNormalizer.setSchemaManager(SchemaManager schemaManager)
Sets the SchemaManager
|
void |
CachingDnNormalizer.setSchemaManager(SchemaManager schemaManager)
Sets the SchemaManager
|
| Constructor and Description |
|---|
ConcreteNameComponentNormalizer(SchemaManager schemaManager)
Creates a Dn Name component Normalizer which uses the bootstrap
registries to find the appropriate normalizer for the attribute of the
name component with which to normalize the name component value.
|
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
SubtreeSpecificationSyntaxChecker.Builder.schemaManager
The schemaManager
|
| Modifier and Type | Method and Description |
|---|---|
SubtreeSpecificationSyntaxChecker.Builder |
SubtreeSpecificationSyntaxChecker.Builder.setSchemaManager(SchemaManager schemaManager) |
| Constructor and Description |
|---|
SubtreeSpecificationSyntaxChecker(String oid,
SchemaManager schemaManager)
Creates an instance of SubtreeSpecificationSyntaxChecker
|
| Modifier and Type | Field and Description |
|---|---|
private SchemaManager |
AntlrSubtreeSpecificationParser.schemaManager
The schemaManager
|
private SchemaManager |
AntlrSubtreeSpecificationChecker.schemaManager
The SchemaManager
|
| Modifier and Type | Method and Description |
|---|---|
void |
AntlrSubtreeSpecificationParser.init(SchemaManager schemaManager)
Does nothing.
|
void |
AntlrSubtreeSpecificationChecker.init(SchemaManager schemaManager)
Initiaize the checker
|
| Constructor and Description |
|---|
SubtreeSpecificationChecker(SchemaManager schemaManager)
Creates a normalizing subtree specification parser.
|
SubtreeSpecificationParser(NormalizerMappingResolver resolver,
SchemaManager schemaManager)
Creates a normalizing subtree specification parser.
|
SubtreeSpecificationParser(SchemaManager schemaManager)
Creates a subtree specification parser.
|
Copyright © 2003–2017 The Apache Software Foundation. All rights reserved.