org.dmd.dms

Interface SchemaExtensionIF

All Known Implementing Classes:

LDAPSchemaExtension

public interface SchemaExtensionIF

The SchemaExtensionIF interface should be implemented by classes that extend the basic SchemaManager to provide additional functionality associated with extensions to the basic Meta Schema. The intent of this mechanism is to prevent constant additions to the Meta Schema and allow you extend schema related information in any way you see fit.

Classes that implement this interface must have a zero argument constructor since they will be instantiated by the SchemaManager.

To make use of a schema extension, simply specify it in the schema you're defining, for example:

 SchemaDefinition
 name            someSchema
 schemaExtension org.dmd.dmr.server.ldap.util.LDAPSchemaExtension
 

Whenever a definition is added to the SchemaManager, either via the SchemaParser or when a schema is managed, all available schema extensions will be notified. This allows them to perform any additional error checking, augmentation of the definitions (for example via the addition of auxiliary classes) or any other behaviour that's required.

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.

Method Detail

setManager

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.

Parameters:

sm - The schema manager.

getExtensionSchema

SchemaDefinition getExtensionSchema()

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

Returns:

The schema extension's schema.

addAttribute

void addAttribute(AttributeDefinition def)
           throws ResultException,
                  DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addClass

void addClass(ClassDefinition def)
       throws ResultException,
              DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addType

void addType(TypeDefinition def)
      throws ResultException,
             DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addAction

void addAction(ActionDefinition def)
        throws ResultException,
               DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addEnum

void addEnum(EnumDefinition def)
      throws ResultException,
             DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

addSchema

void addSchema(SchemaDefinition def)
        throws ResultException,
               DmcValueException

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

Parameters:

def - The definition.

Throws:

ResultException

DmcValueException

schemaBeingLoaded

void schemaBeingLoaded(SchemaDefinition sd)
                throws ResultException

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

Parameters:

sd - The schema definition.

Throws:

ResultException

definitionPreAdd

void definitionPreAdd(DmcUncheckedObject uco)
               throws DmcValueException

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.

Parameters:

uco -

Throws:

DmcValueException