org.apache.directory.shared.ldap.model.schema
Class ObjectClass

java.lang.Object
  org.apache.directory.shared.ldap.model.schema.AbstractSchemaObject
      org.apache.directory.shared.ldap.model.schema.ObjectClass

All Implemented Interfaces:

Serializable, SchemaObject

public class ObjectClass
extends AbstractSchemaObject

An objectClass definition.

According to ldapbis [MODELS]:

  Object Class definitions are written according to the ABNF:

    ObjectClassDescription = LPAREN WSP
        numericoid                ; object identifier
        [ SP "NAME" SP qdescrs ]  ; short names (descriptors)
        [ SP "DESC" SP qdstring ] ; description
        [ SP "OBSOLETE" ]         ; not active
        [ SP "SUP" SP oids ]      ; superior object classes
        [ SP kind ]               ; kind of class
        [ SP "MUST" SP oids ]     ; attribute types
        [ SP "MAY" SP oids ]      ; attribute types
        extensions WSP RPAREN

     kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"

   where:
     [numericoid] is object identifier assigned to this object class;
     NAME [qdescrs] are short names (descriptors) identifying this object
         class;
     DESC [qdstring] is a short descriptive string;
     OBSOLETE indicates this object class is not active;
     SUP [oids] specifies the direct superclasses of this object class;
     the kind of object class is indicated by one of ABSTRACT,
         STRUCTURAL, or AUXILIARY, default is STRUCTURAL;
     MUST and MAY specify the sets of required and allowed attribute
         types, respectively; and
    [extensions] describe extensions.
 

Author:

Apache Directory Project

See Also:

RFC2252 Section 4.4, ldapbis [MODELS], DescriptionUtils.getDescription(ObjectClass), Serialized Form

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.model.schema.AbstractSchemaObject

description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification

Constructor Summary

ObjectClass(String oid)
Creates a new instance of MatchingRuleUseDescription

Method Summary

void	addMayAttributeTypeOids(String... oids) Add some allowed AttributeType
void	addMayAttributeTypes(AttributeType... attributeTypes) Add some allowed AttributeTypes
void	addMustAttributeTypeOids(String... oids) Add some required AttributeType OIDs
void	addMustAttributeTypes(AttributeType... attributeTypes) Add some required AttributeTypes
void	addSuperior(ObjectClass... objectClasses) Add some superior ObjectClasses
void	addSuperiorOids(String... oids) Add some superior ObjectClass OIDs
void	clear() Clear the current SchemaObject : remove all the references to other objects, and all the Maps.
ObjectClass	copy() Copy an ObjectClass
boolean	equals(Object o)
List<String>	getMayAttributeTypeOids()
List<AttributeType>	getMayAttributeTypes()
List<String>	getMustAttributeTypeOids()
List<AttributeType>	getMustAttributeTypes()
List<String>	getSuperiorOids() Gets the superclasses OIDsof this ObjectClass.
List<ObjectClass>	getSuperiors() Gets the superclasses of this ObjectClass.
ObjectClassTypeEnum	getType() Gets the type of this ObjectClass as a type safe enum.
boolean	isAbstract() Tells if the current ObjectClass is ABSTRACT
boolean	isAuxiliary() Tells if the current ObjectClass is AUXILIARY
boolean	isStructural() Tells if the current ObjectClass is STRUCTURAL
void	removeFromRegistries(List<Throwable> errors, Registries registries) Remove the ObjectClass from the registries, updating the references to other SchemaObject.
void	setMayAttributeTypeOids(List<String> mayAttributeTypeOids)
void	setMayAttributeTypes(List<AttributeType> mayAttributeTypes) Sets the list of allowed AttributeTypes
void	setMustAttributeTypeOids(List<String> mustAttributeTypeOids)
void	setMustAttributeTypes(List<AttributeType> mustAttributeTypes) Sets the list of required AttributeTypes
void	setSuperiorOids(List<String> superiorOids) Sets the superior object class OIDs
void	setSuperiors(List<ObjectClass> superiors) Sets the superior object classes
void	setType(ObjectClassTypeEnum objectClassType) Set the ObjectClass type, one of ABSTRACT, AUXILIARY or STRUCTURAL.
String	toString()
void	updateMayAttributeTypes(List<AttributeType> mayAttributeTypes) Update the associated MAY AttributeType, even if the SchemaObject is readOnly
void	updateMustAttributeTypes(List<AttributeType> mustAttributeTypes) Update the associated MUST AttributeType, even if the SchemaObject is readOnly
void	updateSuperiors(List<ObjectClass> superiors) Update the associated SUPERIORS ObjectClasses, even if the SchemaObject is readOnly

Methods inherited from class org.apache.directory.shared.ldap.model.schema.AbstractSchemaObject

addExtension, addExtension, addName, addToRegistries, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectClass

public ObjectClass(String oid)

Creates a new instance of MatchingRuleUseDescription

Parameters:

oid - the OID for this objectClass

Method Detail

removeFromRegistries

public void removeFromRegistries(List<Throwable> errors,
                                 Registries registries)
                          throws LdapException

Remove the ObjectClass from the registries, updating the references to other SchemaObject. If one of the referenced SchemaObject does not exist (SUPERIORS, MAY, MUST), an exception is thrown.

Specified by:

removeFromRegistries in interface SchemaObject

Overrides:

