org.opends.server.admin.std.meta

Class MatchingRuleCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<MatchingRuleCfgClient,MatchingRuleCfg>

org.opends.server.admin.std.meta.MatchingRuleCfgDefn

public final class MatchingRuleCfgDefn
extends ManagedObjectDefinition<MatchingRuleCfgClient,MatchingRuleCfg>

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

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

Method Summary

Methods

Modifier and Type	Method and Description
MatchingRuleCfgClient	createClientConfiguration(ManagedObject<? extends MatchingRuleCfgClient> impl) Creates a client configuration view of the provided managed object.
MatchingRuleCfg	createServerConfiguration(ServerManagedObject<? extends MatchingRuleCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static MatchingRuleCfgDefn	getInstance() Get the Matching Rule configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
Class<MatchingRuleCfg>	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 MatchingRuleCfgDefn getInstance()

Get the Matching Rule configuration definition singleton.

Returns:

Returns the Matching Rule configuration definition singleton.

createClientConfiguration

public MatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends MatchingRuleCfgClient> 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<MatchingRuleCfgClient,MatchingRuleCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public MatchingRuleCfg createServerConfiguration(ServerManagedObject<? extends MatchingRuleCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<MatchingRuleCfgClient,MatchingRuleCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<MatchingRuleCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<MatchingRuleCfgClient,MatchingRuleCfg>

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 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 Matching Rule implementation.

Returns:

Returns the "java-class" property definition.