public class LDAPMatchingRuleUseSchema extends LDAPAttributeSchema
When you construct an LDAPMatchingRuleUseSchema
object, you can
specify these types of information as arguments to the constructor or
in the MatchingRuleUseDescription format specified in RFC 2252.
When an LDAP client searches an LDAP server for the schema, the server
returns schema information as an object with values in this
format.
You can get the name, OID, and description of this matching rule use
definition by using the getName
, getOID
, and
getDescription
methods inherited from the abstract class
LDAPSchemaElement
. Custom qualifiers are
accessed with getQualifier
and getQualifierNames
from LDAPSchemaElement
.
To add or remove this matching rule definition from the
schema, use the add
and remove
methods, which this class inherits from the LDAPSchemaElement
abstract class.
RFC 2252 defines MatchingRuleUseDescription follows:
Values of the matchingRuleUse list the attributes which are suitable for use with an extensible matching rule. MatchingRuleUseDescription = "(" whsp numericoid whsp ; MatchingRule identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" ] "APPLIES" oids ; AttributeType identifiers whsp ")"
COLLECTIVE, EQUALITY, NO_USER_MODIFICATION, ORDERING, SINGLE, SUBSTR, syntaxElement, USAGE
aliases, attrName, binary, binaryString, ces, cesString, cis, cisString, description, dn, dnString, integer, intString, name, novalsTable, OBSOLETE, oid, properties, rawValue, SUPERIOR, SYNTAX, telephone, telephoneString, unknown
Constructor and Description |
---|
LDAPMatchingRuleUseSchema(java.lang.String use)
Constructs a matching rule use definition based on descriptions in
the MatchingRuleUseDescription format.
|
LDAPMatchingRuleUseSchema(java.lang.String name,
java.lang.String oid,
java.lang.String description,
java.lang.String[] attributes)
Constructs a matching rule use definition, using the specified
information.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getApplicableAttributes()
Gets the list of the OIDs of the attribute types which can be used
with the matching rule.
|
java.lang.String |
getValue()
Gets the matching rule use definition in the string representation
of the MatchingRuleUseDescription data type defined in X.501 (see
RFC 2252, Lightweight Directory Access Protocol
(v3): Attribute Syntax Definitions
for a description of these formats).
|
java.lang.String |
toString()
Gets the definition of the matching rule use in a user friendly format.
|
getSuperior, getSyntax, getSyntaxString, isSingleValued
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
public LDAPMatchingRuleUseSchema(java.lang.String name, java.lang.String oid, java.lang.String description, java.lang.String[] attributes)
name
- name of the matching ruleoid
- object identifier (OID) of the matching rule
in dotted-decimal format (for example, "1.2.3.4")description
- description of the matching ruleattributes
- array of the OIDs of the attributes for which
the matching rule is applicablepublic LDAPMatchingRuleUseSchema(java.lang.String use)
use
- definition of the use of the matching rule in the
MatchingRuleUseDescription formatpublic java.lang.String[] getApplicableAttributes()
public java.lang.String getValue()
getValue
in class LDAPSchemaElement
matchingruleuse
attribute (which describes the use of
a matching rule in the schema) of a subschema
objectpublic java.lang.String toString()
toString
in class LDAPAttributeSchema