|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
org.apache.directory.shared.ldap.schema.MatchingRuleUse
public class MatchingRuleUse
Represents an LDAP MatchingRuleUseDescription defined in RFC 2252.
According to ldapbis [MODELS]:
Values of the matchingRuleUse list the attributes which are suitable for use with an extensible matching rule. Matching rule use descriptions are written according to the following ABNF: MatchingRuleUseDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "APPLIES" SP oids ; attribute types extensions WSP RPAREN ; extensions where: [numericoid] is the object identifier of the matching rule associated with this matching rule use description; NAME [qdescrs] are short names (descriptors) identifying this matching rule use; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this matching rule use is not active; APPLIES provides a list of attribute types the matching rule applies to; and [extensions] describe extensions. The matchingRule within the MatchingRuleUse definition can be used by an extensible match assertion if the assertion is based on the attributes listed within the MatchingRuleUse definition. If an extensible match assertion is based on attributes other than those listed within the MatchingRuleUse definition then the assertion is deemed undefined. Also according to 3.3.20 of [SYNTAXES] (ldapbis working group): A value of the Matching Rule Use Description syntax indicates the attribute types to which a matching rule may be applied in an extensibleMatch search filter [PROT]. The LDAP-specific encoding of a value of this syntax is defined by the <MatchingRuleUseDescription> rule in [MODELS] above.
Field Summary |
---|
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification |
Constructor Summary | |
---|---|
MatchingRuleUse(java.lang.String oid)
Creates a new instance of MatchingRuleUseDescription |
Method Summary | |
---|---|
void |
addApplicableAttribute(AttributeType attributeType)
Add a matchingRule's AttributeType the MRU applies to. |
void |
addApplicableAttributeOids(java.lang.String oid)
Add a matchingRule's AttributeType OIDs the MRU applies to. |
void |
addToRegistries(Registries registries)
Inject the MatchingRuleUse into the registries, updating the references to other SchemaObject |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
MatchingRuleUse |
copy()
Copy an MatchingRuleUse |
boolean |
equals(java.lang.Object o)
|
java.util.List<java.lang.String> |
getApplicableAttributeOids()
|
java.util.List<AttributeType> |
getApplicableAttributes()
|
void |
setApplicableAttributeOids(java.util.List<java.lang.String> applicableAttributeOids)
Set the matchingRule's AttributeType OIDs the MRU applies to. |
void |
setApplicableAttributes(java.util.List<AttributeType> applicableAttributes)
Set the matchingRule's AttributeType the MRU applies to. |
java.lang.String |
toString()
|
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
addExtension, addName, addToRegistries, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, removeFromRegistries, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MatchingRuleUse(java.lang.String oid)
Method Detail |
---|
public void addToRegistries(Registries registries) throws LdapException
registries
- The Registries
If
- the addition failed
LdapException
public java.util.List<java.lang.String> getApplicableAttributeOids()
public java.util.List<AttributeType> getApplicableAttributes()
public void setApplicableAttributeOids(java.util.List<java.lang.String> applicableAttributeOids)
applicableAttributes
- The AttributeType OIDs listpublic void setApplicableAttributes(java.util.List<AttributeType> applicableAttributes)
applicableAttributes
- The AttributeType listpublic void addApplicableAttributeOids(java.lang.String oid)
oid
- A matchingRule's AttributeType OIDs the MRU applies topublic void addApplicableAttribute(AttributeType attributeType)
oid
- A matchingRule's AttributeType the MRU applies topublic java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public MatchingRuleUse copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(java.lang.Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object.equals(Object)
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |