Class LDAPMatchingRuleUseSchema
- java.lang.Object
-
- netscape.ldap.LDAPSchemaElement
-
- netscape.ldap.LDAPAttributeSchema
-
- netscape.ldap.LDAPMatchingRuleUseSchema
-
- All Implemented Interfaces:
java.io.Serializable
public class LDAPMatchingRuleUseSchema extends LDAPAttributeSchema
The definition of a matching rule use in the schema. RFC 2252, Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions covers the types of information that need to be specified in the definition of a matching rule use. According to the RFC, the description of a matching rule use can include the following information:- an OID identifying the matching rule
- a name identifying the matching rule use
- a description of the matching rule use
- a list of attributes the matching rule applies to
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
, andgetDescription
methods inherited from the abstract classLDAPSchemaElement
. Custom qualifiers are accessed withgetQualifier
andgetQualifierNames
fromLDAPSchemaElement
.To add or remove this matching rule definition from the schema, use the
add
andremove
methods, which this class inherits from theLDAPSchemaElement
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 ")"
- Version:
- 1.0
- See Also:
LDAPSchemaElement
,LDAPMatchingRuleSchema
, Serialized Form
-
-
Field Summary
-
Fields inherited from class netscape.ldap.LDAPAttributeSchema
COLLECTIVE, EQUALITY, NO_USER_MODIFICATION, ORDERING, SINGLE, SUBSTR, syntaxElement, USAGE
-
Fields inherited from class netscape.ldap.LDAPSchemaElement
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 Summary
Constructors Constructor 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class netscape.ldap.LDAPAttributeSchema
getSuperior, getSyntax, getSyntaxString, isSingleValued
-
Methods inherited from class netscape.ldap.LDAPSchemaElement
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
-
-
-
-
Constructor Detail
-
LDAPMatchingRuleUseSchema
public 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.- Parameters:
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 applicable
-
LDAPMatchingRuleUseSchema
public LDAPMatchingRuleUseSchema(java.lang.String use)
Constructs a matching rule use definition based on descriptions in the MatchingRuleUseDescription format. For information on this format, (see RFC 2252, Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions. This is the format that LDAP servers and clients use to exchange schema information. For example, when you search an LDAP server for its schema, the server returns an entry with attributes that include "matchingrule" and "matchingruleuse". The values of these attributes are matching rule descriptions in this format.- Parameters:
use
- definition of the use of the matching rule in the MatchingRuleUseDescription format
-
-
Method Detail
-
getApplicableAttributes
public java.lang.String[] getApplicableAttributes()
Gets the list of the OIDs of the attribute types which can be used with the matching rule.- Returns:
- array of the OIDs of the attribute types which can be used with the matching rule.
-
getValue
public 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). This is the format that LDAP servers and clients use to exchange schema information. (For example, when you search an LDAP server for its schema, the server returns an entry with the attributes "matchingrules" and "matchingruleuse". The values of these attributes are matching rule description and matching rule use description in these formats.)- Overrides:
getValue
in classLDAPSchemaElement
- Returns:
- a string in a format that can be used as the value of
the
matchingruleuse
attribute (which describes the use of a matching rule in the schema) of asubschema
object
-
toString
public java.lang.String toString()
Gets the definition of the matching rule use in a user friendly format. This is the format that the matching rule use definition uses when you print the matching rule or the schema.- Overrides:
toString
in classLDAPAttributeSchema
- Returns:
- definition of the matching rule in a user friendly format.
-
-