Package org.forgerock.opendj.server.config.client

Interface RegularExpressionIdentityMapperCfgClient

All Superinterfaces:
ConfigurationClient, IdentityMapperCfgClient
public interface RegularExpressionIdentityMapperCfgClient extends IdentityMapperCfgClient
A client-side interface for reading and modifying Regular Expression Identity Mapper settings.

The Regular Expression Identity Mapper provides a way to use a regular expression to translate the provided identifier when searching for the appropriate user entry.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends RegularExpressionIdentityMapperCfgClient,? extends RegularExpressionIdentityMapperCfg> definition()
      Get the configuration definition associated with this Regular Expression Identity Mapper.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface IdentityMapperCfgClient
      Returns:
      Returns the configuration definition associated with this Regular Expression Identity Mapper.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Regular Expression Identity Mapper implementation.

      Default value: org.opends.server.extensions.RegularExpressionIdentityMapper

      Specified by:
      getJavaClass in interface IdentityMapperCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Regular Expression Identity Mapper implementation.

      Specified by:
      setJavaClass in interface IdentityMapperCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getMatchAttribute

      @MandatoryProperty SortedSet<ValueOrExpression<AttributeType>> getMatchAttribute()
      Gets the "match-attribute" property.

      Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression.

      All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry.

      Default value: uid

      Returns:
      Returns the values of the "match-attribute" property.

    • setMatchAttribute

      @MandatoryProperty void setMatchAttribute(Collection<ValueOrExpression<AttributeType>> values) throws PropertyException
      Sets the "match-attribute" property.

      Specifies the name or OID of the attribute whose value should match the provided identifier string after it has been processed by the associated regular expression.

      All values must refer to the name or OID of an attribute type defined in the directory server schema. If multiple attributes or OIDs are provided, at least one of those attributes must contain the provided ID string value in exactly one entry.

      Parameters:
      values - The values of the "match-attribute" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getMatchBaseDn

      SortedSet<ValueOrExpression<Dn>> getMatchBaseDn()
      Gets the "match-base-dn" property.

      Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.

      Returns:
      Returns the values of the "match-base-dn" property.

    • setMatchBaseDn

      void setMatchBaseDn(Collection<ValueOrExpression<Dn>> values) throws PropertyException
      Sets the "match-base-dn" property.

      Specifies the base DN(s) that should be used when performing searches to map the provided ID string to a user entry. If multiple values are given, searches are performed below all the specified base DNs.

      Parameters:
      values - The values of the "match-base-dn" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getMatchPattern

      @MandatoryProperty ValueOrExpression<String> getMatchPattern()
      Gets the "match-pattern" property.

      Specifies the regular expression pattern that is used to identify portions of the ID string that will be replaced.

      Any portion of the ID string that matches this pattern is replaced in accordance with the provided replace pattern (or is removed if no replace pattern is specified). If multiple substrings within the given ID string match this pattern, all occurrences are replaced. If no part of the given ID string matches this pattern, the ID string is not altered. Exactly one match pattern value must be provided, and it must be a valid regular expression as described in the API documentation for the java.util.regex.Pattern class, including support for capturing groups.

      Returns:
      Returns the value of the "match-pattern" property.

    • setMatchPattern

      @MandatoryProperty void setMatchPattern(ValueOrExpression<String> value) throws PropertyException
      Sets the "match-pattern" property.

      Specifies the regular expression pattern that is used to identify portions of the ID string that will be replaced.

      Any portion of the ID string that matches this pattern is replaced in accordance with the provided replace pattern (or is removed if no replace pattern is specified). If multiple substrings within the given ID string match this pattern, all occurrences are replaced. If no part of the given ID string matches this pattern, the ID string is not altered. Exactly one match pattern value must be provided, and it must be a valid regular expression as described in the API documentation for the java.util.regex.Pattern class, including support for capturing groups.

      Parameters:
      value - The value of the "match-pattern" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getReplacePattern

      ValueOrExpression<String> getReplacePattern()
      Gets the "replace-pattern" property.

      Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern.

      If no replacement pattern is provided, then any matching portions of the ID string will be removed (i.e., replaced with an empty string). The replacement pattern may include a string from a capturing group by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used.

      Returns:
      Returns the value of the "replace-pattern" property.

    • setReplacePattern

      void setReplacePattern(ValueOrExpression<String> value) throws PropertyException
      Sets the "replace-pattern" property.

      Specifies the replacement pattern that should be used for substrings in the ID string that match the provided regular expression pattern.

      If no replacement pattern is provided, then any matching portions of the ID string will be removed (i.e., replaced with an empty string). The replacement pattern may include a string from a capturing group by using a dollar sign ($) followed by an integer value that indicates which capturing group should be used.

      Parameters:
      value - The value of the "replace-pattern" property.
      Throws:
      PropertyException - If the new value is invalid.