org.apache.directory.server.schema.registries
Interface DITStructureRuleRegistry

All Superinterfaces:

SchemaObjectRegistry

All Known Implementing Classes:

DefaultDitStructureRuleRegistry

public interface DITStructureRuleRegistry
extends SchemaObjectRegistry

An DITStructureRule registry service interface.

Version:

$Rev: 504284 $

Author:

Apache Directory Project

Method Summary

java.lang.String	getSchemaName(java.lang.Integer ruleId) Gets the schema name for a DITStructureRule using the rule identifier.
boolean	hasDITStructureRule(java.lang.Integer ruleId) Checks to see if an dITStructureRule exists using the rule identifier.
boolean	hasDITStructureRule(java.lang.String id) Checks to see if an dITStructureRule exists using the object identifier of the nameForm appended with the rule identifier of the DITStructureRule.
java.util.Iterator<org.apache.directory.shared.ldap.schema.DITStructureRule>	iterator() Lists all the DITStructureRules within this registry.
org.apache.directory.shared.ldap.schema.DITStructureRule	lookup(java.lang.Integer ruleId) Looks up an dITStructureRule by its unique Object IDentifier or by its name.
org.apache.directory.shared.ldap.schema.DITStructureRule	lookup(java.lang.String id) Looks up an dITStructureRule using a composite key composed of the nameForm object identifier with a DOT and the rule id of the DITStructureRule appended to it.
void	register(org.apache.directory.shared.ldap.schema.DITStructureRule dITStructureRule) Registers a DITStructureRule with this registry.
void	unregister(java.lang.Integer ruleId) Unregisters a DITStructureRule using it's rule identifier.

Methods inherited from interface org.apache.directory.server.schema.registries.SchemaObjectRegistry

getSchemaName, unregister

Method Detail

register

void register(org.apache.directory.shared.ldap.schema.DITStructureRule dITStructureRule)
              throws javax.naming.NamingException

Registers a DITStructureRule with this registry.

Parameters:

dITStructureRule - the dITStructureRule to register

Throws:

javax.naming.NamingException - if the DITStructureRule is already registered or the registration operation is not supported

lookup

org.apache.directory.shared.ldap.schema.DITStructureRule lookup(java.lang.String id)
                                                                throws javax.naming.NamingException

Looks up an dITStructureRule using a composite key composed of the nameForm object identifier with a DOT and the rule id of the DITStructureRule appended to it. If the name form object identifier is 1.2.3.4 and the rule identifier is 5 then the OID used for the lookup is 1.2.3.4.5.

Parameters:

id - the nameForm object identifier with rule identifier appended

Returns:

the DITStructureRule instance for the id

Throws:

javax.naming.NamingException - if the DITStructureRule does not exist

lookup

org.apache.directory.shared.ldap.schema.DITStructureRule lookup(java.lang.Integer ruleId)
                                                                throws javax.naming.NamingException

Looks up an dITStructureRule by its unique Object IDentifier or by its name.

Parameters:

ruleId - the rule identifier for the DITStructureRule

Returns:

the DITStructureRule instance for rule identifier

Throws:

javax.naming.NamingException - if the DITStructureRule does not exist

hasDITStructureRule

boolean hasDITStructureRule(java.lang.String id)

Checks to see if an dITStructureRule exists using the object identifier of the nameForm appended with the rule identifier of the DITStructureRule.

Parameters:

id - the object identifier of the nameForm with the rule Id appended

Returns:

true if an dITStructureRule definition exists for the id, false otherwise

hasDITStructureRule

boolean hasDITStructureRule(java.lang.Integer ruleId)

Checks to see if an dITStructureRule exists using the rule identifier.

Parameters:

ruleId - the rule identifier for the DITStructureRule.

Returns:

true if an dITStructureRule definition exists for the id, false otherwise

unregister

void unregister(java.lang.Integer ruleId)
                throws javax.naming.NamingException

Unregisters a DITStructureRule using it's rule identifier.

Parameters:

ruleId - the rule identifier for the DITStructureRule to unregister

Throws:

javax.naming.NamingException - if no such DITStructureRule exists

getSchemaName

java.lang.String getSchemaName(java.lang.Integer ruleId)
                               throws javax.naming.NamingException

Gets the schema name for a DITStructureRule using the rule identifier.

Parameters:

ruleId - the rule identifier for the DITStructureRule

Returns:

the schema name for the DITStructureRule

Throws:

javax.naming.NamingException - if no such rule could be found

iterator

java.util.Iterator<org.apache.directory.shared.ldap.schema.DITStructureRule> iterator()

Lists all the DITStructureRules within this registry.

Specified by:

iterator in interface SchemaObjectRegistry

Returns:

an Iterator over all the DITStructureRules within this registry