Interface ILoginMethod<PROFILE>

  • Type Parameters:
    PROFILE - Type of the user profile returned when the user was logged in..
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface ILoginMethod<PROFILE>
    Attempts to login the user with the given user name and password.
    Since:
    8.0.0
    Author:
    XIMA MEDIA GmbH
    • Method Detail

      • login

        PROFILE login​(String username,
                      String password)
               throws Exception
        Parameters:
        username - Username for the login.
        password - Password for the login.
        Returns:
        The user profile when the login was successful. null when the login was not successful.
        Throws:
        Exception - When the login could not be performed.