org.apache.directory.server.core.schema

Class SchemaPartitionDaoImpl

java.lang.Object

org.apache.directory.server.core.schema.SchemaPartitionDaoImpl

All Implemented Interfaces:

SchemaPartitionDao

public class SchemaPartitionDaoImpl
extends Object
implements SchemaPartitionDao

A specialized data access object for managing schema objects in the schema partition. WARNING: This dao operates directly on a partition. Hence no interceptors are available to perform the various expected services of respective interceptors. Take care to normalize all filters and distinguished names. A single write operation exists for enabling schemas needed for operating indices in partitions and enabling schemas that are dependencies of other schemas that are enabled. In both these limited cases there is no need to worry about issues with a lack of replication propagation because these same updates will take place on replicas when the original operation is propagated or when replicas start up.

Version:

$Rev$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SchemaPartitionDaoImpl(Partition partition, org.apache.directory.shared.ldap.schema.SchemaManager schemaManager) Creates a schema dao object backing information within a schema partition.

Method Summary

Methods

Modifier and Type	Method and Description
void	enableSchema(String schemaName) Enables a schema by removing it's m-disabled attribute if present.
org.apache.directory.shared.ldap.entry.ServerEntry	find(String entityName) Given the non-normalized name (alias) or the OID for a schema entity.
org.apache.directory.shared.ldap.name.DN	findDn(String entityName)
String	findSchema(String entityName) Given the non-normalized name (alias) or the OID for a schema entity.
org.apache.directory.shared.ldap.schema.registries.Schema	getSchema(String schemaName)
Set<String>	getSchemaNames()
Map<String,org.apache.directory.shared.ldap.schema.registries.Schema>	getSchemas()
boolean	hasAttributeType(String oid)
boolean	hasMatchingRule(String oid)
boolean	hasObjectClass(String oid)
boolean	hasSyntax(String oid)
boolean	hasSyntaxChecker(String oid)
EntryFilteringCursor	listAllNames()
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listAttributeTypeDependents(org.apache.directory.shared.ldap.schema.AttributeType at)
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listEnabledSchemaDependents(String schemaName) Lists the SearchResults of metaSchema objects that depend on a schema.
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listMatchingRuleDependents(org.apache.directory.shared.ldap.schema.MatchingRule mr)
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listObjectClassDependents(org.apache.directory.shared.ldap.schema.ObjectClass oc)
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listSchemaDependents(String schemaName) Lists the SearchResults of metaSchema objects that depend on a schema.
Set<org.apache.directory.shared.ldap.entry.ServerEntry>	listSyntaxDependents(String numericOid) Returns the set of matchingRules and attributeTypes which depend on the provided syntax.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaPartitionDaoImpl

