Package org.keycloak.userprofile

Interface UserProfileProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
DeclarativeUserProfileProvider
public interface UserProfileProvider extends Provider

The provider responsible for creating UserProfile instances.

Author:
Markus Till
See Also:

  • Method Details

    • create

      UserProfile create(UserProfileContext context, UserModel user)

      Creates a new UserProfile instance only for validation purposes to check whether its attributes are in conformance with the given context and profile configuration.

      Parameters:
      context - the context
      user - an existing user
      Returns:
      the user profile instance

    • create

      UserProfile create(UserProfileContext context, Map<String,?> attributes)

      Creates a new UserProfile instance for a given context and attributes for validation purposes.

      Instances created from this method are usually related to contexts where validation and updates are performed in different steps, or when creating new users based on the given attributes.

      Parameters:
      context - the context
      attributes - the attributes to associate with the instance returned from this method
      Returns:
      the user profile instance

    • create

      UserProfile create(UserProfileContext context, Map<String,?> attributes, UserModel user)

      Creates a new UserProfile instance for a given context and attributes for update purposes.

      Instances created from this method are going to run validations and updates based on the given user. This might be useful when updating an existing user.

      Parameters:
      context - the context
      attributes - the attributes to associate with the instance returned from this method
      user - the user to eventually update with the given attributes
      Returns:
      the user profile instance

    • getConfiguration

      UPConfig getConfiguration()
      Get current UserProfile configuration.
      Returns:
      current UserProfile configuration
      See Also:

    • setConfiguration

      void setConfiguration(UPConfig configuration)
      Set new UserProfile configuration. It is persisted inside of the provider.
      Parameters:
      configuration - to be set. It can be null and in this case, userProfile implementation will switch to use the default configuration
      Throws:
      RuntimeException - if configuration is invalid (exact exception class depends on the implementation) or configuration can't be persisted.
      See Also: