Interface IUserPortalUserManager

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    UserPortalUserManager

    public interface IUserPortalUserManager
    extends Serializable
    Common interface for a manager that handles the user portal session.
    Since:
    8.2.0
    Author:
    XIMA MEDIA GmbH
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void login​(String clientName, de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse tokenResponse)
      Logs in a user with the given token response.
      void logout()
      Logs out the currently authenticated user.
      Optional<IUserPortalUser> user()
      Gets the currently authenticated user, if any.
    • Method Detail

      • user

        Optional<IUserPortalUser> user()
        Gets the currently authenticated user, if any.
        Returns:
        The currently authenticated user, if any.
      • login

        void login​(String clientName,
                   de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse tokenResponse)
        Logs in a user with the given token response.
        Parameters:
        clientName - The name of the pac4j client that was used for logging in.
        tokenResponse - The token response to use for logging in.
      • logout

        void logout()
        Logs out the currently authenticated user.