org.opends.server.admin.std.server
Interface MatchingRuleCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
ApproximateMatchingRuleCfg, EqualityMatchingRuleCfg, OrderingMatchingRuleCfg, SubstringMatchingRuleCfg

public interface MatchingRuleCfg
extends Configuration

A server-side interface for querying Matching Rule settings.

Matching Rules define a set of rules for performing matching operations against assertion values.


Method Summary
 void addChangeListener(ConfigurationChangeListener<MatchingRuleCfg> listener)
          Register to be notified when this Matching Rule is changed.
 java.lang.Class<? extends MatchingRuleCfg> configurationClass()
          Gets the configuration class associated with this Matching Rule.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<MatchingRuleCfg> listener)
          Deregister an existing Matching Rule configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends MatchingRuleCfg> configurationClass()
Gets the configuration class associated with this Matching Rule.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Matching Rule.

addChangeListener

void addChangeListener(ConfigurationChangeListener<MatchingRuleCfg> listener)
Register to be notified when this Matching Rule is changed.

Parameters:
listener - The Matching Rule configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<MatchingRuleCfg> listener)
Deregister an existing Matching Rule configuration change listener.

Parameters:
listener - The Matching Rule configuration change listener.

isEnabled

boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Matching Rule is enabled for use.

Returns:
Returns the value of the "enabled" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Matching Rule implementation.

Returns:
Returns the value of the "java-class" property.