org.apache.directory.shared.ldap.schema

Interface SchemaDao

public interface SchemaDao

Method Summary

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

Method Detail

getSchemas

Map<String,Schema> getSchemas()
                       throws Exception

Gets a Map of Schemas managed by a schema store.

Returns:

a Map of Schemas using the name of the Schema as the key

Throws:

Exception - if there is some problem accessing the schema data

getSchemaNames

Set<String> getSchemaNames()
                    throws Exception

Throws:

Exception

getSchema

Schema getSchema(String schemaName)
          throws Exception

Throws:

Exception

hasMatchingRule

boolean hasMatchingRule(String oid)
                 throws Exception

Throws:

Exception

hasAttributeType

boolean hasAttributeType(String oid)
                  throws Exception

Throws:

Exception

hasObjectClass

boolean hasObjectClass(String oid)
                throws Exception

Throws:

Exception

hasSyntax

boolean hasSyntax(String oid)
           throws Exception

Throws:

Exception

hasSyntaxChecker

boolean hasSyntaxChecker(String oid)
                  throws Exception

Throws:

Exception

findSchema

String findSchema(String entityName)
           throws Exception

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.

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:

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

Exception

findDn

DN findDn(String entityName)
   throws Exception

Throws:

Exception

find

Entry find(String entityName)
    throws Exception

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.

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:

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

Exception

enableSchema

void enableSchema(String schemaName)
           throws Exception

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.

Parameters:

schemaName - the name of the schema to enable

Throws:

LdapException - if there is a problem updating the schema entry

Exception

listSyntaxDependents

Set<Entry> listSyntaxDependents(String numericOid)
                         throws Exception

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

Parameters:

numericOid - the numeric identifier for the entity

Returns:

the set of matchingRules and attributeTypes depending on a syntax

Throws:

LdapException - if the dao fails to perform search operations

Exception

listMatchingRuleDependents

Set<Entry> listMatchingRuleDependents(MatchingRule mr)
                               throws Exception

Throws:

Exception

listAttributeTypeDependents

Set<Entry> listAttributeTypeDependents(AttributeType at)
                                throws Exception

Throws:

Exception

listSchemaDependents

Set<Entry> listSchemaDependents(String schemaName)
                         throws Exception

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

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:

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

Exception

listEnabledSchemaDependents

Set<Entry> listEnabledSchemaDependents(String schemaName)
                                throws Exception

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

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:

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

Exception

listObjectClassDependents

Set<Entry> listObjectClassDependents(ObjectClass oc)
                              throws Exception

Throws:

Exception