Package jetbrains.buildServer.web.openapi

Class BuildInfoFragmentTab

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.web.openapi.BuildInfoFragmentTab

All Implemented Interfaces:

PageExtension

public abstract class BuildInfoFragmentTab
extends SimplePageExtension

User: kir This is helper class for web extension point PlaceId.BUILD_RESULTS_FRAGMENT

Field Summary

Fields

Modifier and Type	Field	Description
protected SBuildServer	myServer

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

myCssPaths, myJsPaths, myPagePlaces

Constructor Summary

Constructors

Constructor	Description
BuildInfoFragmentTab(SBuildServer server, WebControllerManager manager, java.lang.String code, java.lang.String includeUrl)

Method Summary

Modifier and Type	Method	Description
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, SBuild build)
protected SBuild	getBuild(javax.servlet.http.HttpServletRequest request)
abstract java.lang.String	getDisplayName()	For extensions in some places, return the user-visible section name for this extension.
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.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

Field Detail

myServer

protected final SBuildServer myServer

Constructor Detail

BuildInfoFragmentTab

public BuildInfoFragmentTab(@NotNull
                            SBuildServer server,
                            @NotNull
                            WebControllerManager manager,
                            @NotNull
                            java.lang.String code,
                            @NotNull
                            java.lang.String includeUrl)

Parameters:

server - SBuildServer

manager - WebControllerManager

code - Extension key

Method Detail

getDisplayName

public abstract java.lang.String getDisplayName()

Description copied from interface: PageExtension

For extensions in some places, return the user-visible section name for this extension. At the moment of writing, one of such extension places is PlaceId.BUILD_RESULTS_FRAGMENT

Returns:

see above

See Also:

PlaceId.BUILD_RESULTS_FRAGMENT

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 PageExtension

Overrides:

fillModel in class SimplePageExtension

Parameters:

model - model to modify

request - HTTP request

getBuild

@Nullable
protected SBuild getBuild(javax.servlet.http.HttpServletRequest request)

fillModel

protected abstract void fillModel(@NotNull
                                  java.util.Map<java.lang.String,java.lang.Object> model,
                                  @NotNull
                                  javax.servlet.http.HttpServletRequest request,
                                  @Nullable
                                  SBuild build)

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 PageExtension

Overrides:

isAvailable in class SimplePageExtension

Parameters:

request - HTTP request

Returns:

true if extension should be included in the page place