Package org.forgerock.opendj.server.config.meta

Class JsonOrderingMatchingRuleCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<JsonOrderingMatchingRuleCfgClient,JsonOrderingMatchingRuleCfg>
org.forgerock.opendj.server.config.meta.JsonOrderingMatchingRuleCfgDefn
public final class JsonOrderingMatchingRuleCfgDefn extends ManagedObjectDefinition<JsonOrderingMatchingRuleCfgClient,JsonOrderingMatchingRuleCfg>
An interface for querying the JSON Ordering Matching Rule managed object definition meta information.

JSON Ordering Matching Rules determine the relative order of two JSON values using a custom set of rules.

  • Method Details

    • getInstance

      public static JsonOrderingMatchingRuleCfgDefn getInstance()
      Get the JSON Ordering Matching Rule configuration definition singleton.
      Returns:
      Returns the JSON Ordering Matching Rule configuration definition singleton.

    • createClientConfiguration

      public JsonOrderingMatchingRuleCfgClient createClientConfiguration(ManagedObject<? extends JsonOrderingMatchingRuleCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      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<JsonOrderingMatchingRuleCfgClient,JsonOrderingMatchingRuleCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public JsonOrderingMatchingRuleCfg createServerConfiguration(ServerManagedObject<? extends JsonOrderingMatchingRuleCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<JsonOrderingMatchingRuleCfgClient,JsonOrderingMatchingRuleCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<JsonOrderingMatchingRuleCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<JsonOrderingMatchingRuleCfgClient,JsonOrderingMatchingRuleCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getCaseSensitiveStringsPropertyDefinition

      public BooleanPropertyDefinition getCaseSensitiveStringsPropertyDefinition()
      Get the "case-sensitive-strings" property definition.

      Indicates whether JSON string comparisons should be case-sensitive.

      Returns:
      Returns the "case-sensitive-strings" property definition.

    • getEnabledPropertyDefinition

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

      Indicates whether the JSON Ordering Matching Rule is enabled for use.

      Returns:
      Returns the "enabled" property definition.

    • getIgnoreWhiteSpacePropertyDefinition

      public BooleanPropertyDefinition getIgnoreWhiteSpacePropertyDefinition()
      Get the "ignore-white-space" property definition.

      Indicates whether JSON string comparisons should ignore white space.

      When enabled, all leading and trailing white space will be removed and intermediate white space will be reduced to a single character.

      Returns:
      Returns the "ignore-white-space" property definition.

    • getJavaClassPropertyDefinition

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

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

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

    • getJsonKeysPropertyDefinition

      public StringPropertyDefinition getJsonKeysPropertyDefinition()
      Get the "json-keys" property definition.

      Specifies which JSON fields should be compared in order to determine the relative order of two JSON objects

      This parameter is a list of space-delimited JSON pointers.

      Returns:
      Returns the "json-keys" property definition.

    • getMatchingRuleNamePropertyDefinition

      public StringPropertyDefinition getMatchingRuleNamePropertyDefinition()
      Get the "matching-rule-name" property definition.

      The name of the custom JSON matching rule.

      Returns:
      Returns the "matching-rule-name" property definition.

    • getMatchingRuleOidPropertyDefinition

      public StringPropertyDefinition getMatchingRuleOidPropertyDefinition()
      Get the "matching-rule-oid" property definition.

      The numeric OID of the custom JSON matching rule.

      Returns:
      Returns the "matching-rule-oid" property definition.