Uses of Class
org.forgerock.opendj.ldap.schema.Schema

Packages that use Schema

Package	Description
org.forgerock.opendj.io	Classes and interfaces providing I/O functionality.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls	Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.

Uses of Schema in org.forgerock.opendj.io

Methods in org.forgerock.opendj.io with parameters of type Schema

Modifier and Type	Method	Description
static Attribute	Ldap.readAttribute(Asn1Reader reader, DecodeOptions options, Schema schema)	Reads the next ASN.1 element from the provided ASN1Reader as an Attribute.
static Modification	Ldap.readModification(Asn1Reader reader, DecodeOptions options, Schema schema)	Reads the next ASN.1 element from the provided ASN1Reader as a Modification.
Dn	Asn1Reader.readName(byte type, Schema schema)	Reads the next element as a distinguished name having the provided type tag.
Dn	Asn1Reader.readName(Schema schema)	Reads the next element as a distinguished name having the Universal Sequence ASN.1 type tag.

Uses of Schema in org.forgerock.opendj.ldap

Methods in org.forgerock.opendj.ldap that return Schema

Modifier and Type	Method	Description
Schema	MemoryBackend.getSchema()	Returns the schema used by this backend.
Schema	SchemaResolver.resolveSchema(String dn)	Finds the appropriate schema for use with the provided distinguished name.

Methods in org.forgerock.opendj.ldap with parameters of type Schema

Modifier and Type	Method	Description
static AttributeDescription	Functions.byteStringToAttributeDescription(ByteString value, Schema schema)	Parses a ByteString as an AttributeDescription using the provided schema.
static Function<ByteString,Dn,LocalizedIllegalArgumentException>	Functions.byteStringToDn(Schema schema)	Returns a function which parses DNs using the provided schema.
SortKey.SortComparator	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, SchemaValidationPolicy policy, Collection<LocalizableMessage> errorMessages, Schema schema)	Returns true if the provided entry is valid according to the specified schema and schema validation policy.
static boolean	Entries.containsObjectClass(Entry entry, ObjectClass objectClass, Schema schema)	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.
boolean	SubtreeSpecification.isWithinScope(Entry entry, Schema schema)	Determine if an entry is within the scope of the subtree specification.
Matcher	Filter.matcher(Schema schema)	Returns a Matcher which can be used to compare this Filter against entries using the provided Schema.
boolean	SubtreeSpecification.FilterRefinement.matches(Entry entry, Schema schema)
abstract boolean	SubtreeSpecification.Refinement.matches(Entry entry, Schema schema)	Check if the refinement matches the given entry.
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 AttributeDescription	AttributeDescription.valueOf(String attributeDescription, Schema schema)	Parses the provided LDAP string representation of an attribute description 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 Dn	Dn.valueOf(String dn, Schema schema)	Parses the provided LDAP string representation of a DN 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 Rdn	Rdn.valueOf(String rdn, Schema schema)	Parses the provided LDAP string representation of a RDN using the provided schema.

Constructors in org.forgerock.opendj.ldap with parameters of type Schema

Modifier	Constructor	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.

Uses of Schema in org.forgerock.opendj.ldap.controls

Methods in org.forgerock.opendj.ldap.controls with parameters of type Schema

Modifier and Type	Method	Description
AttributeFilter	MatchedValuesRequestControl.keepMatchedValues(AttributeFilter filter, Schema schema)	Register a mapping function in the provided AttributeFilter which will only retain attribute values matching at least one filter defined in this control.
Function<Attribute,Attribute>	MatchedValuesRequestControl.keepMatchedValues(Schema schema)	Returns a mapping function which, given an attribute, returns a new attribute containing only the values matching the filters defined in this control, or an empty attribute if none of the values match.

Uses of Schema in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that return Schema

Modifier and Type	Method	Description
Schema	SchemaValidationPolicy.adaptSchemaForValidation(Schema schema)	Returns a strict view of the provided schema if 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.

Methods in org.forgerock.opendj.ldap.schema that return types with arguments of type Schema

Modifier and Type	Method	Description
static io.reactivex.rxjava3.core.Single<Schema>	Schema.readSchema(LdapClientSocket socket, Dn name)	Reads the schema contained in the named subschema sub-entry.
static LdapPromise<Schema>	Schema.readSchemaAsync(Connection connection, Dn name)	Asynchronously reads the schema contained in the named subschema sub-entry.
static io.reactivex.rxjava3.core.Single<Schema>	Schema.readSchemaForEntry(LdapClientSocket socket, Dn name)	Reads the schema contained in the subschema sub-entry which applies to the named 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.

Methods in org.forgerock.opendj.ldap.schema with parameters of type Schema

Modifier and Type	Method	Description
Schema	SchemaValidationPolicy.adaptSchemaForValidation(Schema schema)	Returns a strict view of the provided schema if 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.
final Collection<? extends Indexer>	AbstractOrderingMatchingRuleImpl.createIndexers(Schema schema, IndexingOptions options)
Collection<? extends Indexer>	MatchingRuleImpl.createIndexers(Schema schema, IndexingOptions options)	Returns the indexers for this matching rule.
default ByteString	SyntaxImpl.fromJson(Schema schema, Object value)	Decodes the JSON representation of an attribute value with this syntax.
final Assertion	AbstractOrderingMatchingRuleImpl.getAssertion(Schema schema, ByteString value)
Assertion	MatchingRuleImpl.getAssertion(Schema schema, ByteString assertionValue)	Compiles the provided assertion value as an Assertion suitable for use with equalityMatch, approxMatch and extensibleMatch search filters.
Assertion	AbstractOrderingMatchingRuleImpl.getOrderingAssertion(Schema schema, ByteString lower, ByteString upper, boolean lowerIncluded, boolean upperIncluded)
default Assertion	MatchingRuleImpl.getOrderingAssertion(Schema schema, ByteString lower, ByteString upper, boolean lowerIncluded, boolean upperIncluded)	Compiles the provided ordering assertion value range as an Assertion suitable for use with ordering search filters, including greaterOrEqual and lessOrEqual.
default Assertion	MatchingRuleImpl.getSubstringAssertion(Schema schema, ByteString subInitial, List<ByteString> subAnyElements, ByteString subFinal)	Compiles the provided substring assertion fragments as an Assertion suitable for use with substrings search filters.
ByteString	MatchingRuleImpl.normalizeAttributeValue(Schema schema, ByteString 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.
default Object	SyntaxImpl.toJson(Schema schema, ByteString value)	Encodes the JSON representation of an attribute value with this syntax.
default Map<String,Object>	SyntaxImpl.toJsonSchema(Schema schema)	Returns the JSON schema describing this syntax.
boolean	SyntaxImpl.valueIsAcceptable(Schema schema, ByteString value, LocalizableMessageBuilder invalidReason)	Indicates whether the provided value is acceptable for use in an attribute with this syntax.

Constructors in org.forgerock.opendj.ldap.schema with parameters of type Schema

Modifier	Constructor	Description
	SchemaBuilder(Schema schema)	Creates a new schema builder containing all of the schema elements from the provided schema and its compatibility options.

Uses of Schema in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif with parameters of type Schema

Modifier and Type	Method	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.
EntryGenerator	EntryGenerator.setSchema(Schema schema)	Sets the schema which should be when generating entries.
LdifChangeRecordReader	LdifChangeRecordReader.setSchema(Schema schema)	Sets the schema which should be used for decoding change records that are read from LDIF.
LdifEntryReader	LdifEntryReader.setSchema(Schema schema)	Sets the schema which should be used for decoding entries that are read from LDIF.