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

All Known Implementing Classes:
BootstrapMatchingRuleUseRegistry, GlobalMatchingRuleUseRegistry

public interface MatchingRuleUseRegistry

A MatchingRuleUse registry service interface. MatchingRuleUse objects are special in that they do not have unique OID's specifically assigned to them. Their OID is really the OID of the MatchingRule they refer to.

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

Method Summary
 java.lang.String getSchemaName(java.lang.String name)
          Gets the name of the schema this schema object is associated with.
 boolean hasMatchingRuleUse(java.lang.String name)
          Checks to see if an matchingRuleUse exists.
 java.util.Iterator list()
          Lists all the MatchingRuleUses within this registry.
 org.apache.directory.shared.ldap.schema.MatchingRuleUse lookup(java.lang.String name)
          Looks up an matchingRuleUse by its name.
 void register(java.lang.String schema, org.apache.directory.shared.ldap.schema.MatchingRuleUse matchingRuleUse)
          Registers a MatchingRuleUse with this registry.
 

Method Detail

register

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

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

lookup

org.apache.directory.shared.ldap.schema.MatchingRuleUse lookup(java.lang.String name)
                                                               throws javax.naming.NamingException
Looks up an matchingRuleUse by its name.

Parameters:
name - the name of the matchingRuleUse
Returns:
the MatchingRuleUse instance for the name
Throws:
javax.naming.NamingException - if the MatchingRuleUse does not exist

getSchemaName

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

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

hasMatchingRuleUse

boolean hasMatchingRuleUse(java.lang.String name)
Checks to see if an matchingRuleUse exists.

Parameters:
name - the name of the matchingRuleUse
Returns:
true if an matchingRuleUse definition exists for the name, false otherwise

list

java.util.Iterator list()
Lists all the MatchingRuleUses within this registry.

Returns:
an Iterator over all the MatchingRuleUses within this registry


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