All LDAP Classes
Internal LDAP Classes

com.novell.ldap
Class LDAPDITContentRuleSchema

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

public class LDAPDITContentRuleSchema
extends LDAPSchemaElement

Represents a DIT (Directory Information Tree) content rule in a directory schema.

The LDAPDITContentRuleSchema class is used to discover or modify additional auxiliary classes, mandatory and optional attributes, and restricted attributes in effect for an object class.

See Also:
Serialized Form

Field Summary
private  java.lang.String[] auxiliary
           
private  java.lang.String[] optional
           
private  java.lang.String[] precluded
           
private  java.lang.String[] required
           
 
Fields inherited from class com.novell.ldap.LDAPSchemaElement
description, hashQualifier, names, obsolete, oid, qualifier
 
Constructor Summary
LDAPDITContentRuleSchema()
          This constructor was added to support default Serialization
LDAPDITContentRuleSchema(java.lang.String raw)
          Constructs a DIT content rule from the raw string value returned from a schema query for dITContentRules.
LDAPDITContentRuleSchema(java.lang.String[] names, java.lang.String oid, java.lang.String description, boolean obsolete, java.lang.String[] auxiliary, java.lang.String[] required, java.lang.String[] optional, java.lang.String[] precluded)
          Constructs a DIT content rule 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 class.
 java.lang.String[] getAuxiliaryClasses()
          Returns the list of allowed auxiliary classes.
 java.lang.String[] getOptionalAttributes()
          Returns the list of additional optional attributes for an entry controlled by this content rule.
 java.lang.String[] getPrecludedAttributes()
          Returns the list of precluded attributes for an entry controlled by this content rule.
 java.lang.String[] getRequiredAttributes()
          Returns the list of additional required attributes for an entry controlled by this content rule.
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

auxiliary

private java.lang.String[] auxiliary

required

private java.lang.String[] required

optional

private java.lang.String[] optional

precluded

private java.lang.String[] precluded
Constructor Detail

LDAPDITContentRuleSchema

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


LDAPDITContentRuleSchema

public LDAPDITContentRuleSchema(java.lang.String[] names,
                                java.lang.String oid,
                                java.lang.String description,
                                boolean obsolete,
                                java.lang.String[] auxiliary,
                                java.lang.String[] required,
                                java.lang.String[] optional,
                                java.lang.String[] precluded)
Constructs a DIT content rule for adding to or deleting from the schema.

Parameters:
names - The names of the content rule.

oid - The unique object identifier of the content rule - in dotted numerical format.

description - The optional description of the content rule.

obsolete - True if the content rule is obsolete.

auxiliary - A list of auxiliary object classes allowed for an entry to which this content rule applies. These may either be specified by name or numeric oid.

required - A list of attributes that an entry to which this content rule applies must contain in addition to its normal set of mandatory attributes. These attributes may be specified by either name or numeric oid.

optional - A list of attributes that an entry to which this content rule applies may contain in addition to its normal set of optional attributes. These attributes may be specified by either name or numeric oid.

precluded - A list, consisting of a subset of the optional attributes of the structural and auxiliary object classes which are precluded from an entry to which this content rule applies. These may be specified by either name or numeric oid.

LDAPDITContentRuleSchema

public LDAPDITContentRuleSchema(java.lang.String raw)
Constructs a DIT content rule from the raw string value returned from a schema query for dITContentRules.

Parameters:
raw - The raw string value returned from a schema query for content rules.
Method Detail

getAuxiliaryClasses

public java.lang.String[] getAuxiliaryClasses()
Returns the list of allowed auxiliary classes.

Returns:
The list of allowed auxiliary classes.

getRequiredAttributes

public java.lang.String[] getRequiredAttributes()
Returns the list of additional required attributes for an entry controlled by this content rule.

Returns:
The list of additional required attributes.

getOptionalAttributes

public java.lang.String[] getOptionalAttributes()
Returns the list of additional optional attributes for an entry controlled by this content rule.

Returns:
The list of additional optional attributes.

getPrecludedAttributes

public java.lang.String[] getPrecludedAttributes()
Returns the list of precluded attributes for an entry controlled by this content rule.

Returns:
The list of precluded attributes.

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 class.

Specified by:
formatString in class LDAPSchemaElement
Returns:
A string representation of the class' 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