org.apache.directory.shared.ldap.schema.registries
Class ImmutableObjectClassRegistry

java.lang.Object
  extended by org.apache.directory.shared.ldap.schema.registries.ImmutableObjectClassRegistry
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<ObjectClass>, ObjectClassRegistry, SchemaObjectRegistry<ObjectClass>

public class ImmutableObjectClassRegistry
extends java.lang.Object
implements ObjectClassRegistry, java.lang.Cloneable

An immutable wrapper of the ObjectClass registry.

Version:
$Rev: 828111 $
Author:
Apache Directory Project

Constructor Summary
ImmutableObjectClassRegistry(ObjectClassRegistry ocRegistry)
          Creates a new instance of ImmutableAttributeTypeRegistry.
 
Method Summary
 void clear()
          Clear the registry from all its content
 boolean contains(java.lang.String oid)
          Checks to see if an SchemaObject exists in the registry, by its OID or name.
 ImmutableObjectClassRegistry copy()
          Clone the ObjectClassRegistry
 java.util.Iterator<ObjectClass> descendants(java.lang.String ancestorId)
          Get's an iterator over the set of descendant ObjectClasses for some ancestor's name alias or their OID.
 SchemaObject get(java.lang.String oid)
          Gets the SchemaObject associated with a given OID.
 java.lang.String getOidByName(java.lang.String name)
          Gets the numericOid for a name/alias if one is associated.
 java.lang.String getSchemaName(java.lang.String oid)
          Gets the name of the schema this schema object is associated with.
 SchemaObjectType getType()
          
 boolean hasDescendants(java.lang.String ancestorId)
          Quick lookup to see if an objectClass has descendants.
 java.util.Iterator<ObjectClass> iterator()
          Gets an iterator over the registered schema objects in the registry.
 ObjectClass lookup(java.lang.String oid)
          Looks up a SchemaObject by its unique Object Identifier or by name.
 java.util.Iterator<java.lang.String> oidsIterator()
          Gets an iterator over the registered schema objects'OID in the registry.
 void register(ObjectClass objectClass)
          Registers a new ObjectClass with this registry.
 void registerDescendants(ObjectClass objectClass, java.util.List<ObjectClass> ancestors)
          Store the ObjectClass into a map associating an ObjectClass to its descendants.
 void renameSchema(java.lang.String originalSchemaName, java.lang.String newSchemaName)
          Modify all the SchemaObject using a schemaName when this name changes.
 int size()
          
 ObjectClass unregister(ObjectClass schemaObject)
          Removes the SchemaObject registered with this registry.
 ObjectClass unregister(java.lang.String numericOid)
          Removes the ObjectClass registered with this registry.
 void unregisterDescendants(ObjectClass attributeType, java.util.List<ObjectClass> ancestors)
          Remove the ObjectClass from the map associating an ObjectClass to its descendants.
 void unregisterSchemaElements(java.lang.String schemaName)
          Unregisters all SchemaObjects defined for a specific schema from this registry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImmutableObjectClassRegistry

public ImmutableObjectClassRegistry(ObjectClassRegistry ocRegistry)
Creates a new instance of ImmutableAttributeTypeRegistry.

Parameters:
atRegistry - The wrapped Attrib uteType registry
Method Detail

hasDescendants

public boolean hasDescendants(java.lang.String ancestorId)
                       throws LdapException
Quick lookup to see if an objectClass has descendants.

Specified by:
hasDescendants in interface ObjectClassRegistry
Parameters:
ancestorId - the name alias or OID for an ObjectClass
Returns:
an Iterator over the ObjectClasses which have the ancestor within their superior chain to the top
Throws:
LdapException - if the ancestor ObjectClass cannot be discerned from the ancestorId supplied

descendants

public java.util.Iterator<ObjectClass> descendants(java.lang.String ancestorId)
                                            throws LdapException
Get's an iterator over the set of descendant ObjectClasses for some ancestor's name alias or their OID.

Specified by:
descendants in interface ObjectClassRegistry
Parameters:
ancestorId - the name alias or OID for an ObjectClass
Returns:
an Iterator over the ObjectClasses which have the ancestor within their superior chain to the top
Throws:
LdapException - if the ancestor ObjectClass cannot be discerned from the ancestorId supplied

registerDescendants

public void registerDescendants(ObjectClass objectClass,
                                java.util.List<ObjectClass> ancestors)
                         throws LdapException
Store the ObjectClass into a map associating an ObjectClass to its descendants.

Specified by:
registerDescendants in interface ObjectClassRegistry
Throws:
LdapException - If something went wrong

unregisterDescendants

public void unregisterDescendants(ObjectClass attributeType,
                                  java.util.List<ObjectClass> ancestors)
                           throws LdapException
Remove the ObjectClass from the map associating an ObjectClass to its descendants.

Specified by:
unregisterDescendants in interface ObjectClassRegistry
Parameters:
attributeType - The ObjectClass to unregister
Throws:
LdapException - If something went wrong

register

