Class LDAPDITContentRuleSchema
- All Implemented Interfaces:
Serializable
- 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
orint
) - 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
Fields inherited from class netscape.ldap.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
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructs a blank element.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 TypeMethodDescriptionString[]
Gets the names of the auxiliary object classes allowed in this content rule.String[]
Gets the names of optional attributes allowed in this content rule.String[]
Gets the names of the precluded attributes for this content rule.String[]
Gets the names of the required attributes for this content rule.getValue()
Prepares a value in RFC 2252 format for submission to a servertoString()
Gets the definition of the rule in a user friendly format.protected String
vectorToList
(Vector<String> vals) Creates a list within parentheses, with $ as delimiterMethods inherited from class netscape.ldap.LDAPSchemaElement
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
-
Field Details
-
AUX
- See Also:
-
MUST
- See Also:
-
MAY
- See Also:
-
NOT
- See Also:
-
-
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 typeoid
- object identifier (OID) of the attribute type in dotted-string format (for example, "1.2.3.4")description
- description of attribute typeobsolete
-true
if the rule is obsoleteauxiliary
- 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
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
Gets the names of the required attributes for this content rule.- Returns:
- the names of the required attributes for this content rule.
-
getOptionalAttributes
Gets the names of optional attributes allowed in this content rule.- Returns:
- the names of optional attributes allowed in this content rule.
-
getPrecludedAttributes
Gets the names of the precluded attributes for this content rule.- Returns:
- the names of the precluded attributes for this content rule.
-
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
Prepares a value in RFC 2252 format for submission to a server- Overrides:
getValue
in classLDAPSchemaElement
- Returns:
- a String ready for submission to an LDAP server.
-
vectorToList
Creates a list within parentheses, with $ as delimiter- Parameters:
vals
- values for list- Returns:
- a String with a list of values.
-
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.
-