Class LDAPDITContentRuleSchema

java.lang.Object

netscape.ldap.LDAPSchemaElement

netscape.ldap.LDAPDITContentRuleSchema

All Implemented Interfaces:

Serializable

public class LDAPDITContentRuleSchema
extends LDAPSchemaElement

The definition of a DIT content rule in the schema. RFC 2252, Lightweight Directory Access Protocol (v3): DIT Content Rule Description covers the types of information to specify when defining a DIT content rule. According to the RFC, the description of a DIT content rule can include the following:

• an OID identifying the attribute type
• a name identifying the attribute type
• a description of the attribute type
• the name of the parent attribute type
• the syntax used by the attribute (for example, cis or int)
• an indication of whether the attribute type is single-valued or multi-valued

When you construct an LDAPDITContentRuleSchema object, you can specify these types of information as arguments to the constructor or in the AttributeTypeDescription 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 attribute values in this format.

There are a number of additional optional description fields which are not explicitly accessible through LDAPDITContentRuleSchema, but which can be managed with setQualifier, getQualifier, and getQualifierNames:

• OBSOLETE

To get the name, OID, and description of this DIT content rule , use the getName, getOID, and getDescription methods inherited from the abstract class LDAPSchemaElement. Optional and custom qualifiers are accessed with getQualifier and getQualifierNames from LDAPSchemaElement.

To add or remove this attribute type definition from the schema, use the add and remove methods, which this class inherits from the LDAPSchemaElement abstract class.

RFC 2252 defines DITContentRuleDescription as follows:

   DITContentRuleDescription = "("
       numericoid   ; Structural ObjectClass identifier
       [ "NAME" qdescrs ]
       [ "DESC" qdstring ]
       [ "OBSOLETE" ]
       [ "AUX" oids ]    ; Auxiliary ObjectClasses
       [ "MUST" oids ]   ; AttributeType identifiers
       [ "MAY" oids ]    ; AttributeType identifiers
       [ "NOT" oids ]    ; AttributeType identifiers
      ")"

Version:

1.0

See Also:

• LDAPSchemaElement
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUX
static final String	MAY
static final String	MUST
static final String	NOT

Fields inherited from class 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

Modifier and Type	Field	Description
protected String[]	aliases
protected String	attrName
static final int	binary
protected static final String	binaryString
static final int	ces
protected static final String	cesString
static final int	cis
protected static final String	cisString
protected String	description
static final int	dn
protected static final String	dnString
static final int	integer
protected static final String	intString
protected String	name
protected static Hashtable<String,String>	novalsTable
static final String	OBSOLETE
protected String	oid
protected Hashtable<String,Object>	properties
protected String	rawValue
static final String	SUPERIOR
static final String	SYNTAX
static final int	telephone
protected static final String	telephoneString
static final int	unknown

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LDAPDITContentRuleSchema()	Constructs a blank element.
	LDAPDITContentRuleSchema(String raw)	Constructs a DIT content rule definition based on a description in the DITContentRuleDescription format.
	LDAPDITContentRuleSchema(String name, String oid, String description, boolean obsolete, String[] auxiliary, String[] required, String[] optional, String[] precluded)	Constructs a DIT content rule definition, using the specified information.

Method Summary

Modifier and Type	Method	Description
String[]	getAuxiliaryClasses()	Gets the names of the auxiliary object classes allowed in this content rule.
String[]	getOptionalAttributes()	Gets the names of optional attributes allowed in this content rule.
String[]	getPrecludedAttributes()	Gets the names of the precluded attributes for this content rule.
String[]	getRequiredAttributes()	Gets the names of the required attributes for this content rule.
String	getValue()	Prepares a value in RFC 2252 format for submission to a server
String	toString()	Gets the definition of the rule in a user friendly format.
protected String	vectorToList(Vector<String> vals)	Creates a list within parentheses, with $ as delimiter

Methods inherited from class LDAPSchemaElement

add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update