public void register(ObjectClass objectClass)
              throws LdapException
Registers a new ObjectClass with this registry.

Specified by:
register in interface ObjectClassRegistry
Specified by:
register in interface SchemaObjectRegistry<ObjectClass>
Parameters:
objectClass - the ObjectClass to register
Throws:
LdapException - if the ObjectClass is already registered or the registration operation is not supported

unregister

public ObjectClass unregister(java.lang.String numericOid)
                       throws LdapException
Removes the ObjectClass registered with this registry.

Specified by:
unregister in interface ObjectClassRegistry
Specified by:
unregister in interface SchemaObjectRegistry<ObjectClass>
Parameters:
numericOid - the numeric identifier
Throws:
LdapException - if the numeric identifier is invalid

copy

public ImmutableObjectClassRegistry copy()
Clone the ObjectClassRegistry

Specified by:
copy in interface ObjectClassRegistry
Specified by:
copy in interface SchemaObjectRegistry<ObjectClass>
Returns:
SchemaObjectRegistry The copied registry

size

public int size()

Specified by:
size in interface SchemaObjectRegistry<ObjectClass>
Returns:
The number of AttributeType stored

contains

public boolean contains(java.lang.String oid)
Checks to see if an SchemaObject exists in the registry, by its OID or name.

Specified by:
contains in interface SchemaObjectRegistry<ObjectClass>
Parameters:
oid - the object identifier or name of the SchemaObject
Returns:
true if a SchemaObject definition exists for the oid, false otherwise

getOidByName

public java.lang.String getOidByName(java.lang.String name)
                              throws LdapException
Gets the numericOid for a name/alias if one is associated. To prevent lookup failures due to case variance in the name, a failure to lookup the OID, will trigger a lookup using a lower cased version of the name and the name that failed to match will automatically be associated with the OID.

Specified by:
getOidByName in interface SchemaObjectRegistry<ObjectClass>
Parameters:
name - The name we are looking the oid for
Returns:
The numericOID associated with this name
Throws:
LdapException - If the OID can't be found

getSchemaName

public java.lang.String getSchemaName(java.lang.String oid)
                               throws LdapException
Gets the name of the schema this schema object is associated with.

Specified by:
getSchemaName in interface SchemaObjectRegistry<ObjectClass>
Returns:
the schema name
Throws:
LdapException - if the schema object does not exist

getType

public SchemaObjectType getType()

Specified by:
getType in interface SchemaObjectRegistry<ObjectClass>
Returns:
the type

iterator

public java.util.Iterator<ObjectClass> iterator()
Gets an iterator over the registered schema objects in the registry.

Specified by:
iterator in interface java.lang.Iterable<ObjectClass>
Specified by:
iterator in interface SchemaObjectRegistry<ObjectClass>
Returns:
an Iterator of homogeneous schema objects

lookup

public ObjectClass lookup(java.lang.String oid)
                   throws LdapException
Looks up a SchemaObject by its unique Object Identifier or by name.

Specified by:
lookup in interface SchemaObjectRegistry<ObjectClass>
Parameters:
oid - the object identifier or name
Returns:
the SchemaObject instance for the id
Throws:
LdapException - if the SchemaObject does not exist

oidsIterator

public java.util.Iterator<java.lang.String> oidsIterator()
Gets an iterator over the registered schema objects'OID in the registry.

Specified by:
oidsIterator in interface SchemaObjectRegistry<ObjectClass>
Returns:
an Iterator of OIDs

renameSchema

public void renameSchema(java.lang.String originalSchemaName,
                         java.lang.String newSchemaName)
                  throws LdapException
Modify all the SchemaObject using a schemaName when this name changes.

Specified by:
renameSchema in interface SchemaObjectRegistry<ObjectClass>
Parameters:
originalSchemaName - The original Schema name
newSchemaName - The new Schema name
Throws:
LdapException - if the schema object does not exist

unregisterSchemaElements

public void unregisterSchemaElements(java.lang.String schemaName)
                              throws LdapException
Unregisters all SchemaObjects defined for a specific schema from this registry.

Specified by:
unregisterSchemaElements in interface SchemaObjectRegistry<ObjectClass>
Parameters:
schemaName - the name of the schema whose SchemaObjects will be removed from
Throws:
LdapException

get

public SchemaObject get(java.lang.String oid)
Gets the SchemaObject associated with a given OID.

Specified by:
get in interface SchemaObjectRegistry<ObjectClass>
Parameters:
oid - The SchemaObject's OID we are looking for
Returns:
The SchemaObject, if any. Null otherwise

clear

public void clear()
           throws LdapException
Clear the registry from all its content

Specified by:
clear in interface SchemaObjectRegistry<ObjectClass>
Throws:
LdapException

unregister

public ObjectClass unregister(ObjectClass schemaObject)
                       throws LdapException
Removes the SchemaObject registered with this registry.

Specified by:
unregister in interface SchemaObjectRegistry<ObjectClass>
Throws:
LdapException - if the schemaObject can't be unregistered is invalid


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.