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

Interface ExactMatchIdentityMapperCfgClient

All Superinterfaces:
ConfigurationClient, IdentityMapperCfgClient
public interface ExactMatchIdentityMapperCfgClient extends IdentityMapperCfgClient
A client-side interface for reading and modifying Exact Match Identity Mapper settings.

The Exact Match Identity Mapper maps an identifier string to user entries by searching for the entry containing a specified attribute whose value is the provided identifier. For example, the username provided by the client for DIGEST-MD5 authentication must match the value of the uid attribute

  • Method Details

    • definition

      ManagedObjectDefinition<? extends ExactMatchIdentityMapperCfgClient,? extends ExactMatchIdentityMapperCfg> definition()
      Get the configuration definition associated with this Exact Match Identity Mapper.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface IdentityMapperCfgClient
      Returns:
      Returns the configuration definition associated with this Exact Match Identity Mapper.

    • getJavaClass

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

      Specifies the fully-qualified name of the Java class that provides the Exact Match Identity Mapper implementation.

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

      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 Exact Match 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 attribute whose value should exactly match the ID string provided to this identity mapper.

      At least one value must be provided. 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. The internal search performed includes a logical OR across all of these values.

      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 attribute whose value should exactly match the ID string provided to this identity mapper.

      At least one value must be provided. 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. The internal search performed includes a logical OR across all of these values.

      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 set of base DNs below which to search for users.

      The base DNs will 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 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 set of base DNs below which to search for users.

      The base DNs will 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 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.