org.apache.directory.server.core.api.schema.registries.synchronizers

Class SchemaSynchronizer

java.lang.Object

org.apache.directory.server.core.api.schema.registries.synchronizers.SchemaSynchronizer

All Implemented Interfaces:

RegistrySynchronizer

public class SchemaSynchronizer
extends java.lang.Object
implements RegistrySynchronizer

This class handle modifications made on a global schema. Modifications made on SchemaObjects are handled by the specific shcemaObject synchronizers.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.AttributeType	cnAT The CN attributeType
private org.apache.directory.api.ldap.model.schema.AttributeType	dependenciesAT The m-dependencies AttributeType
private org.apache.directory.api.ldap.model.schema.AttributeType	disabledAT The m-disable AttributeType
private org.apache.directory.api.ldap.schema.loader.SchemaEntityFactory	factory
private static org.slf4j.Logger	LOG A logger for this class
private org.apache.directory.api.ldap.model.name.Dn	ouSchemaDn A static Dn referencing ou=schema
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager

Fields inherited from interface org.apache.directory.server.core.api.schema.registries.synchronizers.RegistrySynchronizer

SCHEMA_MODIFIED, SCHEMA_UNCHANGED

Constructor Summary

Constructors

Constructor and Description
SchemaSynchronizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates and initializes a new instance of Schema synchronizer

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.directory.api.ldap.model.entry.Entry entry) Handles the addition of a metaSchema object to the schema partition.
private void	checkForDependencies(boolean isEnabled, org.apache.directory.api.ldap.model.entry.Entry entry) Checks to make sure the dependencies either exist for disabled metaSchemas, or exist and are loaded (enabled) for enabled metaSchemas.
void	delete(org.apache.directory.api.ldap.model.entry.Entry entry, boolean cascade) Called to react to the deletion of a metaSchema object.
private boolean	disableSchema(java.lang.String schemaName)
private boolean	enableSchema(java.lang.String schemaName) Enabling a schema consist on switching all of its schema element to enable.
private java.lang.String	getSchemaName(org.apache.directory.api.ldap.model.name.Dn schema)
boolean	modify(ModifyOperationContext modifyContext, org.apache.directory.api.ldap.model.entry.Entry targetEntry, boolean cascade) The only modification done on a schema element is on the m-disabled attributeType Depending in the existence of this attribute in the previous entry, we will have to update the entry or not.
private boolean	modifyDisable(ModifyOperationContext modifyContext, org.apache.directory.api.ldap.model.entry.ModificationOperation modOp, org.apache.directory.api.ldap.model.entry.Attribute disabledInMods, org.apache.directory.api.ldap.model.entry.Attribute disabledInEntry) Modify the Disable flag (the flag can be set to true or false).
void	move(org.apache.directory.api.ldap.model.name.Dn oriChildName, org.apache.directory.api.ldap.model.name.Dn newParentName, org.apache.directory.api.ldap.model.entry.Entry entry, boolean cascade) Moves are not allowed for metaSchema objects so this always throws an UNWILLING_TO_PERFORM LdapException.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn oriChildName, org.apache.directory.api.ldap.model.name.Dn newParentName, org.apache.directory.api.ldap.model.name.Rdn newRn, boolean deleteOldRn, org.apache.directory.api.ldap.model.entry.Entry entry, boolean cascaded)
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn oriChildName, org.apache.directory.api.ldap.model.name.Dn newParentName, java.lang.String newRn, boolean deleteOldRn, org.apache.directory.api.ldap.model.entry.Entry entry, boolean cascade) Moves are not allowed for metaSchema objects so this always throws an UNWILLING_TO_PERFORM LdapException.
void	rename(org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean cascade) Responds to the rdn (commonName) of the metaSchema object being changed.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

A logger for this class

factory

private final org.apache.directory.api.ldap.schema.loader.SchemaEntityFactory factory

schemaManager

private final org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

disabledAT

private final org.apache.directory.api.ldap.model.schema.AttributeType disabledAT

The m-disable AttributeType

cnAT

private final org.apache.directory.api.ldap.model.schema.AttributeType cnAT

The CN attributeType

dependenciesAT

private final org.apache.directory.api.ldap.model.schema.AttributeType dependenciesAT

The m-dependencies AttributeType

ouSchemaDn

private final org.apache.directory.api.ldap.model.name.Dn ouSchemaDn

A static Dn referencing ou=schema

Constructor Detail

SchemaSynchronizer

public SchemaSynchronizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                   throws java.lang.Exception

Creates and initializes a new instance of Schema synchronizer

Parameters:

schemaManager - The server schemaManager

Throws:

java.lang.Exception - If something went wrong

Method Detail

modify

public boolean modify(ModifyOperationContext modifyContext,
                      org.apache.directory.api.ldap.model.entry.Entry targetEntry,
                      boolean cascade)
               throws org.apache.directory.api.ldap.model.exception.LdapException

The only modification done on a schema element is on the m-disabled attributeType Depending in the existence of this attribute in the previous entry, we will have to update the entry or not.

