Package org.forgerock.openam.authentication.modules.common.mapping

Interface AttributeMapper<T>

Type Parameters:
T - The type of source.
@SupportedAll public interface AttributeMapper<T>
Translates from a source to a map of attributes.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Set<String>>
    getAttributes(Map<String,String> attributeMapConfiguration, T source)
    Maps from values found in the source to a map of keys in the result, according to a provided map of keys in the source to keys in the result.
    void
    init(String bundleName)
    Initialise the instance for i18n.

  • Method Details

    • init

      void init(String bundleName)
      Initialise the instance for i18n.
      Parameters:
      bundleName - The name of the bundle for exceptions thrown by the getAttributes method.

    • getAttributes

      Map<String,Set<String>> getAttributes(Map<String,String> attributeMapConfiguration, T source) throws AuthLoginException
      Maps from values found in the source to a map of keys in the result, according to a provided map of keys in the source to keys in the result.
      Parameters:
      attributeMapConfiguration - The map of keys in the source to keys in the result.
      source - The source of values.
      Returns:
      A map of attribute keys to values found.
      Throws:
      AuthLoginException - If there was an error while retrieving the user attributes.