jetbrains.buildServer.web.openapi.buildType
Class BuildTypeTab

java.lang.Object
  jetbrains.buildServer.web.openapi.SimplePageExtension
      jetbrains.buildServer.web.openapi.SimpleCustomTab
          jetbrains.buildServer.web.openapi.buildType.BuildTypeTab

All Implemented Interfaces:

CustomTab, PageExtension

public abstract class BuildTypeTab
extends SimpleCustomTab

User: kir A web extension for tabs on the build configuration page

Field Summary

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

myCssPaths, myJsPaths, myPagePlaces

Constructor Summary

protected	BuildTypeTab(java.lang.String tabCode, java.lang.String title, WebControllerManager manager, ProjectManager projectManager)
protected	BuildTypeTab(java.lang.String tabCode, java.lang.String title, WebControllerManager manager, ProjectManager projectManager, java.lang.String includeUrl)

Method Summary

void	fillModel(java.util.Map<java.lang.String,java.lang.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).
protected abstract void	fillModel(java.util.Map<java.lang.String,java.lang.Object> model, javax.servlet.http.HttpServletRequest request, SBuildType buildType, SUser user)
SBuildType	getBuildType(javax.servlet.http.HttpServletRequest request) Helper method
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, 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, getIncludeUrl, getJsPaths, getPluginName

Constructor Detail

BuildTypeTab

protected BuildTypeTab(java.lang.String tabCode,
                       java.lang.String title,
                       WebControllerManager manager,
                       ProjectManager projectManager)

BuildTypeTab

protected BuildTypeTab(java.lang.String tabCode,
                       java.lang.String title,
                       WebControllerManager manager,
                       ProjectManager projectManager,
                       @NotNull
                       java.lang.String includeUrl)

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 CustomTab

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
                      java.util.Map<java.lang.String,java.lang.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

fillModel

protected abstract void fillModel(java.util.Map<java.lang.String,java.lang.Object> model,
                                  javax.servlet.http.HttpServletRequest request,
                                  @NotNull
                                  SBuildType buildType,
                                  SUser user)

getBuildType

@Nullable
public SBuildType getBuildType(javax.servlet.http.HttpServletRequest request)

Helper method

Parameters:

request - HTTP request

Returns:

SBuildType deduced from buildTypeId prameter