Package com.adobe.granite.auth.oauth

Interface ProfileValidator

  • @ConsumerType
public interface ProfileValidator

    This interface is intended to be implemented by an application which wants to customize the validation of the users based on their profile.

    A ProfileValidator is bind to all Provider providers implementations supporting the ProfileValidator and for which Provider#getId equals ProfileValidator#getId.

    Each Provider can be bind to either 0 or many ProfileValidator profile validators. The profile validators are linked with a AND operator (a profile is valid if ALL profile validators return true)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      Provider identifier used to map this profile validator to it.
      boolean isValidProfile​(java.lang.String userId, java.util.Map<java.lang.String,​java.lang.Object> profileData)
      Check the validity of a user profile.

    • Method Detail

      • getId

        java.lang.String getId()
        Provider identifier used to map this profile validator to it.
        Returns:
        the provider identifier to map this profile validator to it.
        Since:
        3.3

      • isValidProfile

        boolean isValidProfile​(java.lang.String userId,
                       java.util.Map<java.lang.String,​java.lang.Object> profileData)
        Check the validity of a user profile.
        Parameters:
        userId - the non null user identifier.
        profileData - the non null profile data to check.
        Returns:
        true if the profile is valid ; false otherwise.
        Since:
        3.3