Modifier and Type	Method	Description
void	add(LDAPConnection ld)	Adds the current object class, attribute type, or matching rule definition to the schema at the root DSE.
void	add(LDAPConnection ld, String dn)	Adds the current object class, attribute type, or matching rule definition to the schema.
String[]	getAliases()	Gets the aliases of the attribute, if any
protected String	getCustomValues()	Gets any qualifiers marked as custom (starting with "X-")
String	getDescription()	Gets the description of the object class, attribute type, or matching rule.
String	getID()	Gets the object ID (OID) of the object class, attribute type, or matching rule in dotted-string format (for example, "1.2.3.4").
String	getName()	Gets the name of the object class, attribute type, or matching rule.
String	getOID()	Deprecated. Use LDAPSchemaElement.getID()
protected String	getOptionalValues(String[] names)	Gets qualifiers which may or may not be present
String[]	getQualifier(String name)	Gets the value of a qualifier which is not predefined.
Enumeration<String>	getQualifierNames()	Gets an enumeration of all qualifiers which are not predefined.
boolean	isObsolete()	Reports if the element is marked as obsolete.
void	modify(LDAPConnection ld, LDAPSchemaElement newValue)	Replaces a single value of the object class, attribute type, or matching rule definition in the schema at the root DSE.
void	modify(LDAPConnection ld, LDAPSchemaElement newValue, String dn)	Replaces a single value of the object class, attribute type, or matching rule definition in the schema.
protected void	parseValue(String raw)	Parses a raw schema value into OID, name, description, and a Hashtable of other qualifiers and values.
void	remove(LDAPConnection ld)	Removes the current object class, attribute type, or matching rule definition from the schema at the root DSE.
void	remove(LDAPConnection ld, String dn)	Removes the current object class, attribute type, or matching rule definition from the schema.
void	setQualifier(String name, String value)	Keeps track of qualifiers which are not predefined.
void	setQualifier(String name, String[] values)	Keeps track of qualifiers which are not predefined.
protected void	update(LDAPConnection ld, int op, String name, String dn)	Adds, removes or modifies the definition from a Directory.
protected void	update(LDAPConnection ld, int op, LDAPAttribute[] attrs, String dn)	Adds, removes or modifies the definition from a Directory.
protected void	update(LDAPConnection ld, int op, LDAPAttribute attr, String dn)	Adds, removes or modifies the definition from a Directory.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

AUX

public static final String AUX

See Also:

• Constant Field Values

MUST

public static final String MUST

See Also:

• Constant Field Values

MAY

public static final String MAY

See Also:

• Constant Field Values

NOT

public static final String NOT

See Also:

• Constant Field Values

Constructor Details

LDAPDITContentRuleSchema

protected LDAPDITContentRuleSchema()

Constructs a blank element.

LDAPDITContentRuleSchema

public LDAPDITContentRuleSchema(String name,
 String oid,
 String description,
 boolean obsolete,
 String[] auxiliary,
 String[] required,
 String[] optional,
 String[] precluded)

Constructs a DIT content rule definition, using the specified information.

Parameters:

name - name of the attribute type

oid - object identifier (OID) of the attribute type in dotted-string format (for example, "1.2.3.4")

description - description of attribute type

obsolete - true if the 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 user attribute types that an entry to which this content rule applies must contain in addition to its normal set of mandatory attributes. These may either be specified by name or numeric oid.

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

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

LDAPDITContentRuleSchema

public LDAPDITContentRuleSchema(String raw)

Constructs a DIT content rule definition based on a description in the DITContentRuleDescription format. For information on this format, (see RFC 2252, Lightweight Directory Access Protocol (v3): DIT Content Rule Description. 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 "objectclasses" and "attributetypes". The values of "attributetypes" are attribute type descriptions in this format.)

Parameters:

raw - definition of the DIT content rule in the DITContentRuleDescription format

Method Details

getRequiredAttributes

public String[] getRequiredAttributes()

Gets the names of the required attributes for this content rule.

Returns:

the names of the required attributes for this content rule.

getOptionalAttributes

public String[] getOptionalAttributes()

Gets the names of optional attributes allowed in this content rule.

Returns:

the names of optional attributes allowed in this content rule.

getPrecludedAttributes

public String[] getPrecludedAttributes()

Gets the names of the precluded attributes for this content rule.

Returns:

the names of the precluded attributes for this content rule.

getAuxiliaryClasses

public String[] getAuxiliaryClasses()

Gets the names of the auxiliary object classes allowed in this content rule.

Returns:

the names of auxiliary object classes allowed in this content rule.

getValue

public String getValue()

Prepares a value in RFC 2252 format for submission to a server

Overrides:

getValue in class LDAPSchemaElement

Returns:

a String ready for submission to an LDAP server.

vectorToList

protected String vectorToList(Vector<String> vals)

Creates a list within parentheses, with $ as delimiter

Parameters:

vals - values for list

Returns:

a String with a list of values.

toString

public String toString()

Gets the definition of the rule in a user friendly format. This is the format that the rule definition uses when printing the attribute type or the schema.

Overrides:

toString in class Object

Returns:

definition of the rule in a user friendly format.