All LDAP Classes
Internal LDAP Classes

com.novell.ldap
Class LDAPMatchingRuleUseSchema

java.lang.Object
  extended by com.novell.ldap.LDAPAttribute
      extended by com.novell.ldap.LDAPSchemaElement
          extended by com.novell.ldap.LDAPMatchingRuleUseSchema
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class LDAPMatchingRuleUseSchema
extends LDAPSchemaElement

Represents the definition of a specific matching rule use in the directory schema.

The LDAPMatchingRuleUseSchema class represents the definition of a matching rule use. It is used to discover or modify which attributes are suitable for use with an extensible matching rule. It contains the name and identifier of a matching rule, and a list of attributes which it applies to.

See Also:
LDAPAttributeSchema, LDAPSchemaElement, LDAPSchema, Serialized Form

Field Summary
private  java.lang.String[] attributes
           
 
Fields inherited from class com.novell.ldap.LDAPSchemaElement
description, hashQualifier, names, obsolete, oid, qualifier
 
Constructor Summary
LDAPMatchingRuleUseSchema()
          This constructor was added to support default Serialization
LDAPMatchingRuleUseSchema(java.lang.String raw)
          Constructs a matching rule use definition from the raw string value returned on a schema query for matchingRuleUse.
LDAPMatchingRuleUseSchema(java.lang.String[] names, java.lang.String oid, java.lang.String description, boolean obsolete, java.lang.String[] attributes)
          Constructs a matching rule use definition for adding to or deleting from the schema.
 
Method Summary
protected  java.lang.String formatString()
          Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element attribute.
 java.lang.String[] getAttributes()
          Returns an array of all the attributes which this matching rule applies to.
private static LDAPXMLHandler getTopXMLHandler(java.lang.String tagname, LDAPXMLHandler parenthandler)
           
(package private) static LDAPXMLHandler getXMLHandler(java.lang.String tagname, LDAPXMLHandler parenthandler)
          This method return the LDAPHandler which handles the XML (DSML) tags for this class
static java.lang.Object readDSML(java.io.InputStream input)
          This method is used to deserialize the DSML encoded representation of this class.
protected  void setDeserializedValues(java.io.BufferedInputStream istream)
           
protected  void writeValue(java.lang.StringBuffer buff)
           
protected  void writeValue(java.io.Writer out)
           
 
Methods inherited from class com.novell.ldap.LDAPSchemaElement
addValue, addValue, getDescription, getID, getNames, getQualifier, getQualifierNames, isObsolete, removeValue, removeValue, setQualifier, toString
 
Methods inherited from class com.novell.ldap.LDAPAttribute
addBase64Value, addBase64Value, addBase64Value, addURLValue, addURLValue, addValue, clone, compareTo, getBaseName, getBaseName, getByteValue, getByteValueArray, getByteValues, getLangSubtype, getName, getStringValue, getStringValueArray, getStringValues, getSubtypes, getSubtypes, hasSubtype, hasSubtypes, newLine, readExternal, removeValue, setValue, size, writeDSML, writeExternal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

attributes

private java.lang.String[] attributes
Constructor Detail

LDAPMatchingRuleUseSchema

public LDAPMatchingRuleUseSchema()
This constructor was added to support default Serialization


LDAPMatchingRuleUseSchema

public LDAPMatchingRuleUseSchema(java.lang.String[] names,
                                 java.lang.String oid,
                                 java.lang.String description,
                                 boolean obsolete,
                                 java.lang.String[] attributes)
Constructs a matching rule use definition for adding to or deleting from the schema.

Parameters:
names - Name(s) of the matching rule.

oid - Object Identifier of the the matching rule in dotted-decimal format.

description - Optional description of the matching rule use.

obsolete - True if the matching rule use is obsolete.

attributes - List of attributes that this matching rule applies to. These values may be either the names or numeric oids of the attributes.

LDAPMatchingRuleUseSchema

public LDAPMatchingRuleUseSchema(java.lang.String raw)
Constructs a matching rule use definition from the raw string value returned on a schema query for matchingRuleUse.

Parameters:
raw - The raw string value returned on a schema query for matchingRuleUse.
Method Detail

getAttributes

public java.lang.String[] getAttributes()
Returns an array of all the attributes which this matching rule applies to.

Returns:
An array of all the attributes which this matching rule applies to.

formatString

protected java.lang.String formatString()
Returns a string in a format suitable for directly adding to a directory, as a value of the particular schema element attribute.

Specified by:
formatString in class LDAPSchemaElement
Returns:
A string representation of the attribute's definition.

setDeserializedValues

protected void setDeserializedValues(java.io.BufferedInputStream istream)
                              throws java.io.IOException
Overrides:
setDeserializedValues in class LDAPAttribute
Throws:
java.io.IOException

writeValue

protected void writeValue(java.io.Writer out)
                   throws java.io.IOException
Overrides:
writeValue in class LDAPAttribute
Throws:
java.io.IOException

writeValue

protected void writeValue(java.lang.StringBuffer buff)
Overrides:
writeValue in class LDAPAttribute

readDSML

public static java.lang.Object readDSML(java.io.InputStream input)
                                 throws java.io.IOException
This method is used to deserialize the DSML encoded representation of this class.

Parameters:
input - InputStream for the DSML formatted data.
Returns:
Deserialized form of this class.
Throws:
java.io.IOException - when serialization fails.

getTopXMLHandler

private static LDAPXMLHandler getTopXMLHandler(java.lang.String tagname,
                                               LDAPXMLHandler parenthandler)

getXMLHandler

static LDAPXMLHandler getXMLHandler(java.lang.String tagname,
                                    LDAPXMLHandler parenthandler)
This method return the LDAPHandler which handles the XML (DSML) tags for this class

Parameters:
tagname - Name of the Root tag used to represent this class.
parenthandler - Parent LDAPXMLHandler for this tag.
Returns:
LDAPXMLHandler to handle this element.

All LDAP Classes
Internal LDAP Classes

Copyright ? 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000