org.dmd.dmr.server.ldap.util

Class LDAPSchemaExtension

java.lang.Object

org.dmd.dmr.server.ldap.util.LDAPSchemaExtension

All Implemented Interfaces:

SchemaExtensionIF

public class LDAPSchemaExtension
extends Object
implements SchemaExtensionIF

The LDAPSchemaExtension class provides additional rule checking for objects that you intend to store in an LDAP enabled directory server. As well, it decorates attribute and class definitions with additional information required when storing objects in a directory server.

Constructor Summary

Constructors

Constructor and Description
LDAPSchemaExtension()

Method Summary

Modifier and Type	Method and Description
void	addAction(ActionDefinition def) This method will be called when an action is added to the schema manager.
void	addAttribute(AttributeDefinition def) This method will be called when an attribute is added to the schema manager.
void	addClass(ClassDefinition def) This method will be called when a class is added to the schema manager.
void	addEnum(EnumDefinition def) This method will be called when an enum is added to the schema manager.
void	addSchema(SchemaDefinition def) This method will be called when a schema is added to the schema manager.
void	addType(TypeDefinition def) This method will be called when a type is added to the schema manager.
void	definitionPreAdd(DmcUncheckedObject uco) This method is called whenever we're about to add the specified definition to a schema.
SchemaDefinition	getExtensionSchema() This methods allows the schema manager to access and manage the schema of the the schema extension.
void	schemaBeingLoaded(SchemaDefinition sd) This method is called whenever we're about to start loading definitions from the specified schema.
void	setManager(SchemaManager sm) This method will be called when the implementing class is first instantiated so that it has a handle to the schema manager with which its associated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPSchemaExtension

public LDAPSchemaExtension()

Method Detail

addAction

public void addAction(ActionDefinition def)
               throws ResultException,
                      DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when an action is added to the schema manager.

Specified by:

addAction in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addAttribute

public void addAttribute(AttributeDefinition def)
                  throws ResultException,
                         DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when an attribute is added to the schema manager.

Specified by:

addAttribute in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addClass

public void addClass(ClassDefinition def)
              throws ResultException,
                     DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when a class is added to the schema manager.

Specified by:

addClass in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addEnum

public void addEnum(EnumDefinition def)
             throws ResultException,
                    DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when an enum is added to the schema manager.

Specified by:

addEnum in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addSchema

public void addSchema(SchemaDefinition def)
               throws ResultException,
                      DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when a schema is added to the schema manager.

Specified by:

addSchema in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addType

public void addType(TypeDefinition def)
             throws ResultException,
                    DmcValueException

Description copied from interface: SchemaExtensionIF

This method will be called when a type is added to the schema manager.

Specified by:

addType in interface SchemaExtensionIF

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

setManager

public void setManager(SchemaManager sm)

Description copied from interface: SchemaExtensionIF

This method will be called when the implementing class is first instantiated so that it has a handle to the schema manager with which its associated.

Specified by:

setManager in interface SchemaExtensionIF

Parameters:

sm - The schema manager.

schemaBeingLoaded

public void schemaBeingLoaded(SchemaDefinition sd)
                       throws ResultException

Description copied from interface: SchemaExtensionIF

This method is called whenever we're about to start loading definitions from the specified schema.

Specified by:

schemaBeingLoaded in interface SchemaExtensionIF

Parameters:

sd - The schema definition.

Throws:

ResultException

definitionPreAdd

public void definitionPreAdd(DmcUncheckedObject uco)
                      throws DmcValueException

Description copied from interface: SchemaExtensionIF

This method is called whenever we're about to add the specified definition to a schema. This gives us the opportunity to decorate the definition with the appropriate auxiliary classes for the definition in question. This prevents having to explicitly add the AUX classes to our schema definitions. They are added for us automatically by the schema extension.

Specified by:

definitionPreAdd in interface SchemaExtensionIF

Throws:

DmcValueException

getExtensionSchema

public SchemaDefinition getExtensionSchema()

Description copied from interface: SchemaExtensionIF

This methods allows the schema manager to access and manage the schema of the the schema extension.

Specified by:

getExtensionSchema in interface SchemaExtensionIF

Returns:

The schema extension's schema.