Package jetbrains.buildServer.controllers.changes

Class VcsModificationTab

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.web.openapi.SimpleCustomTab

jetbrains.buildServer.controllers.changes.VcsModificationTab

All Implemented Interfaces:

CustomTab, ExtensionAvailability, PageExtension

Direct Known Subclasses:

VcsModificationBuildsTab, VcsModificationDeploymentsTab, VcsModificationFilesTab, VcsModificationTestsTab

public abstract class VcsModificationTab
extends SimpleCustomTab

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected VcsManager	myVcsManager

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

myCssPaths, myJsPaths, myPagePlaces

Constructor Summary

Constructors

Constructor	Description
VcsModificationTab(PagePlaces pagePlaces, VcsManager vcsManager, String code, String title)

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).
abstract void	fillModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request, SVcsModification modification)
protected SVcsModification	getModification(javax.servlet.http.HttpServletRequest request)
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.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

myVcsManager

protected final VcsManager myVcsManager

Constructor Detail

VcsModificationTab

public VcsModificationTab(@NotNull
                          PagePlaces pagePlaces,
                          @NotNull
                          VcsManager vcsManager,
                          @NotNull
                          String code,
                          @NotNull
                          String title)

Method Detail

fillModel

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

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

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

getModification

@Nullable
protected SVcsModification getModification(javax.servlet.http.HttpServletRequest request)