removeFromRegistries in class AbstractSchemaObject

Parameters:

errors - The errors we got while removing the ObjectClass from the registries

registries - The Registries

Throws:

If - the ObjectClass is not valid

LdapException - if one of the referenced schema objects does not exist

getMayAttributeTypeOids

public List<String> getMayAttributeTypeOids()

Returns:

the mayAttributeTypeOids

getMayAttributeTypes

public List<AttributeType> getMayAttributeTypes()

Returns:

the mayAttributeTypes

addMayAttributeTypeOids

public void addMayAttributeTypeOids(String... oids)

Add some allowed AttributeType

Parameters:

oids - The attributeType oids

addMayAttributeTypes

public void addMayAttributeTypes(AttributeType... attributeTypes)

Add some allowed AttributeTypes

Parameters:

attributeTypes - The attributeTypes

setMayAttributeTypeOids

public void setMayAttributeTypeOids(List<String> mayAttributeTypeOids)

Parameters:

mayAttributeTypeOids - the mayAttributeTypeOids to set

setMayAttributeTypes

public void setMayAttributeTypes(List<AttributeType> mayAttributeTypes)

Sets the list of allowed AttributeTypes

Parameters:

mayAttributeTypes - the list of allowed AttributeTypes

updateMayAttributeTypes

public void updateMayAttributeTypes(List<AttributeType> mayAttributeTypes)

Update the associated MAY AttributeType, even if the SchemaObject is readOnly

Parameters:

mayAttributeTypes - the list of allowed AttributeTypes

getMustAttributeTypeOids

public List<String> getMustAttributeTypeOids()

Returns:

the mustAttributeTypeOids

getMustAttributeTypes

public List<AttributeType> getMustAttributeTypes()

Returns:

the mustAttributeTypes

addMustAttributeTypeOids

public void addMustAttributeTypeOids(String... oids)

Add some required AttributeType OIDs

Parameters:

oids - The attributeType OIDs

addMustAttributeTypes

public void addMustAttributeTypes(AttributeType... attributeTypes)

Add some required AttributeTypes

Parameters:

attributeTypes - The attributeTypse

setMustAttributeTypeOids

public void setMustAttributeTypeOids(List<String> mustAttributeTypeOids)

Parameters:

mustAttributeTypeOids - the mustAttributeTypeOids to set

setMustAttributeTypes

public void setMustAttributeTypes(List<AttributeType> mustAttributeTypes)

Sets the list of required AttributeTypes

Parameters:

mustAttributeTypes - the list of required AttributeTypes

updateMustAttributeTypes

public void updateMustAttributeTypes(List<AttributeType> mustAttributeTypes)

Update the associated MUST AttributeType, even if the SchemaObject is readOnly

Parameters:

mustAttributeTypes - the list of allowed AttributeTypes

getSuperiors

public List<ObjectClass> getSuperiors()

Gets the superclasses of this ObjectClass.

Returns:

the superclasses

getSuperiorOids

public List<String> getSuperiorOids()

Gets the superclasses OIDsof this ObjectClass.

Returns:

the superclasses OIDs

addSuperiorOids

public void addSuperiorOids(String... oids)

Add some superior ObjectClass OIDs

Parameters:

oids - The superior ObjectClass OIDs

addSuperior

public void addSuperior(ObjectClass... objectClasses)

Add some superior ObjectClasses

Parameters:

objectClasses - The superior ObjectClasses

setSuperiors

public void setSuperiors(List<ObjectClass> superiors)

Sets the superior object classes

Parameters:

superiors - the object classes to set

updateSuperiors

public void updateSuperiors(List<ObjectClass> superiors)

Update the associated SUPERIORS ObjectClasses, even if the SchemaObject is readOnly

Parameters:

superiors - the object classes to set

setSuperiorOids

public void setSuperiorOids(List<String> superiorOids)

Sets the superior object class OIDs

Parameters:

superiorOids - the object class OIDs to set

getType

public ObjectClassTypeEnum getType()

Gets the type of this ObjectClass as a type safe enum.

Returns:

the ObjectClass type as an enum

setType

public void setType(ObjectClassTypeEnum objectClassType)

Set the ObjectClass type, one of ABSTRACT, AUXILIARY or STRUCTURAL.

Parameters:

objectClassType - The ObjectClassType value

isStructural

public boolean isStructural()

Tells if the current ObjectClass is STRUCTURAL

Returns:

true if the ObjectClass is STRUCTURAL

isAbstract

public boolean isAbstract()

Tells if the current ObjectClass is ABSTRACT

Returns:

true if the ObjectClass is ABSTRACT

isAuxiliary

public boolean isAuxiliary()

Tells if the current ObjectClass is AUXILIARY

Returns:

true if the ObjectClass is AUXILIARY

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

copy

public ObjectClass copy()

Copy an ObjectClass

Specified by:

copy in interface SchemaObject

Specified by:

copy in class AbstractSchemaObject

Returns:

The copied SchemaObject

equals

public boolean equals(Object o)

Description copied from interface: SchemaObject

Specified by:

equals in interface SchemaObject

Overrides:

equals in class AbstractSchemaObject

See Also:

Object.equals(Object)

clear

public void clear()

Clear the current SchemaObject : remove all the references to other objects, and all the Maps.

Specified by:

clear in interface SchemaObject

Overrides:

clear in class AbstractSchemaObject