jetbrains.buildServer.web.openapi
Class SimpleWebExtension

java.lang.Object
  jetbrains.buildServer.web.openapi.SimpleWebExtension

All Implemented Interfaces:

WebExtension

Deprecated. see SimplePageExtension instead

public class SimpleWebExtension
extends java.lang.Object
implements WebExtension

Deprecated! A helper class which allows to insert Web Extension in Spring XML. Required props: Name, Place, JspPath. init-method - register.

Constructor Summary

SimpleWebExtension(WebControllerManager manager)
Deprecated. Create simple web extension.

Method Summary

SimpleWebExtension	addCssFile(java.lang.String cssFile) Deprecated. Allows to add css file path for this extension
SimpleWebExtension	addJsFile(java.lang.String file) Deprecated. Allows to add Javascript file path for this extension
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 WebExtension.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.
void	register() Deprecated. Call this to register this extension in Web controller, either explicitly or as Spring's init-method
void	setJspPath(java.lang.String jspPath) Deprecated. Spring setter for jsp path.
void	setPlace(WebPlace place) Deprecated. Spring setter for the location of this Web extension
void	setPluginName(java.lang.String name) Deprecated. Sets the plugin name for the extension, may be used in path to jsp, css and other files.
void	setTitle(java.lang.String title) Deprecated. Sets the title for the extension, the exact meaning depends from specific WebPlace
void	unregister() Deprecated. Call this to unregister this extension from Web controller

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleWebExtension

public SimpleWebExtension(WebControllerManager manager)

Deprecated.

Create simple web extension. Usually this constructor is invoked by Spring DI

Parameters:

manager - manager to register this extension in, see register() method.

Method Detail

setJspPath

public void setJspPath(@NonNls
                       java.lang.String jspPath)

Deprecated.

Spring setter for jsp path. See getJspFilePath()

Parameters:

jspPath - path to the extension

setPlace

public void setPlace(WebPlace place)

Deprecated.

Spring setter for the location of this Web extension

Parameters:

place - web extension point for this extension, see WebPlace

setTitle

public void setTitle(java.lang.String title)

Deprecated.

Sets the title for the extension, the exact meaning depends from specific WebPlace

Parameters:

title - extension displayable title, see getTitle()

setPluginName

public void setPluginName(java.lang.String name)

Deprecated.

Sets the plugin name for the extension, may be used in path to jsp, css and other files.

Parameters:

name - plugin name for this extension, see getPluginName(), getCssFiles(), getJsFiles(), getJspFilePath()

getTitle

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getTitle in interface WebExtension

Parameters:

request - request

Returns:

web place title.

register

public void register()

Deprecated.

Call this to register this extension in Web controller, either explicitly or as Spring's init-method

unregister

public void unregister()

Deprecated.

Call this to unregister this extension from Web controller

getPluginName

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getPluginName in interface WebExtension

Returns:

name of the plugin

getTitle

@NotNull
public java.lang.String getTitle()

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getTitle in interface WebExtension

Returns:

web place title.

isAvailable

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

isAvailable in interface WebExtension

Parameters:

request - request

Returns:

true if this extension is available and false otherwise

fillModel

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

Deprecated.

Description copied from interface: WebExtension

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.

Specified by:

fillModel in interface WebExtension

Parameters:

model - model

request - request

getCssFiles

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getCssFiles in interface WebExtension

Returns:

returns list of paths to plugin CSS files

getJsFiles

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getJsFiles in interface WebExtension

Returns:

returns list of paths to plugin JavaScript files

getJspFilePath

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

Deprecated.

Description copied from interface: WebExtension

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

Specified by:

getJspFilePath in interface WebExtension

Returns:

returns path to plugin JSP

addCssFile

public SimpleWebExtension addCssFile(java.lang.String cssFile)

Deprecated.

Allows to add css file path for this extension

Parameters:

cssFile - path to the css file, see getCssFiles()

Returns:

this

addJsFile

public SimpleWebExtension addJsFile(java.lang.String file)

Deprecated.

Allows to add Javascript file path for this extension

Parameters:

file - path to the css file, see getJsFiles()

Returns:

this