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

Class AbstractRegistrySynchronizer

java.lang.Object

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

All Implemented Interfaces:

RegistrySynchronizer

Direct Known Subclasses:

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

public abstract class AbstractRegistrySynchronizer
extends java.lang.Object
implements RegistrySynchronizer

An abstract registry synchronizer with some reused functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.directory.api.ldap.schema.loader.SchemaEntityFactory	factory The Schema objetc factory
private static org.slf4j.Logger	LOG A logger for this class
protected org.apache.directory.api.ldap.model.schema.AttributeType	moidAT The m-oid AttributeType
private static java.util.Map<java.lang.String,java.lang.String>	OBJECT_TYPE_TO_PATH A map associating a SchemaObject type with its path on the partition
protected org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The global SchemaManager

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

SCHEMA_MODIFIED, SCHEMA_UNCHANGED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegistrySynchronizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Method Summary

Modifier and Type	Method and Description
protected void	addToSchema(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject, java.lang.String schemaName) Add a new SchemaObject to the schema content, assuming that it has an associated schema and that this schema is loaded
protected org.apache.directory.api.ldap.model.schema.SchemaObject	checkOidExists(org.apache.directory.api.ldap.model.entry.Entry entry) Check that a SchemaObject exists in the global OidRegsitry, and if so, return it.
protected void	checkOidIsUnique(org.apache.directory.api.ldap.model.entry.Entry entry)
protected void	checkOidIsUnique(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
protected void	checkOidIsUnique(java.lang.String oid)
protected void	checkParent(org.apache.directory.api.ldap.model.name.Dn newParent, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, java.lang.String objectType) Checks that the parent Dn is a valid Dn
protected void	deleteFromSchema(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject, java.lang.String schemaName) Delete a SchemaObject from the schema registry, assuming that it has an associated schema and that this schema is loaded
protected java.lang.String	getOid(org.apache.directory.api.ldap.model.entry.Entry entry)
protected java.util.Set<java.lang.String>	getOids(java.util.Set<org.apache.directory.api.ldap.model.entry.Entry> results)
protected java.lang.String	getReferenced(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject) Get a String containing the SchemaObjects referencing the given ShcemaObject
protected java.lang.String	getSchemaName(org.apache.directory.api.ldap.model.name.Dn dn) Exctract the schema name from the Dn.
protected boolean	isSchemaEnabled(java.lang.String schemaName) Tells if a schema is loaded and enabled
protected boolean	isSchemaLoaded(org.apache.directory.api.ldap.model.name.Dn dn) Tells if the schema the Dn references is loaded or not
protected boolean	isSchemaLoaded(java.lang.String schemaName) Tells if the schemaName is loaded or not
abstract boolean	modify(ModifyOperationContext modifyContext, org.apache.directory.api.ldap.model.entry.Entry targetEntry, boolean cascade) Applies a set of modification to an entry
protected void	registerOids(org.apache.directory.api.ldap.model.schema.SchemaObject obj) Register a SchemaObject's OID in the associated oidRegistry
protected void	unregisterOids(org.apache.directory.api.ldap.model.schema.SchemaObject obj) Unregister a SchemaObject's OID from the associated oidRegistry

Methods inherited from class java.lang.Object

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

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

add, delete, move, moveAndRename, rename

Field Detail

LOG

private static final org.slf4j.Logger LOG

A logger for this class

schemaManager

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

The global SchemaManager

moidAT

protected final org.apache.directory.api.ldap.model.schema.AttributeType moidAT

The m-oid AttributeType

factory

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

The Schema objetc factory

OBJECT_TYPE_TO_PATH

private static final java.util.Map<java.lang.String,java.lang.String> OBJECT_TYPE_TO_PATH

A map associating a SchemaObject type with its path on the partition

Constructor Detail

AbstractRegistrySynchronizer

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

Throws:

java.lang.Exception

Method Detail

isSchemaLoaded

protected boolean isSchemaLoaded(org.apache.directory.api.ldap.model.name.Dn dn)
                          throws java.lang.Exception

Tells if the schema the Dn references is loaded or not

Parameters:

dn - The SchemaObject's Dn

Returns:

true if the schema is loaded

Throws:

java.lang.Exception - If The Dn is not a SchemaObject Dn

isSchemaLoaded

protected boolean isSchemaLoaded(java.lang.String schemaName)

Tells if the schemaName is loaded or not

Parameters:

schemaName - The schema we want to check

Returns:

true if the schema is loaded

isSchemaEnabled

protected boolean isSchemaEnabled(java.lang.String schemaName)

Tells if a schema is loaded and enabled

Parameters:

schemaName - The schema we want to check

Returns:

true if the schema is loaded and enabled, false otherwise

getSchemaName

protected java.lang.String getSchemaName(org.apache.directory.api.ldap.model.name.Dn dn)
                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Exctract the schema name from the Dn. It is supposed to be the second Rdn in the dn :

 ou=schema, cn=MySchema, ...
 

Here, the schemaName is MySchema

Parameters:

dn - The Dn we want to get the schema name from

Returns:

The schema name

Throws:

NamingException - If we got an error

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

checkOidIsUnique

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

Throws:

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

checkOidExists

protected org.apache.directory.api.ldap.model.schema.SchemaObject checkOidExists(org.apache.directory.api.ldap.model.entry.Entry entry)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Check that a SchemaObject exists in the global OidRegsitry, and if so, return it.

Throws:

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

checkParent

protected void checkParent(org.apache.directory.api.ldap.model.name.Dn newParent,
                           org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                           java.lang.String objectType)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Checks that the parent Dn is a valid Dn

Throws:

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

checkOidIsUnique

protected void checkOidIsUnique(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
                         throws java.lang.Exception

Throws:

java.lang.Exception

checkOidIsUnique

protected void checkOidIsUnique(java.lang.String oid)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

addToSchema

protected void addToSchema(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject,
                           java.lang.String schemaName)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Add a new SchemaObject to the schema content, assuming that it has an associated schema and that this schema is loaded

Throws:

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

deleteFromSchema

protected void deleteFromSchema(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject,
                                java.lang.String schemaName)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Delete a SchemaObject from the schema registry, assuming that it has an associated schema and that this schema is loaded

Throws:

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

modify

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

Applies a set of modification to an entry

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

getOids

protected java.util.Set<java.lang.String> getOids(java.util.Set<org.apache.directory.api.ldap.model.entry.Entry> results)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getOid

protected java.lang.String getOid(org.apache.directory.api.ldap.model.entry.Entry entry)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

unregisterOids

protected void unregisterOids(org.apache.directory.api.ldap.model.schema.SchemaObject obj)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Unregister a SchemaObject's OID from the associated oidRegistry

Parameters:

obj - The SchemaObject to unregister

Throws:

java.lang.Exception - If the unregistering failed

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

registerOids

protected void registerOids(org.apache.directory.api.ldap.model.schema.SchemaObject obj)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Register a SchemaObject's OID in the associated oidRegistry

Parameters:

obj - The SchemaObject to register

Throws:

java.lang.Exception - If the registering failed

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

getReferenced

protected java.lang.String getReferenced(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)

Get a String containing the SchemaObjects referencing the given ShcemaObject

Parameters:

schemaObject - The SchemaObject we want the referencing SchemaObjects for

Returns:

A String containing all the SchemaObjects referencing the give SchemaObject