public SchemaPartitionDaoImpl(Partition partition,
                      org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
                       throws Exception

Creates a schema dao object backing information within a schema partition.

Parameters:

partition - the schema partition

registries - the bootstrap registries that were used to start up the schema partition

Throws:

NamingException - if there are problems initializing this schema partion dao

Exception

Method Detail

getSchemas

public Map<String,org.apache.directory.shared.ldap.schema.registries.Schema> getSchemas()
                                                                                 throws Exception

Specified by:

getSchemas in interface SchemaPartitionDao

Throws:

Exception

getSchemaNames

public Set<String> getSchemaNames()
                           throws Exception

Specified by:

getSchemaNames in interface SchemaPartitionDao

Throws:

Exception

getSchema

public org.apache.directory.shared.ldap.schema.registries.Schema getSchema(String schemaName)
                                                                    throws Exception

Specified by:

getSchema in interface SchemaPartitionDao

Throws:

Exception

hasMatchingRule

public boolean hasMatchingRule(String oid)
                        throws Exception

Specified by:

hasMatchingRule in interface SchemaPartitionDao

Throws:

Exception

hasAttributeType

public boolean hasAttributeType(String oid)
                         throws Exception

Specified by:

hasAttributeType in interface SchemaPartitionDao

Throws:

Exception

hasObjectClass

public boolean hasObjectClass(String oid)
                       throws Exception

Specified by:

hasObjectClass in interface SchemaPartitionDao

Throws:

Exception

hasSyntax

public boolean hasSyntax(String oid)
                  throws Exception

Specified by:

hasSyntax in interface SchemaPartitionDao

Throws:

Exception

hasSyntaxChecker

public boolean hasSyntaxChecker(String oid)
                         throws Exception

Specified by:

hasSyntaxChecker in interface SchemaPartitionDao

Throws:

Exception

findSchema

public String findSchema(String entityName)
                  throws Exception

Description copied from interface: SchemaPartitionDao

Given the non-normalized name (alias) or the OID for a schema entity. This method finds the schema under which that entity is located. NOTE: this method presumes that all alias names across schemas are unique. This should be the case for LDAP but this can potentially be violated so we should make sure this is a unique name.

Specified by:

findSchema in interface SchemaPartitionDao

Parameters:

entityName - one of the names of the entity or it's numeric id

Returns:

the name of the schema that contains that entity or null if no entity with that alias name exists

Throws:

NamingException - if more than one entity has the name, or if there are underlying data access problems

Exception

findDn

public org.apache.directory.shared.ldap.name.DN findDn(String entityName)
                                                throws Exception

Specified by:

findDn in interface SchemaPartitionDao

Throws:

Exception

find

public org.apache.directory.shared.ldap.entry.ServerEntry find(String entityName)
                                                        throws Exception

Description copied from interface: SchemaPartitionDao

Given the non-normalized name (alias) or the OID for a schema entity. This method finds the entry of the schema entity. NOTE: this method presumes that all alias names across schemas are unique. This should be the case for LDAP but this can potentially be violated so we should make sure this is a unique name.

Specified by:

find in interface SchemaPartitionDao

Parameters:

entityName - one of the names of the entity or it's numeric id

Returns:

the search result for the entity or null if no such entity exists with that alias or numeric oid

Throws:

NamingException - if more than one entity has the name, or if there are underlying data access problems

Exception

enableSchema

public void enableSchema(String schemaName)
                  throws Exception

Description copied from interface: SchemaPartitionDao

Enables a schema by removing it's m-disabled attribute if present. NOTE: This is a write operation and great care must be taken to make sure it is used in a limited capacity. This method is called in two places currently. (1) Within the initialization sequence to enable schemas required for the correct operation of indices in other partitions. (2) Within the partition schema loader to auto enable schemas that are depended on by other schemas which are enabled. In both cases, the modifier is effectively the administrator since the server is performing the operation directly or on behalf of a user. In case (1) during intialization there is no other user involved so naturally the modifier is the administrator. In case (2) when a user enables a schema with a dependency that is not enabled the server enables that dependency on behalf of the user. Again effectively it is the server that is modifying the schema entry and hence the admin is the modifier. No need to worry about a lack of replication propagation in both cases. In case (1) all replicas will enable these schemas anyway on startup. In case (2) the original operation that enabled the schema depending on the on that enableSchema() is called for itself will be replicated. Hence the same chain reaction will occur in a replica.

Specified by:

enableSchema in interface SchemaPartitionDao

Parameters:

schemaName - the name of the schema to enable

Throws:

NamingException - if there is a problem updating the schema entry

Exception

listSyntaxDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listSyntaxDependents(String numericOid)
                                                                             throws Exception

Description copied from interface: SchemaPartitionDao

Returns the set of matchingRules and attributeTypes which depend on the provided syntax.

Specified by:

listSyntaxDependents in interface SchemaPartitionDao

Parameters:

numericOid - the numeric identifier for the entity

Returns:

the set of matchingRules and attributeTypes depending on a syntax

Throws:

NamingException - if the dao fails to perform search operations

Exception

listMatchingRuleDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listMatchingRuleDependents(org.apache.directory.shared.ldap.schema.MatchingRule mr)
                                                                                   throws Exception

Specified by:

listMatchingRuleDependents in interface SchemaPartitionDao

Throws:

Exception

listAllNames

public EntryFilteringCursor listAllNames()
                                  throws Exception

Specified by:

listAllNames in interface SchemaPartitionDao

Throws:

Exception

listAttributeTypeDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listAttributeTypeDependents(org.apache.directory.shared.ldap.schema.AttributeType at)
                                                                                    throws Exception

Specified by:

listAttributeTypeDependents in interface SchemaPartitionDao

Throws:

Exception

listSchemaDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listSchemaDependents(String schemaName)
                                                                             throws Exception

Description copied from interface: SchemaPartitionDao

Lists the SearchResults of metaSchema objects that depend on a schema.

Specified by:

listSchemaDependents in interface SchemaPartitionDao

Parameters:

schemaName - the name of the schema to search for dependees

Returns:

a set of SearchResults over the schemas whose m-dependency attribute contains schemaName

Throws:

NamingException - if there is a problem while searching the schema partition

Exception

listEnabledSchemaDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listEnabledSchemaDependents(String schemaName)
                                                                                    throws Exception

Description copied from interface: SchemaPartitionDao

Lists the SearchResults of metaSchema objects that depend on a schema.

Specified by:

listEnabledSchemaDependents in interface SchemaPartitionDao

Parameters:

schemaName - the name of the schema to search for dependencies

Returns:

a set of SearchResults over the schemas whose m-dependency attribute contains schemaName

Throws:

NamingException - if there is a problem while searching the schema partition

Exception

listObjectClassDependents

public Set<org.apache.directory.shared.ldap.entry.ServerEntry> listObjectClassDependents(org.apache.directory.shared.ldap.schema.ObjectClass oc)
                                                                                  throws Exception

Specified by:

listObjectClassDependents in interface SchemaPartitionDao

Throws:

Exception