Specified by:

modify in interface RegistrySynchronizer

Parameters:

modifyContext - The OperationContext, which contains the entry and the modifications to apply

targetEntry - The modified entry

cascade - Unused

Returns:

True if the modification has been done

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn oriChildName,
                          org.apache.directory.api.ldap.model.name.Dn newParentName,
                          org.apache.directory.api.ldap.model.name.Rdn newRn,
                          boolean deleteOldRn,
                          org.apache.directory.api.ldap.model.entry.Entry entry,
                          boolean cascaded)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

moveAndRename in interface RegistrySynchronizer

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(org.apache.directory.api.ldap.model.entry.Entry entry)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Handles the addition of a metaSchema object to the schema partition.

Specified by:

add in interface RegistrySynchronizer

Parameters:

name - the dn of the new metaSchema object

entry - the attributes of the new metaSchema object

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public void delete(org.apache.directory.api.ldap.model.entry.Entry entry,
                   boolean cascade)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Called to react to the deletion of a metaSchema object. This method simply removes the schema from the loaded schema map of the global registries.

Specified by:

delete in interface RegistrySynchronizer

Parameters:

name - the dn of the metaSchema object being deleted

entry - the attributes of the metaSchema object

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(org.apache.directory.api.ldap.model.entry.Entry entry,
                   org.apache.directory.api.ldap.model.name.Rdn newRdn,
                   boolean cascade)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Responds to the rdn (commonName) of the metaSchema object being changed. Changes all the schema entities associated with the renamed schema so they now map to a new schema name.

Specified by:

rename in interface RegistrySynchronizer

Parameters:

name - the dn of the metaSchema object renamed

entry - the entry of the metaSchema object before the rename

newRdn - the new commonName of the metaSchema object

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(org.apache.directory.api.ldap.model.name.Dn oriChildName,
                          org.apache.directory.api.ldap.model.name.Dn newParentName,
                          java.lang.String newRn,
                          boolean deleteOldRn,
                          org.apache.directory.api.ldap.model.entry.Entry entry,
                          boolean cascade)
                   throws org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException

Moves are not allowed for metaSchema objects so this always throws an UNWILLING_TO_PERFORM LdapException.

Throws:

org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException

move

public void move(org.apache.directory.api.ldap.model.name.Dn oriChildName,
                 org.apache.directory.api.ldap.model.name.Dn newParentName,
                 org.apache.directory.api.ldap.model.entry.Entry entry,
                 boolean cascade)
          throws org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException

Moves are not allowed for metaSchema objects so this always throws an UNWILLING_TO_PERFORM LdapException.

Specified by:

move in interface RegistrySynchronizer

Throws:

org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException

modifyDisable

private boolean modifyDisable(ModifyOperationContext modifyContext,
                              org.apache.directory.api.ldap.model.entry.ModificationOperation modOp,
                              org.apache.directory.api.ldap.model.entry.Attribute disabledInMods,
                              org.apache.directory.api.ldap.model.entry.Attribute disabledInEntry)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Modify the Disable flag (the flag can be set to true or false). We can ADD, REMOVE or MODIFY this flag. The following matrix expose what will be the consequences of this operation, depending on the current state

                 +-------------------+--------------------+--------------------+
     op/state    |       TRUE        |       FALSE        |       ABSENT       |
 +-------+-------+----------------------------------------+--------------------+
 | ADD   | TRUE  | do nothing        | do nothing         | disable the schema |
 |       +-------+-------------------+--------------------+--------------------+
 |       | FALSE | do nothing        | do nothing         | do nothing         |
 +-------+-------+-------------------+--------------------+--------------------+
 |REMOVE | N/A   | enable the schema | do nothing         | do nothing         |
 +-------+-------+-------------------+--------------------+--------------------+
 |MODIFY | TRUE  | do nothing        | disable the schema | disable the schema |
 |       +-------+-------------------+--------------------+--------------------+
 |       | FALSE | enable the schema | do nothing         |  do nothing        |
 +-------+-------+-------------------+--------------------+--------------------+
 

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getSchemaName

private java.lang.String getSchemaName(org.apache.directory.api.ldap.model.name.Dn schema)

disableSchema

private boolean disableSchema(java.lang.String schemaName)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

enableSchema

private boolean enableSchema(java.lang.String schemaName)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Enabling a schema consist on switching all of its schema element to enable. We have to do it on a temporary registries.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

checkForDependencies

private void checkForDependencies(boolean isEnabled,
                                  org.apache.directory.api.ldap.model.entry.Entry entry)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Checks to make sure the dependencies either exist for disabled metaSchemas, or exist and are loaded (enabled) for enabled metaSchemas.

Parameters:

isEnabled - whether or not the new metaSchema is enabled

entry - the Attributes for the new metaSchema object

Throws:

NamingException - if the dependencies do not resolve or are not loaded (enabled)

org.apache.directory.api.ldap.model.exception.LdapException