public class LDAPDITStructureRuleSchema extends LDAPSchemaElement
cis
or int
)
When you construct an LDAPDITStructureRuleSchema
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 LDAPDITStructureRuleSchema, but which can be managed with setQualifier, getQualifier, and getQualifierNames:
To get the name, OID, and description of this DIT structure 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 DITStructureRuleDescription as follows:
DITStructureRuleDescription = "(" whsp ruleidentifier whsp ; DITStructureRule identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" whsp ] "FORM" woid whsp ; NameForm [ "SUP" ruleidentifiers whsp ] ; superior DITStructureRules ")"
LDAPSchemaElement
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
FORM |
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 | Constructor and Description |
---|---|
protected |
LDAPDITStructureRuleSchema()
Constructs a blank element.
|
|
LDAPDITStructureRuleSchema(java.lang.String raw)
Constructs a DIT structure rule definition based on a description in
the DITStructureRuleDescription format.
|
|
LDAPDITStructureRuleSchema(java.lang.String name,
int ruleID,
java.lang.String description,
boolean obsolete,
java.lang.String nameForm,
java.lang.String[] superiors)
Constructs a DIT structure rule definition, using the specified
information.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getNameForm()
Returns the NameForm that this structure rule controls.
|
int |
getRuleID()
Returns the rule ID for this structure rule.
|
java.lang.String[] |
getSuperiors()
Returns a list of all structure rules that are superior to this
structure rule.
|
java.lang.String |
getValue()
Prepares a value in RFC 2252 format for submission to a server
|
java.lang.String |
toString()
Gets the definition of the rule in a user friendly format.
|
add, add, getAliases, getCustomValues, getDescription, getID, getName, getOID, getOptionalValues, getQualifier, getQualifierNames, isObsolete, modify, modify, parseValue, remove, remove, setQualifier, setQualifier, update, update, update
public static final java.lang.String FORM
protected LDAPDITStructureRuleSchema()
public LDAPDITStructureRuleSchema(java.lang.String name, int ruleID, java.lang.String description, boolean obsolete, java.lang.String nameForm, java.lang.String[] superiors)
name
- name of the attribute typeruleID
- unique identifier of the structure rule.description
- description of attribute typeobsolete
- true
if the rule is obsoletenameForm
- either the identifier or name of a name form.
This is used to indirectly refer to the object class that this
structure rule applies to.superiors
- list of superior structure rules - specified
by their integer ID. The object class specified by this structure
rule (via the nameForm parameter) may only be subordinate in
the DIT to object classes of those represented by the structure
rules here.public LDAPDITStructureRuleSchema(java.lang.String raw)
raw
- definition of the DIT structure rule in the
DITStructureRuleDescription formatpublic java.lang.String[] getSuperiors()
public int getRuleID()
public java.lang.String getNameForm()
public java.lang.String getValue()
getValue
in class LDAPSchemaElement
public java.lang.String toString()
toString
in class java.lang.Object