org.apache.directory.server.core.schema
Interface MatchingRuleRegistry

All Known Implementing Classes:
BootstrapMatchingRuleRegistry, GlobalMatchingRuleRegistry

public interface MatchingRuleRegistry

A registry used to track system matchingRules.

Version:
$Rev: 434579 $
Author:
Apache Directory Project

Method Summary
 java.lang.String getSchemaName(java.lang.String id)
          Gets the name of the schema this schema object is associated with.
 boolean hasMatchingRule(java.lang.String oid)
          Checks to see if a MatchingRule exists.
 java.util.Iterator list()
          Gets an Iterator over the MatchingRules within this registry.
 org.apache.directory.shared.ldap.schema.MatchingRule lookup(java.lang.String id)
          Looks up a MatchingRule by its unique Object Identifier or by name.
 void register(java.lang.String schema, org.apache.directory.shared.ldap.schema.MatchingRule matchingRule)
          Registers a MatchingRule with this registry.
 

Method Detail

register

void register(java.lang.String schema,
              org.apache.directory.shared.ldap.schema.MatchingRule matchingRule)
              throws javax.naming.NamingException
Registers a MatchingRule with this registry.

Parameters:
schema - the name of the schema the MatchingRule is associated with
matchingRule - the MatchingRule to register
Throws:
javax.naming.NamingException - if the matchingRule is already registered or the registration operation is not supported

lookup

org.apache.directory.shared.ldap.schema.MatchingRule lookup(java.lang.String id)
                                                            throws javax.naming.NamingException
Looks up a MatchingRule by its unique Object Identifier or by name.

Parameters:
id - the object identifier or the name identifier
Returns:
the MatchingRule for the id
Throws:
javax.naming.NamingException - if there is a backing store failure or the MatchingRule does not exist.

getSchemaName

java.lang.String getSchemaName(java.lang.String id)
                               throws javax.naming.NamingException
Gets the name of the schema this schema object is associated with.

Parameters:
id - the object identifier or the name
Returns:
the schema name
Throws:
javax.naming.NamingException - if the schema object does not exist

hasMatchingRule

boolean hasMatchingRule(java.lang.String oid)
Checks to see if a MatchingRule exists. Backing store failures simply return false.

Parameters:
oid - the object identifier
Returns:
true if a MatchingRule definition exists for the oid, false otherwise

list

java.util.Iterator list()
Gets an Iterator over the MatchingRules within this registry.

Returns:
an iterator over all MatchingRules in registry


Copyright © 2003-2012 Apache Software Foundation. All Rights Reserved.