org.opends.server.admin.std.meta
Class EqualityMatchingRuleCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<EqualityMatchingRuleCfgClient,EqualityMatchingRuleCfg>
          extended by org.opends.server.admin.std.meta.EqualityMatchingRuleCfgDefn

public final class EqualityMatchingRuleCfgDefn
extends ManagedObjectDefinition<EqualityMatchingRuleCfgClient,EqualityMatchingRuleCfg>

An interface for querying the Equality Matching Rule managed object definition meta information.

Equality Matching Rules define a set of rules for performing equality matching operations against assertion values (that is, to determine whether an attribute value equals an assertion value).


Method Summary
 EqualityMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends EqualityMatchingRuleCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 EqualityMatchingRuleCfg createServerConfiguration(ServerManagedObject<? extends EqualityMatchingRuleCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static EqualityMatchingRuleCfgDefn getInstance()
          Get the Equality Matching Rule configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<EqualityMatchingRuleCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 
Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getInstance

public static EqualityMatchingRuleCfgDefn getInstance()
Get the Equality Matching Rule configuration definition singleton.

Returns:
Returns the Equality Matching Rule configuration definition singleton.

createClientConfiguration

public EqualityMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends EqualityMatchingRuleCfgClient> impl)
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:
createClientConfiguration in class ManagedObjectDefinition<EqualityMatchingRuleCfgClient,EqualityMatchingRuleCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public EqualityMatchingRuleCfg createServerConfiguration(ServerManagedObject<? extends EqualityMatchingRuleCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<EqualityMatchingRuleCfgClient,EqualityMatchingRuleCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<EqualityMatchingRuleCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<EqualityMatchingRuleCfgClient,EqualityMatchingRuleCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the Equality Matching Rule is enabled for use.

Returns:
Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.

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

Returns:
Returns the "java-class" property definition.