Package org.forgerock.openam.authentication.callbacks

Class ConsentMappingCallback

java.lang.Object
org.forgerock.openam.authentication.callbacks.ConsentMappingCallback
All Implemented Interfaces:
Serializable, Callback
@Supported public class ConsentMappingCallback extends Object implements Callback, Serializable
A callback to collect consent to share data with an external service declared by a mapping in IDM.
See Also:

  • Method Details

    • getName

      @Supported public String getName()
      Get the name of the mapping. This should not be displayed to the user.
      Returns:
      the mapping name

    • getDisplayName

      @Supported public String getDisplayName()
      Get the display name of the mapping. This should be a readable string describing the service with which user data will be shared.
      Returns:
      the display name of the mapping.

    • getIcon

      @Supported public String getIcon()
      Get the descriptor for an icon that can be displayed in the UI appropriate for the service declared by the mapping.
      Returns:
      icon descriptor for the mapping

    • getAccessLevel

      @Supported public String getAccessLevel()
      Get the access level string that describes the scope of the data shared with the service declared by the mapping.
      Returns:
      access level description

    • getFields

      @Supported public List<String> getFields()
      Get the list of fields from the user data that will be shared with the service declared by the mapping.
      Returns:
      list of fields to be shared

    • getRequired

      @Supported public Boolean getRequired()
      Return whether this mapping must be consented.
      Returns:
      true iff this mapping must be consented

    • getValue

      @Supported public boolean getValue()
      Get the current state of the user's opt-in choice.
      Returns:
      the user's opt-in choice

    • getMessage

      @Supported public String getMessage()
      Get the privacy and consent notice.
      Returns:
      the message

    • setValue

      @Supported public ConsentMappingCallback setValue(boolean optin)
      Set the state of the user's opt-in choice.
      Parameters:
      optin - the user's choice
      Returns:
      this callback

    • builder

      @Supported public static ConsentMappingCallback.Builder builder()
      Get a builder for constructing a new ConsentMappingCallback.
      Returns:
      a new builder