|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
org.apache.directory.shared.ldap.schema.DITContentRule
public class DITContentRule
A ditContentRule specification. ditContentRules identify the content of entries of a particular structural objectClass. They specify the AUXILIARY objectClasses and additional attribute types permitted to appear, or excluded from appearing in entries of the indicated STRUCTURAL objectClass.
According to ldapbis [MODELS]:
4.1.6. DIT Content Rules A DIT content rule is a "rule governing the content of entries of a particular structural object class" [X.501]. For DIT entries of a particular structural object class, a DIT content rule specifies which auxiliary object classes the entries are allowed to belong to and which additional attributes (by type) are required, allowed or not allowed to appear in the entries. The list of precluded attributes cannot include any attribute listed as mandatory in rule, the structural object class, or any of the allowed auxiliary object classes. Each content rule is identified by the object identifier, as well as any short names (descriptors), of the structural object class it applies to. An entry may only belong to auxiliary object classes listed in the governing content rule. An entry must contain all attributes required by the object classes the entry belongs to as well as all attributed required by the governing content rule. An entry may contain any non-precluded attributes allowed by the object classes the entry belongs to as well as all attributes allowed by the governing content rule. An entry cannot include any attribute precluded by the governing content rule. An entry is governed by (if present and active in the subschema) the DIT content rule which applies to the structural object class of the entry (see Section 2.4.2). If no active rule is present for the entry's structural object class, the entry's content is governed by the structural object class (and possibly other aspects of user and system schema). DIT content rule descriptions are written according to the ABNF: DITContentRuleDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active [ SP "AUX" SP oids ] ; auxiliary object classes [ SP "MUST" SP oids ] ; attribute types [ SP "MAY" SP oids ] ; attribute types [ SP "NOT" SP oids ] ; attribute types extensions WSP RPAREN ; extensions where: [numericoid] is the object identifier of the structural object class associated with this DIT content rule; NAME [qdescrs] are short names (descriptors) identifying this DIT content rule; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this DIT content rule use is not active; AUX specifies a list of auxiliary object classes which entries subject to this DIT content rule may belong to; MUST, MAY, and NOT specify lists of attribute types which are required, allowed, or precluded, respectively, from appearing in entries subject to this DIT content rule; and [extensions] describe extensions.
DescriptionUtils.getDescription(DITContentRule)
,
Serialized FormField Summary | |
---|---|
static long |
serialVersionUID
The serialVersionUID |
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification |
Constructor Summary | |
---|---|
DITContentRule(java.lang.String oid)
Creates a DITContentRule object using a unique OID. |
Method Summary | |
---|---|
void |
addAuxObjectClasses(ObjectClass objectClass)
Add an Auxiliary ObjectClass |
void |
addAuxObjectClassOidOids(java.lang.String oid)
Add an Auxiliary ObjectClass Oid |
void |
addMayAttributeTypeOids(java.lang.String oid)
Add an allowed AttributeType |
void |
addMayAttributeTypes(AttributeType attributeType)
Add an allowed AttributeType |
void |
addMustAttributeTypeOids(java.lang.String oid)
Add a required AttributeType OID |
void |
addMustAttributeTypes(AttributeType attributeType)
Add a required AttributeType |
void |
addNotAttributeTypeOids(java.lang.String oid)
Add a precluded AttributeType |
void |
addNotAttributeTypes(AttributeType attributeType)
Add a precluded AttributeType |
void |
addToRegistries(Registries registries)
Inject the DITContentRule into the registries, updating the references to other SchemaObject |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
DITContentRule |
copy()
Copy a DITContentRule |
boolean |
equals(java.lang.Object o)
|
java.util.List<ObjectClass> |
getAuxObjectClasses()
|
java.util.List<java.lang.String> |
getAuxObjectClassOids()
|
java.util.List<java.lang.String> |
getMayAttributeTypeOids()
|
java.util.List<AttributeType> |
getMayAttributeTypes()
|
java.util.List<java.lang.String> |
getMustAttributeTypeOids()
|
java.util.List<AttributeType> |
getMustAttributeTypes()
|
java.util.List<java.lang.String> |
getNotAttributeTypeOids()
|
java.util.List<AttributeType> |
getNotAttributeTypes()
|
void |
setAuxObjectClasses(java.util.List<ObjectClass> auxObjectClasses)
|
void |
setAuxObjectClassOids(java.util.List<java.lang.String> auxObjectClassOids)
|
void |
setMayAttributeTypeOids(java.util.List<java.lang.String> mayAttributeTypeOids)
|
void |
setMayAttributeTypes(java.util.List<AttributeType> mayAttributeTypes)
Sets the list of allowed AttributeTypes |
void |
setMustAttributeTypeOids(java.util.List<java.lang.String> mustAttributeTypeOids)
|
void |
setMustAttributeTypes(java.util.List<AttributeType> mustAttributeTypes)
Sets the list of required AttributeTypes |
void |
setNotAttributeTypeOids(java.util.List<java.lang.String> notAttributeTypeOids)
|
void |
setNotAttributeTypes(java.util.List<AttributeType> notAttributeTypes)
Sets the list of precluded AttributeTypes |
java.lang.String |
toString()
|
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
addExtension, addName, addToRegistries, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, removeFromRegistries, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public DITContentRule(java.lang.String oid)
oid
- the OID for this DITContentRuleMethod Detail |
---|
public java.util.List<java.lang.String> getAuxObjectClassOids()
public void addAuxObjectClassOidOids(java.lang.String oid)
oid
- The ObjectClass oidpublic void addAuxObjectClasses(ObjectClass objectClass)
oid
- The ObjectClasspublic void setAuxObjectClassOids(java.util.List<java.lang.String> auxObjectClassOids)
auxObjectClassOids
- the auxObjectClassOids to setpublic void setAuxObjectClasses(java.util.List<ObjectClass> auxObjectClasses)
auxObjectClasses
- the auxObjectClasses to setpublic java.util.List<ObjectClass> getAuxObjectClasses()
public java.util.List<java.lang.String> getMayAttributeTypeOids()
public void addMayAttributeTypeOids(java.lang.String oid)
oid
- The attributeType oidpublic void addMayAttributeTypes(AttributeType attributeType)
attributeType
- The attributeTypepublic void setMayAttributeTypeOids(java.util.List<java.lang.String> mayAttributeTypeOids)
mayAttributeTypeOids
- the mayAttributeTypeOids to setpublic void setMayAttributeTypes(java.util.List<AttributeType> mayAttributeTypes)
mayAttributeTypes
- the list of allowed AttributeTypespublic java.util.List<AttributeType> getMayAttributeTypes()
public java.util.List<java.lang.String> getMustAttributeTypeOids()
public void addMustAttributeTypeOids(java.lang.String oid)
oid
- The attributeType OIDpublic void addMustAttributeTypes(AttributeType attributeType)
attributeType
- The attributeTypepublic void setMustAttributeTypeOids(java.util.List<java.lang.String> mustAttributeTypeOids)
mustAttributeTypeOids
- the mustAttributeTypeOids to setpublic void setMustAttributeTypes(java.util.List<AttributeType> mustAttributeTypes)
mayAttributeTypes
- the list of required AttributeTypespublic java.util.List<AttributeType> getMustAttributeTypes()
public java.util.List<java.lang.String> getNotAttributeTypeOids()
public void addNotAttributeTypeOids(java.lang.String oid)
oid
- The attributeType oidpublic void addNotAttributeTypes(AttributeType attributeType)
attributeType
- The attributeTypepublic void setNotAttributeTypeOids(java.util.List<java.lang.String> notAttributeTypeOids)
notAttributeTypeOids
- the notAttributeTypeOids to setpublic void setNotAttributeTypes(java.util.List<AttributeType> notAttributeTypes)
mayAttributeTypes
- the list of precluded AttributeTypespublic java.util.List<AttributeType> getNotAttributeTypes()
public void addToRegistries(Registries registries) throws LdapException
registries
- The Registries
If
- the addition failed
LdapException
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public DITContentRule copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(java.lang.Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object.equals(Object)
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |