Package jetbrains.buildServer.controllers.admin

Class AuthAdminPage

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.web.openapi.SimpleCustomTab

jetbrains.buildServer.controllers.admin.AdminPage

jetbrains.buildServer.controllers.admin.AuthAdminPage

All Implemented Interfaces:

CustomTab, ExtensionAvailability, Groupable, PageExtension

public class AuthAdminPage
extends AdminPage

Since:

8.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com), Maxim Manuylov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthAdminPage.AuthPreset

Field Summary

Fields

Modifier and Type	Field	Description
static String	MESSAGE_KEY
static String	WARNING_MESSAGE_KEY

Fields inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension

myCssPaths, myJsPaths, myPagePlaces

Fields inherited from interface jetbrains.buildServer.web.openapi.Groupable

GROUP_POSITIONS, INTEGRATIONS_GROUP, PROJECT_RELATED_GROUP, SERVER_RELATED_GROUP, USER_MANAGEMENT_GROUP

Constructor Summary

Constructors

Constructor	Description
AuthAdminPage(BuildServerImpl server, PagePlaces pagePlaces, LoginConfigurationEx loginConfiguration, ServerPaths serverPaths, ServerSettingsImpl serverSettings, WebControllerManager webControllerManager, AuthorizationInterceptor interceptor, AuthConfigManager authConfigManager, SessionModel sessionModel, TokenAuthenticationModel tokenAuthenticationModel)

Method Summary

Modifier and Type	Method	Description
void	fillModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request)	This method is useful for extensions that do not have controllers (such extensions usually return path to JSP as their include URL).
String	getGroup()	Returns the group name.
boolean	isAvailable(javax.servlet.http.HttpServletRequest request)	Returns true if this extension is available (should be included on the page) for the specified request.

Methods inherited from class jetbrains.buildServer.controllers.admin.AdminPage

checkHasGlobalPermission, checkHasGlobalPermissions, getUserOrNull

Methods inherited from class jetbrains.buildServer.web.openapi.SimpleCustomTab

getTabId, getTabTitle, getTabTitle, isVisible, setTabTitle

Methods inherited from class jetbrains.buildServer.web.openapi.SimplePageExtension

addCssFile, addJsFile, getCssPaths, getIncludeUrl, getJsPaths, getPlaceId, getPluginName, isGet, isPost, register, setIncludeUrl, setPlaceId, setPluginName, setPosition, toString, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.web.openapi.PageExtension

getCssPaths, getDisplayName, getIncludeUrl, getJsPaths, getPluginName

Field Detail

MESSAGE_KEY

public static final String MESSAGE_KEY

See Also:

Constant Field Values

WARNING_MESSAGE_KEY

public static final String WARNING_MESSAGE_KEY

See Also:

Constant Field Values

Constructor Detail

AuthAdminPage

public AuthAdminPage(@NotNull
                     BuildServerImpl server,
                     @NotNull
                     PagePlaces pagePlaces,
                     @NotNull
                     LoginConfigurationEx loginConfiguration,
                     @NotNull
                     ServerPaths serverPaths,
                     @NotNull
                     ServerSettingsImpl serverSettings,
                     @NotNull
                     WebControllerManager webControllerManager,
                     @NotNull
                     AuthorizationInterceptor interceptor,
                     @NotNull
                     AuthConfigManager authConfigManager,
                     @NotNull
                     SessionModel sessionModel,
                     @NotNull
                     TokenAuthenticationModel tokenAuthenticationModel)

Method Detail

isAvailable

public boolean isAvailable(@NotNull
                           javax.servlet.http.HttpServletRequest request)

Description copied from interface: PageExtension

Returns true if this extension is available (should be included on the page) for the specified request. If extension needs to be shown for some pages only, it can obtain original page URL via request attribute called "pageUrl":

String pageUrl = (String)request.getAttribute("pageUrl");

Specified by:

isAvailable in interface ExtensionAvailability

Specified by:

isAvailable in interface PageExtension

Overrides:

isAvailable in class SimplePageExtension

Parameters:

request - HTTP request

Returns:

true if extension should be included in the page place

fillModel

public void fillModel(@NotNull
                      Map<String,Object> model,
                      @NotNull
                      javax.servlet.http.HttpServletRequest request)

Description copied from interface: PageExtension

This method is useful for extensions that do not have controllers (such extensions usually return path to JSP as their include URL). method is called before processing is passed to JSP. It allows page extension to modify model passed to JSP. Note that since main page controller also uses this model for storing its parameters in case of parameter name conflict extension parameter will be removed and warning message will be logged into the server log.

Specified by:

fillModel in interface CustomTab

Specified by:

fillModel in interface PageExtension

Overrides:

fillModel in class SimplePageExtension

Parameters:

model - model to modify

request - HTTP request

getGroup

@NotNull
public String getGroup()

Description copied from interface: Groupable

Returns the group name.

Returns:

the group name