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

Interface RegistrySynchronizer

All Known Implementing Classes:

AbstractRegistrySynchronizer, AttributeTypeSynchronizer, ComparatorSynchronizer, DitContentRuleSynchronizer, DitStructureRuleSynchronizer, MatchingRuleSynchronizer, MatchingRuleUseSynchronizer, NameFormSynchronizer, NormalizerSynchronizer, ObjectClassSynchronizer, SchemaSynchronizer, SyntaxCheckerSynchronizer, SyntaxSynchronizer

public interface RegistrySynchronizer

Interface used to detect and react to changes performed on schema entities to update registries so they're synchronized with entries on disk.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	SCHEMA_MODIFIED A constant to tell the caller that the schema has been modified
static boolean	SCHEMA_UNCHANGED A constant to tell the caller that the schema has not been modified

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.directory.api.ldap.model.entry.Entry entry) Adds a new SchemaObject to its registry
void	delete(org.apache.directory.api.ldap.model.entry.Entry entry, boolean cascaded) Delete the schema object and update the registries
boolean	modify(ModifyOperationContext modifyContext, org.apache.directory.api.ldap.model.entry.Entry targetEntry, boolean cascaded) Applies a set of modification to an entry
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 cascaded)
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	rename(org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean cascaded) Rename a schemaObject.

Field Detail

SCHEMA_MODIFIED

static final boolean SCHEMA_MODIFIED

A constant to tell the caller that the schema has been modified

See Also:

Constant Field Values

SCHEMA_UNCHANGED

static final boolean SCHEMA_UNCHANGED

A constant to tell the caller that the schema has not been modified

See Also:

Constant Field Values

Method Detail

add

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

Adds a new SchemaObject to its registry

Parameters:

entry - The SchemObject to add

Throws:

java.lang.Exception - If the addition failed

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

delete

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

Delete the schema object and update the registries

Parameters:

entry - The entry associated with the SchemaObject to delete

cascaded - unused

Throws:

java.lang.Exception - If the deletion failed

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

rename

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

Rename a schemaObject. It is not supposed to have any child

Parameters:

entry - The entry to be renamed

newRdn - The new entry name

cascaded - unused

Throws:

java.lang.Exception - If the rename failed

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

modify

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

Applies a set of modification to an entry

Parameters:

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

targetEntry - The modified entry

cascaded - Unused

Returns:

True if the modification has been done

Throws:

java.lang.Exception - If the modification failed

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

moveAndRename

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

Throws:

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

move

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 cascaded)
   throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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