Package jetbrains.buildServer.controllers.login

Interface WebLoginModel

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SUser checkPassword​(String username, String password)
      Attempts to authenticate using specified username and password and if authentication was successful returns corresponding User object.
      String getDefaultLoginPageUrl​(javax.servlet.http.HttpServletRequest request)
      Returns default login page URL.
      boolean isGuestLoginByUrlRequest​(javax.servlet.http.HttpServletRequest request)
      Returns true if request parameters indicate that a guest login is initiated.
      User login​(String username, String password, javax.servlet.http.HttpServletRequest request)
      Authenticates user by specified username and password
      User loginFromRequest​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Verifies that authentication information provided with request is valid.
      void logout​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Performs logout.
      void logoutAllSessions​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean terminateCurrentSession)
      Performs logout of all other sessions of current user.
      User refreshLogin​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Updates login information in session and cookies if exist.

    • Method Detail

      • checkPassword

        @NotNull
SUser checkPassword​(String username,
                    String password)
             throws AuthenticationFailedException
        Attempts to authenticate using specified username and password and if authentication was successful returns corresponding User object.
        Parameters:
        username - username
        password - password
        Returns:
        User object, never null
        Throws:
        AuthenticationFailedException - if authentication failed

      • loginFromRequest

        @NotNull
User loginFromRequest​(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws AuthenticationFailedException
        Verifies that authentication information provided with request is valid.
        Parameters:
        request - HTTP request
        response - HTTP response
        Returns:
        authorized User, never null
        Throws:
        AuthenticationFailedException - if authentication failed

      • login

        @NotNull
User login​(String username,
           String password,
           javax.servlet.http.HttpServletRequest request)
    throws AuthenticationFailedException
        Authenticates user by specified username and password
        Parameters:
        username - username
        password - password
        request - HTTP request
        Returns:
        authenticated User, never null
        Throws:
        AuthenticationFailedException - if authentication failed

      • refreshLogin

        @Nullable
User refreshLogin​(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
        Updates login information in session and cookies if exist.
        Parameters:
        request - HTTP request
        response - HTTP response
        Returns:
        authenticated User or null if user does not exist any more

      • logout

        void logout​(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
        Performs logout.
        Parameters:
        request - HTTP request
        response - HTTP response

      • logoutAllSessions

        void logoutAllSessions​(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       boolean terminateCurrentSession)
        Performs logout of all other sessions of current user.
        Parameters:
        request - HTTP request
        response - HTTP response
        Since:
        2019.1

      • isGuestLoginByUrlRequest

        boolean isGuestLoginByUrlRequest​(javax.servlet.http.HttpServletRequest request)
        Returns true if request parameters indicate that a guest login is initiated.
        Parameters:
        request - request
        Returns:
        true if guest user login detected by request parameters

      • getDefaultLoginPageUrl

        @NotNull
String getDefaultLoginPageUrl​(@NotNull
                              javax.servlet.http.HttpServletRequest request)
        Returns default login page URL.
        Parameters:
        request - current request
        Returns:
        see above
        Since:
        6.0