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

java.lang.Object
  org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      org.opends.server.admin.ManagedObjectDefinition<SubstringMatchingRuleCfgClient,SubstringMatchingRuleCfg>
          org.opends.server.admin.std.meta.SubstringMatchingRuleCfgDefn

public final class SubstringMatchingRuleCfgDefn
extends ManagedObjectDefinition<SubstringMatchingRuleCfgClient,SubstringMatchingRuleCfg>

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

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

Method Summary

SubstringMatchingRuleCfgClient	createClientConfiguration(ManagedObject<? extends SubstringMatchingRuleCfgClient> impl) Creates a client configuration view of the provided managed object.
SubstringMatchingRuleCfg	createServerConfiguration(ServerManagedObject<? extends SubstringMatchingRuleCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static SubstringMatchingRuleCfgDefn	getInstance() Get the Substring Matching Rule configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
java.lang.Class<SubstringMatchingRuleCfg>	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 SubstringMatchingRuleCfgDefn getInstance()

Get the Substring Matching Rule configuration definition singleton.

Returns:

Returns the Substring Matching Rule configuration definition singleton.

createClientConfiguration

public SubstringMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends SubstringMatchingRuleCfgClient> 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<SubstringMatchingRuleCfgClient,SubstringMatchingRuleCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SubstringMatchingRuleCfgClient,SubstringMatchingRuleCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public java.lang.Class<SubstringMatchingRuleCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SubstringMatchingRuleCfgClient,SubstringMatchingRuleCfg>

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

Returns:

Returns the "java-class" property definition.