Package jetbrains.buildServer.controllers.admin.projects.setupFromUrl

Class SetupObjectFromResourcePageExtension

java.lang.Object

jetbrains.buildServer.web.openapi.SimplePageExtension

jetbrains.buildServer.controllers.admin.projects.setupFromUrl.SetupObjectFromResourcePageExtension

All Implemented Interfaces:

PageExtension

Direct Known Subclasses:

SetupObjectFromVcsUrlExtension

public class SetupObjectFromResourcePageExtension
extends SimplePageExtension

Page extension which is called when some project or build configuration must be created from a resource located by some URL. Resource is represented by DiscoveredObject bean. This bean is provided by ResourceDiscoveryExtension extension. When ResourceDiscoveryExtension returns DiscoveredObject of some type, server locates SetupObjectFromResourcePageExtension whose method SimplePageExtension.getPluginName() returns the same type and passes control to this extension. It's up to this page extension to handle new project creation.

Since:

8.1

Field Summary

Fields

Modifier and Type	Field	Description
static String	SETUP_OBJECT_FROM_RESOURCE_BEAN_KEY

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

myCssPaths, myJsPaths, myPagePlaces

Constructor Summary

Constructors

Constructor	Description
SetupObjectFromResourcePageExtension(String type, PagePlaces pagePlaces)

Method Summary

Modifier and Type	Method	Description
void	fillModel(Map<String,Object> model, javax.servlet.http.HttpServletRequest request)	Sets instance of SetupObjectFromResourceBean to model
protected SetupObjectFromResourceBean	getSetupObjectFromResourceBean(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.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

SETUP_OBJECT_FROM_RESOURCE_BEAN_KEY

public static final String SETUP_OBJECT_FROM_RESOURCE_BEAN_KEY

See Also:

Constant Field Values

Constructor Detail

SetupObjectFromResourcePageExtension

public SetupObjectFromResourcePageExtension(@NotNull
                                            String type,
                                            @NotNull
                                            PagePlaces pagePlaces)

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 PageExtension

Overrides:

isAvailable in class SimplePageExtension

Parameters:

request - HTTP request

Returns:

true if discovered object bean returned by some ResourceDiscoveryExtension is not null and it's type equals to SimplePageExtension.getPluginName()

fillModel

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

Sets instance of SetupObjectFromResourceBean to model

Specified by:

fillModel in interface PageExtension

Overrides:

fillModel in class SimplePageExtension

Parameters:

model - model

request - HTTP request

getSetupObjectFromResourceBean

protected SetupObjectFromResourceBean getSetupObjectFromResourceBean(javax.servlet.http.HttpServletRequest request)

Parameters:

request - HTTP request

Returns:

instance of SetupObjectFromResourceBean