Package jetbrains.buildServer.web.problems

Class BuildResultsBuildProblemRenderer

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.web.problems.BuildResultsBuildProblemRenderer

All Implemented Interfaces:

TeamCityExtension, PageExtension

Direct Known Subclasses:

BaseSnapshotDependencyErrorBuildProblemRenderer, BuildFailureOnMessageBuildProblemRenderer, CompilationErrorBuildProblemRenderer, ErrorMessageBuildProblemRenderer, ExitCodeBuildProblemRenderer

public abstract class BuildResultsBuildProblemRenderer
extends SimplePageExtension
implements TeamCityExtension

Should be implemented for custom build problem rendering

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
BuildResultsBuildProblemRenderer(SBuildServer server, WebControllerManager manager, String code, String includeUrl)

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).
protected abstract void	fillModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request, BuildResultsBean buildResultsBean, BuildProblem buildProblem)
protected BuildProblem	getBuildProblem(javax.servlet.http.HttpServletRequest request)
protected BuildProblem	getBuildProblemNotNull(javax.servlet.http.HttpServletRequest request)
protected abstract String	getBuildProblemType()
protected BuildResultsBean	getBuildResultsBean(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.
protected boolean	isCurrentBuildProblem(BuildResultsBean buildResultsBean, BuildProblem buildProblem)	Returns true if specified problem belongs to a build from the build results bean

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

getDisplayName

Field Detail

myServer

@NotNull
protected final SBuildServer myServer

Constructor Detail

BuildResultsBuildProblemRenderer

public BuildResultsBuildProblemRenderer(@NotNull
                                        SBuildServer server,
                                        @NotNull
                                        WebControllerManager manager,
                                        @NotNull
                                        String code,
                                        @NotNull
                                        String includeUrl)

Method Detail

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 PageExtension

Overrides:

fillModel in class SimplePageExtension

Parameters:

model - model to modify

request - HTTP request

fillModel

protected abstract void fillModel(@NotNull
                                  Map<String,Object> model,
                                  @NotNull
                                  javax.servlet.http.HttpServletRequest request,
                                  @Nullable
                                  BuildResultsBean buildResultsBean,
                                  @NotNull
                                  BuildProblem buildProblem)

getBuildProblemType

@NotNull
protected abstract String getBuildProblemType()

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

getBuildProblemNotNull

@NotNull
protected BuildProblem getBuildProblemNotNull(@NotNull
                                              javax.servlet.http.HttpServletRequest request)

getBuildProblem

@Nullable
protected BuildProblem getBuildProblem(@NotNull
                                       javax.servlet.http.HttpServletRequest request)

getBuildResultsBean

@Nullable
protected BuildResultsBean getBuildResultsBean(@NotNull
                                               javax.servlet.http.HttpServletRequest request)

isCurrentBuildProblem

protected boolean isCurrentBuildProblem(@Nullable
                                        BuildResultsBean buildResultsBean,
                                        @NotNull
                                        BuildProblem buildProblem)

Returns true if specified problem belongs to a build from the build results bean

Parameters:

buildResultsBean -

buildProblem -

Returns: