Package jetbrains.buildServer.controllers.login

Interface WebLoginModelEx

All Superinterfaces:

LoginPageProvider, ServerExtension, TeamCityExtension, WebLoginModel

All Known Implementing Classes:

WebLoginModelImpl

public interface WebLoginModelEx
extends WebLoginModel

Author:

Pavel.Sher Date: 17.03.2006

Method Summary

Modifier and Type	Method	Description
String	getDefaultLogoutPageUrl(javax.servlet.http.HttpServletRequest request)	Returns the default logout URL.
org.springframework.web.servlet.ModelAndView	getLoginView(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Returns view to show login page.
String	getLogoutPageUrl(javax.servlet.http.HttpServletRequest request)	Returns the logout URL
SUser	login(ServerPrincipal principal, boolean forceRememberMe, AuthModule<? extends AuthModuleType> authModule, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Authenticates the specified user
User	login(UserCredentials userCredentials, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Authenticates user by specified credentials
void	rememberTwoFactorLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Stores information in RememberMe about user provided in request.

Methods inherited from interface jetbrains.buildServer.controllers.login.LoginPageProvider

getLoginPageUrl

Methods inherited from interface jetbrains.buildServer.controllers.login.WebLoginModel

checkPassword, getDefaultLoginPageUrl, isGuestLoginByUrlRequest, login, loginFromRequest, logout, logoutAllSessions, refreshLogin

Method Detail

getLoginView

@NotNull
org.springframework.web.servlet.ModelAndView getLoginView(@NotNull
                                                          javax.servlet.http.HttpServletRequest request,
                                                          @NotNull
                                                          javax.servlet.http.HttpServletResponse response)

Returns view to show login page.

Returns:

login view corresponding to this model

login

@NotNull
User login(@NotNull
           UserCredentials userCredentials,
           @NotNull
           javax.servlet.http.HttpServletRequest request,
           @Nullable
           javax.servlet.http.HttpServletResponse response)
    throws AuthenticationFailedException

Authenticates user by specified credentials

Parameters:

userCredentials - user credentials

request - HTTP request

response - HTTP response

Returns:

authenticated User, never null

Throws:

AuthenticationFailedException - if authentication failed

login

@NotNull
SUser login(@NotNull
            ServerPrincipal principal,
            boolean forceRememberMe,
            @NotNull
            AuthModule<? extends AuthModuleType> authModule,
            @NotNull
            javax.servlet.http.HttpServletRequest request,
            @Nullable
            javax.servlet.http.HttpServletResponse response)
     throws AuthenticationFailedException

Authenticates the specified user

Parameters:

principal - principal

forceRememberMe - true, if login should be remembered even if there is no "remember" parameter in request

authModule - authentication module used to login

request - HTTP request

response - HTTP response

Returns:

authenticated user

Throws:

AuthenticationFailedException

getLogoutPageUrl

@NotNull
String getLogoutPageUrl(@NotNull
                        javax.servlet.http.HttpServletRequest request)

Returns the logout URL

Parameters:

request - HTTP request

Returns:

logout URL

Since:

8.1

getDefaultLogoutPageUrl

@NotNull
String getDefaultLogoutPageUrl(@NotNull
                               javax.servlet.http.HttpServletRequest request)

Returns the default logout URL.

Parameters:

request - HTTP request

Returns:

logout URL

Since:

8.1

rememberTwoFactorLogin

void rememberTwoFactorLogin(@NotNull
                            javax.servlet.http.HttpServletRequest request,
                            @NotNull
                            javax.servlet.http.HttpServletResponse response)

Stores information in RememberMe about user provided in request. Should be called only on successful 2FA. Will do nothing if request does not contain user.

Parameters:

request -

response -