@PublicAPI(stability=PRIVATE)

Package org.opends.server.schema

Contains implementations of various Directory Server schema elements.

See: Description

Interface Summary

Interface	Description
SchemaProvider<T extends org.forgerock.opendj.server.config.server.SchemaProviderCfg>	Provides some schema elements to load at startup.
SchemaUpdater	An interface to update a schema through a schema builder.

Class Summary

Class	Description
AciSyntax	This class implements the access control information (aci) attribute syntax.
AttributeTypeSyntax	This class defines the attribute type description syntax, which is used to hold attribute type definitions in the server schema.
AuthPasswordEqualityMatchingRuleFactory	This class is a factory class for AuthPasswordEqualityMatchingRule.
AuthPasswordExactEqualityMatchingRuleFactory	This class is a factory class for AuthPasswordExactEqualityMatchingRule.
AuthPasswordSyntax	This class defines the auth password attribute syntax, which is defined in RFC 3112 and is used to hold authentication information.
BinarySyntax	This class defines the binary attribute syntax, which is essentially a byte array using very strict matching.
BitStringEqualityMatchingRuleFactory	This class is a factory class for BitStringEqualityMatchingRule.
BitStringSyntax	This class defines the bit string attribute syntax, which is comprised of a string of binary digits surrounded by single quotes and followed by a capital letter "B" (e.g., '101001'B).
BooleanEqualityMatchingRuleFactory	This class is a factory class for BooleanEqualityMatchingRule.
BooleanSyntax	This class defines the Boolean attribute syntax, which only allows values of "TRUE" or "FALSE" (although this implementation is more flexible and will also allow "YES", "ON", or "1" instead of "TRUE", or "NO", "OFF", or "0" instead of "FALSE").
CaseExactEqualityMatchingRuleFactory	This class is a factory class for CaseExactEqualityMatchingRule.
CaseExactIA5EqualityMatchingRuleFactory	This class is a factory class for CaseExactIA5EqualityMatchingRule.
CaseExactIA5SubstringMatchingRuleFactory	This class is a factory class for CaseExactIA5SubstringMatchingRule.
CaseExactOrderingMatchingRuleFactory	This class is a factory class for CaseExactOrderingMatchingRule.
CaseExactSubstringMatchingRuleFactory	This class is a factory class for CaseExactSubstringMatchingRule.
CaseIgnoreEqualityMatchingRuleFactory	This class is a factory class for CaseIgnoreEqualityMatchingRule.
CaseIgnoreIA5EqualityMatchingRuleFactory	This class is a factory class for CaseIgnoreIA5EqualityMatchingRule.
CaseIgnoreIA5SubstringMatchingRuleFactory	This class is a factory class for CaseIgnoreIA5SubstringMatchingRule.
CaseIgnoreListEqualityMatchingRuleFactory	This class is a factory class for CaseIgnoreListEqualityMatchingRule.
CaseIgnoreListSubstringMatchingRuleFactory	This class is a factory class for CaseIgnoreSubstringMatchingRule.
CaseIgnoreOrderingMatchingRuleFactory	This class is a factory class for CaseIgnoreOrderingMatchingRule.
CaseIgnoreSubstringMatchingRuleFactory	This class is a factory class for CaseIgnoreSubstringMatchingRule.
CertificateExactAssertionSyntax	This class defines the Certificate Exact Assertion attribute syntax, which contains components for matching X.509 certificates.
CertificateExactMatchingRuleFactory	This class is a factory class for CertificateExactMatchingRule.
CertificateListSyntax	This class implements the certificate list attribute syntax.
CertificatePairSyntax	This class implements the certificate pair attribute syntax.
CertificateSyntax	This class implements the certificate attribute syntax.
CollationMatchingRuleFactory	This class is a factory class for Collation matching rules.
CoreSchemaProvider	Provides the core schema, which includes core matching rules and syntaxes.
CountryStringSyntax	This class defines the country string attribute syntax, which should be a two-character ISO 3166 country code.
DeliveryMethodSyntax	This class defines the delivery method attribute syntax.
DirectoryStringFirstComponentEqualityMatchingRuleFactory	This class is a factory class for DirectoryStringFirstComponentEqualityMatchingRule.
DirectoryStringSyntax	This class defines the directory string attribute syntax, which is simply a set of UTF-8 characters.
DistinguishedNameEqualityMatchingRuleFactory	This class is a factory class for DistinguishedNameEqualityMatchingRule.
DistinguishedNameSyntax	This class defines the distinguished name attribute syntax, which is used for attributes that hold distinguished names (DNs).
DITContentRuleSyntax	This class implements the DIT content rule description syntax, which is used to hold DIT content rule definitions in the server schema.
DITStructureRuleSyntax	This class implements the DIT structure rule description syntax, which is used to hold DIT structure rule definitions in the server schema.
DoubleMetaphoneApproximateMatchingRuleFactory	This class is a factory class for DoubleMetaphoneApproximateMatchingRule.
EnhancedGuideSyntax	This class implements the enhanced guide attribute syntax, which may be used to provide criteria for generating search filters for entries of a given objectclass.
FaxNumberSyntax	This class implements the facsimile telephone number attribute syntax, which contains a printable string (the number) followed by zero or more parameters.
FaxSyntax	This class implements the fax attribute syntax.
GeneralizedTimeEqualityMatchingRuleFactory	This class is a factory class for GeneralizedTimeEqualityMatchingRule.
GeneralizedTimeOrderingMatchingRuleFactory	This class is a factory class for GeneralizedTimeOrderingMatchingRule.
GeneralizedTimeSyntax	This class defines the generalized time attribute syntax, which is a way of representing time in a form like "YYYYMMDDhhmmssZ".
GuideSyntax	This class implements the guide attribute syntax, which may be used to provide criteria for generating search filters for entries, optionally tied to a specified objectclass.
IA5StringSyntax	This class implements the IA5 string attribute syntax, which is simply a set of ASCII characters.
IntegerEqualityMatchingRuleFactory	This class is a factory class for IntegerEqualityMatchingRule.
IntegerFirstComponentEqualityMatchingRuleFactory	This class is a factory class for IntegerFirstComponentEqualityMatchingRule.
IntegerOrderingMatchingRuleFactory	This class is a factory class for IntegerOrderingMatchingRule.
IntegerSyntax	This class defines the integer attribute syntax, which holds an arbitrarily-long integer value.
JPEGSyntax	This class implements the JPEG attribute syntax.
KeywordEqualityMatchingRuleFactory	This class is a factory class for KeywordEqualityMatchingRule.
LDAPSyntaxDescriptionSyntax	This class defines the LDAP syntax description syntax, which is used to hold attribute syntax definitions in the server schema.
MatchingRuleSyntax	This class implements the matching rule description syntax, which is used to hold matching rule definitions in the server schema.
MatchingRuleUseSyntax	This class implements the matching rule use description syntax, which is used to hold matching rule use definitions in the server schema.
NameAndOptionalUIDSyntax	This class implements the name and optional UID attribute syntax, which holds values consisting of a DN, optionally followed by an octothorpe (#) and a bit string value.
NameFormSyntax	This class implements the name form description syntax, which is used to hold name form definitions in the server schema.
NumericStringEqualityMatchingRuleFactory	This class is a factory class for NumericStringEqualityMatchingRule.
NumericStringOrderingMatchingRuleFactory	This class is a factory class for NumericStringOrderingMatchingRule.
NumericStringSubstringMatchingRuleFactory	This class is a factory class for NumericStringSubstringMatchingRule.
NumericStringSyntax	This class implements the numeric string attribute syntax, which may be hold one or more numeric digits and/or spaces.
ObjectClassSyntax	This class implements the object class description syntax, which is used to hold objectclass definitions in the server schema.
ObjectIdentifierEqualityMatchingRuleFactory	This class is a factory class for ObjectIdentifierEqualityMatchingRule.
ObjectIdentifierFirstComponentEqualityMatchingRuleFactory	This class is a factory class for ObjectIdentifierFirstComponentEqualityMatchingRule.
OctetStringEqualityMatchingRuleFactory	This class is a factory class for OctetStringEqualityMatchingRule.
OctetStringOrderingMatchingRuleFactory	This class is a factory class for OctetStringOrderingMatchingRule.
OctetStringSubstringMatchingRuleFactory	This class is a factory class for OctetStringSubstringMatchingRule.
OctetStringSyntax	This class implements the octet string attribute syntax, which is equivalent to the binary syntax and should be considered a replacement for it.
OIDSyntax	This class defines the OID syntax, which holds either an identifier name or a numeric OID.
OtherMailboxSyntax	This class implements the other mailbox attribute syntax, which consists of a printable string component (the mailbox type) followed by a dollar sign and an IA5 string component (the mailbox).
PostalAddressSyntax	This class implements the postal address attribute syntax, which is a list of UCS (Universal Character Set, as defined in the ISO 10646 specification and includes UTF-8 and UTF-16) strings separated by dollar signs.
PresentationAddressEqualityMatchingRuleFactory	This class is a factory class for PresentationAddressEqualityMatchingRule.
PresentationAddressSyntax	This class implements the presentation address attribute syntax, which is defined in RFC 1278.
PrintableString	This class defines utility methods that can be used to determine whether a character string is printable as defined in X.520 and referenced in RFC 2252.
PrintableStringSyntax	This class implements the printable string attribute syntax, which is simply a string of characters from a limited ASCII character set (uppercase and lowercase letters, numeric digits, the space, and a set of various symbols).
ProtocolInformationEqualityMatchingRuleFactory	This class is a factory class for ProtocolInformationEqualityMatchingRule.
ProtocolInformationSyntax	This class implements the protocol information attribute syntax, which is being deprecated.
SchemaConstants	This class defines a number of constants used by Directory Server schema elements, like matching rules, syntaxes, attribute types, and objectclasses.
SubstringAssertionSyntax	This class defines the substring assertion attribute syntax, which contains one or more substring components, as used in a substring search filter.
SubtreeSpecificationSyntax	This class defines the subtree specification attribute syntax, which is used to specify the scope of sub-entries (RFC 3672).
SupportedAlgorithmSyntax	This class implements the supported algorithm attribute syntax.
TelephoneNumberEqualityMatchingRuleFactory	This class is a factory class for TelephoneNumberEqualityMatchingRule.
TelephoneNumberSubstringMatchingRuleFactory	This class is a factory class for TelephoneNumberSubstringMatchingRule.
TelephoneNumberSyntax	This class implements the telephone number attribute syntax, which is defined in RFC 2252.
TeletexTerminalIdentifierSyntax	This class implements the teletex terminal identifier attribute syntax, which contains a printable string (the terminal identifier) followed by zero or more parameters, which start with a dollar sign and are followed by a parameter name, a colon, and a value.
TelexNumberSyntax	This class implements the telex number attribute syntax, which contains three printable strings separated by dollar sign characters.
TimeBasedMatchingRuleFactory	This class acts as a factory for time-based matching rules.
UniqueMemberEqualityMatchingRuleFactory	This class is a factory class for UniqueMemberEqualityMatchingRule.
UserPasswordEqualityMatchingRuleFactory	This class is a factory class for UserPasswordExactEqualityMatchingRule.
UserPasswordExactEqualityMatchingRuleFactory	This class is a factory class for UserPasswordExactEqualityMatchingRule.
UserPasswordSyntax	This class defines an attribute syntax used for storing values that have been encoded using a password storage scheme.
UTCTimeSyntax	This class implements the UTC time attribute syntax.
UUIDEqualityMatchingRuleFactory	This class is a factory class for UUIDEqualityMatchingRule.
UUIDOrderingMatchingRuleFactory	This class is a factory class for UUIDOrderingMatchingRule.
UUIDSyntax	This class implements the UUID syntax, which is defined in RFC 4530.
WordEqualityMatchingRuleFactory	This class is a factory class for WordEqualityMatchingRule.

Package org.opends.server.schema Description

Contains implementations of various Directory Server schema elements. In particular, this holds the implementations of all the attribute syntaxes and equality/substring/ordering/approximate matching rules that have been defined in the server. Other schema elements (e.g., attribute types, objectclasses, name forms, matching rule uses, DIT content rules, and DIT structure rules) do not require any specialized processing and therefore implementations of those more generic objects are defined elsewhere in the Directory Server codebase.