Package | Description |
---|---|
org.forgerock.opendj.ldap |
Classes and interfaces for core types including connections, entries, and
attributes.
|
org.forgerock.opendj.ldap.schema |
Classes and interfaces for constructing and querying LDAP schemas.
|
org.forgerock.opendj.ldap.spi |
Interfaces and classes for service providers.
|
org.forgerock.opendj.ldif |
Classes and interfaces for reading and writing LDIF.
|
Modifier and Type | Method and Description |
---|---|
Schema |
SchemaResolver.resolveSchema(String dn)
Finds the appropriate schema for use with the provided distinguished
name.
|
Modifier and Type | Method and Description |
---|---|
static AttributeDescription |
Functions.byteStringToAttributeDescription(ByteString value,
Schema schema)
Parses a
ByteString as an AttributeDescription using the provided schema. |
static Function<ByteString,Dn,org.forgerock.i18n.LocalizedIllegalArgumentException> |
Functions.byteStringToDn(Schema schema)
Returns a function which parses
DN s using the provided schema. |
Comparator<Entry> |
SortKey.comparator(Schema schema)
Returns a
Comparator which can be used to compare entries using
this sort key. |
static Comparator<Entry> |
SortKey.comparator(Schema schema,
Collection<SortKey> keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
static Comparator<Entry> |
SortKey.comparator(Schema schema,
SortKey... keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
static boolean |
Entries.conformsToSchema(Entry entry,
Schema schema,
SchemaValidationPolicy policy,
Collection<org.forgerock.i18n.LocalizableMessage> errorMessages)
Returns
true if the provided entry is valid according to the
specified schema and schema validation policy. |
static boolean |
Entries.containsObjectClass(Entry entry,
Schema schema,
ObjectClass objectClass)
Check if the provided entry contains the provided object class.
|
static Dn |
Dn.format(String template,
Schema schema,
Object... attributeValues)
Creates a new DN using the provided DN template and unescaped attribute
values using the provided schema.
|
static Set<ObjectClass> |
Entries.getObjectClasses(Entry entry,
Schema schema)
Returns an unmodifiable set containing the object classes associated with
the provided entry.
|
static ObjectClass |
Entries.getStructuralObjectClass(Entry entry,
Schema schema)
Returns the structural object class associated with the provided entry,
or
null if none was found. |
AttributeFilter |
AttributeFilter.includeAttribute(String attributeDescription,
Schema schema)
Specifies that the named attribute should be included in filtered
entries.
|
AttributeFilter |
AttributeFilter.includeAttribute(String attributeDescription,
Schema schema,
boolean includeAttributesFromSuperiors)
Specifies that the named attribute should be included in filtered
entries.
|
Matcher |
Filter.matcher(Schema schema)
Returns a
Matcher which can be used to compare this
Filter against entries using the provided Schema . |
DecodeOptions |
DecodeOptions.setSchema(Schema schema)
Sets the
Schema which will be used for decoding distinguished
names, attribute descriptions, and other objects which require a schema
in order to be decoded. |
AttributeParser |
AttributeParser.usingSchema(Schema schema)
Sets the
Schema which will be used when parsing schema sensitive
values such as DNs and attribute descriptions. |
static Rdn |
Rdn.valueOf(String rdn,
Schema schema)
Parses the provided LDAP string representation of a RDN using the
provided schema.
|
static LdapUrl |
LdapUrl.valueOf(String url,
Schema schema)
Parses the provided LDAP string representation of an LDAP URL using the
provided schema.
|
static Dn |
Dn.valueOf(String dn,
Schema schema)
Parses the provided LDAP string representation of a DN using the provided schema.
|
static Ava |
Ava.valueOf(String ava,
Schema schema)
Parses the provided LDAP string representation of an AVA using the
provided schema.
|
static AttributeDescription |
AttributeDescription.valueOf(String attributeDescription,
Schema schema)
Parses the provided LDAP string representation of an attribute
description using the provided schema.
|
Constructor and Description |
---|
AttributeFilter(Collection<String> attributeDescriptions,
Schema schema)
Creates a new attribute filter which will include the attributes
identified by the provided search request attribute list.
|
MemoryBackend(Schema schema)
Creates a new empty memory backend which will use the provided schema.
|
MemoryBackend(Schema schema,
EntryReader reader)
Creates a new memory backend which will use the provided schema, and will
contain the entries read from the provided entry reader.
|
Modifier and Type | Method and Description |
---|---|
Schema |
SchemaValidationPolicy.adaptSchemaForValidation(Schema schema)
Returns a strict view of the provided schema if the this policy is
configured to check attributes and object class, or a non-strict view of
the schema if not.
|
Schema |
Schema.asNonStrictSchema()
Returns a non-strict view of this schema.
|
Schema |
Schema.asStrictSchema()
Returns a strict view of this schema.
|
static Schema |
Schema.getCoreSchema()
Returns the core schema.
|
static Schema |
Schema.getDefaultSchema()
Returns the default schema which should be used by this application.
|
static Schema |
Schema.getEmptySchema()
Returns the empty schema.
|
static Schema |
CoreSchema.getInstance()
Returns a reference to the singleton core schema.
|
static Schema |
Schema.readSchema(Connection connection,
Dn name)
Reads the schema contained in the named subschema sub-entry.
|
static Schema |
Schema.readSchemaForEntry(Connection connection,
Dn name)
Reads the schema contained in the subschema sub-entry which applies to
the named entry.
|
Schema |
SchemaBuilder.toSchema()
Returns a strict
Schema containing all of the schema elements
contained in this schema builder as well as the same set of schema
compatibility options. |
static Schema |
Schema.valueOf(Entry entry)
Parses the provided entry as a subschema subentry.
|
Modifier and Type | Method and Description |
---|---|
static LdapPromise<Schema> |
Schema.readSchemaAsync(Connection connection,
Dn name)
Asynchronously reads the schema contained in the named subschema
sub-entry.
|
static LdapPromise<Schema> |
Schema.readSchemaForEntryAsync(Connection connection,
Dn name)
Asynchronously reads the schema contained in the subschema sub-entry
which applies to the named entry.
|
Modifier and Type | Method and Description |
---|---|
Schema |
SchemaValidationPolicy.adaptSchemaForValidation(Schema schema)
Returns a strict view of the provided schema if the this policy is
configured to check attributes and object class, or a non-strict view of
the schema if not.
|
SchemaBuilder |
SchemaBuilder.addSchema(Schema schema,
boolean overwrite)
Adds all of the schema elements in the provided schema to this schema
builder.
|
Assertion |
MatchingRuleImpl.getAssertion(Schema schema,
ByteSequence assertionValue)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing less than matching operations on
that value.
|
Assertion |
AbstractOrderingMatchingRuleImpl.getAssertion(Schema schema,
ByteSequence value) |
Assertion |
AbstractEqualityMatchingRuleImpl.getAssertion(Schema schema,
ByteSequence assertionValue) |
Assertion |
MatchingRuleImpl.getGreaterOrEqualAssertion(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing greater than or equal matching
operations on that value.
|
Assertion |
AbstractOrderingMatchingRuleImpl.getGreaterOrEqualAssertion(Schema schema,
ByteSequence value) |
Assertion |
MatchingRuleImpl.getLessOrEqualAssertion(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing less than or equal matching
operations on that value.
|
Assertion |
AbstractOrderingMatchingRuleImpl.getLessOrEqualAssertion(Schema schema,
ByteSequence value) |
Assertion |
MatchingRuleImpl.getSubstringAssertion(Schema schema,
ByteSequence subInitial,
List<? extends ByteSequence> subAnyElements,
ByteSequence subFinal)
Retrieves the normalized form of the provided assertion substring values,
which is best suited for efficiently performing matching operations on
that value.
|
ByteString |
MatchingRuleImpl.normalizeAttributeValue(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided attribute value, which is
best suited for efficiently performing matching operations on that value.
|
static void |
Schema.setDefaultSchema(Schema schema)
Sets the default schema which should be used by this application.
|
boolean |
SyntaxImpl.valueIsAcceptable(Schema schema,
ByteSequence value,
org.forgerock.i18n.LocalizableMessageBuilder invalidReason)
Indicates whether the provided value is acceptable for use in an
attribute with this syntax.
|
Constructor and Description |
---|
SchemaBuilder(Schema schema)
Creates a new schema builder containing all of the schema elements from
the provided schema and its compatibility options.
|
Modifier and Type | Method and Description |
---|---|
void |
Indexer.createKeys(Schema schema,
ByteSequence value,
Collection<ByteString> keys)
Generates the set of index keys for an attribute.
|
Modifier and Type | Method and Description |
---|---|
static EntryReader |
Ldif.search(EntryReader input,
SearchRequest search,
Schema schema)
Returns a filtered view of
input containing only those entries
which match the search base DN, scope, and filtered defined in
search . |
LdifEntryReader |
LdifEntryReader.setSchema(Schema schema)
Sets the schema which should be used for decoding entries that are read
from LDIF.
|
LdifChangeRecordReader |
LdifChangeRecordReader.setSchema(Schema schema)
Sets the schema which should be used for decoding change records that are
read from LDIF.
|
EntryGenerator |
EntryGenerator.setSchema(Schema schema)
Sets the schema which should be when generating entries.
|
Copyright 2011-2017 ForgeRock AS.