* *
*
* 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 ")"
*
*
*
* @version 1.0
* @see org.ietf.ldap.LDAPSchemaElement
* @see org.ietf.ldap.LDAPMatchingRuleSchema
**/
public class LDAPMatchingRuleUseSchema extends LDAPAttributeSchema {
/**
* Constructs a matching rule use definition, using the specified
* information.
* @param names names of the matching rule
* @param oid object identifier (OID) of the matching rule
* in dotted-decimal format (for example, "1.2.3.4")
* @param description description of the matching rule
* @param obsolete true if the element is obsolete
* @param attributes array of the OIDs of the attributes for which
* the matching rule is applicable
*/
public LDAPMatchingRuleUseSchema( String[] names,
String oid,
String description,
boolean obsolete,
String[] attributes ) {
if ( (oid == null) || (oid.trim().length() < 1) ) {
throw new IllegalArgumentException( "OID required" );
}
this.names = names;
this.oid = oid;
this.description = description;
attrName = "matchingruleuse";
_attributes = new String[attributes.length];
for( int i = 0; i < attributes.length; i++ ) {
_attributes[i] = attributes[i];
}
if ( obsolete ) {
setQualifier( OBSOLETE, "" );
}
}
/**
* 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.
*
* * @param use definition of the use of the matching rule in the * MatchingRuleUseDescription format */ public LDAPMatchingRuleUseSchema( String use ) { attrName = "matchingruleuse"; parseValue( use ); Vector v = (Vector)properties.get( "APPLIES" ); if ( v != null ) { _attributes = new String[v.size()]; v.copyInto( _attributes ); v.removeAllElements(); } } /** * Gets the list of the OIDs of the attribute types which can be used * with the matching rule. * @return array of the OIDs of the attribute types which can be used * with the matching rule. */ public String[] getApplicableAttributes() { return _attributes; } /** * Gets the attribute name for a schema element * * @return The attribute name of the element */ String getAttributeName() { return "matchingruleuse"; } /** * 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.) *
*
* @return 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 a subschema object
*/
public String getValue() {
String s = getValuePrefix();
if ( (_attributes != null) && (_attributes.length > 0) ) {
s += "APPLIES ( ";
for( int i = 0; i < _attributes.length; i++ ) {
if ( i > 0 )
s += " $ ";
s += _attributes[i];
}
s += " ) ";
}
s += ')';
return s;
}
/**
* Gets the definition of the matching rule use in Directory format
*
* @return definition of the matching rule use in Directory format
*/
public String toString() {
return getValue();
}
// Qualifiers tracked explicitly
static final String[] EXPLICIT = { OBSOLETE };
private String[] _attributes = null;
}