jetbrains.buildServer.web.openapi
Interface WebExtension

All Known Implementing Classes:

SimpleWebExtension

Deprecated. see PageExtension and CustomTab

public interface WebExtension

Deprecated! Descriptor of the additional web content (web extension point). Describes some fragment of web page, provided by plugin. CSS/JS files can be provided via getCssFiles() and getJsFiles() methods, which should return relative paths to plugin's files (like inscpect.css). The same applies to tab content, see getJspFilePath(). .js, .css, .jsp files should be placed in buildServerResources/ subdirectrory in plugin's jar. The name of jar file should be registered in WebResourcesManager.addPluginResources(String, String). These resources are unpacked upon server startup into /plugins/[pluginName]/ directory.

Method Summary

void	fillModel(java.util.Map model, javax.servlet.http.HttpServletRequest request) Deprecated. If web extension is available then this method is called when model is populated.
java.util.List<java.lang.String>	getCssFiles() Deprecated. Returns list of paths to plugin CSS files.
java.util.List<java.lang.String>	getJsFiles() Deprecated. Returns list of paths to plugin JavaScript files.
java.lang.String	getJspFilePath() Deprecated. Returns path to plugin JSP.
java.lang.String	getPluginName() Deprecated. Returns name of the plugin.
java.lang.String	getTitle() Deprecated. Returns title.
java.lang.String	getTitle(javax.servlet.http.HttpServletRequest request) Deprecated. Same as getTitle() but additional information specified in the request can be used to construct a title.
boolean	isAvailable(javax.servlet.http.HttpServletRequest request) Deprecated. Returns true if this extension is available (can be shown) for the specified request.

Method Detail

getPluginName

@NonNls
@NotNull
java.lang.String getPluginName()

Deprecated.

Returns name of the plugin. This name will be used when a path to plugin resources will be constructed.

Returns:

name of the plugin

getTitle

@NotNull
java.lang.String getTitle()

Deprecated.

Returns title. In some web places the title can be shown in the name of a tab.

Returns:

web place title.

getTitle

@NotNull
java.lang.String getTitle(@NotNull
                                  javax.servlet.http.HttpServletRequest request)

Deprecated.

Same as getTitle() but additional information specified in the request can be used to construct a title.

Parameters:

request - request

Returns:

web place title.

isAvailable

boolean isAvailable(@NotNull
                    javax.servlet.http.HttpServletRequest request)

Deprecated.

Returns true if this extension is available (can be shown) for the specified request.

Parameters:

request - request

Returns:

true if this extension is available and false otherwise

fillModel

void fillModel(java.util.Map model,
               @NotNull
               javax.servlet.http.HttpServletRequest request)

Deprecated.

If web extension is available then this method is called when model is populated. Web extension can place various objects in the model and later use them in JSP.

Parameters:

model - model

request - request

getCssFiles

java.util.List<java.lang.String> getCssFiles()

Deprecated.

Returns list of paths to plugin CSS files. If returned path starts with /, it is passed directly; otherwise prefixed with /plugins/[pluginName]

Returns:

returns list of paths to plugin CSS files

getJsFiles

java.util.List<java.lang.String> getJsFiles()

Deprecated.

Returns list of paths to plugin JavaScript files. If returned path starts with /, it is passed directly; otherwise prefixed with /plugins/[pluginName]

Returns:

returns list of paths to plugin JavaScript files

getJspFilePath

@Nullable
@NonNls
java.lang.String getJspFilePath()

Deprecated.

Returns path to plugin JSP. If returned path starts with /, it is passed directly; otherwise prefixed with /plugins/[pluginName]

Returns:

returns path to plugin JSP