Interface PluginDescriptor
-
public interface PluginDescriptor
Represents all information about plugin. Each plugin may require an instance of that object (as spring bean) to get all information about itself.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PLUGIN_RESOURCES_PATH
Name of the variable containing plugin resource path in jsp
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getParameterValue(java.lang.String key)
Returns parameter value of parameters that was declared in teamcity-plugin.xml file.java.lang.String
getPluginName()
Name of plugin.java.lang.String
getPluginResourcesPath()
returns context path to all plugin resources.java.lang.String
getPluginResourcesPath(java.lang.String relativePath)
Returns absolute path without web application context of the resource by plugin relative path.java.io.File
getPluginRoot()
java.lang.String
getPluginVersion()
-
-
-
Field Detail
-
PLUGIN_RESOURCES_PATH
static final java.lang.String PLUGIN_RESOURCES_PATH
Name of the variable containing plugin resource path in jsp- See Also:
- Constant Field Values
-
-
Method Detail
-
getPluginName
@NotNull java.lang.String getPluginName()
Name of plugin. The name of plugin is taken from it's root folder name- Returns:
- name of plugin
-
getPluginResourcesPath
@NotNull java.lang.String getPluginResourcesPath()
returns context path to all plugin resources.- Returns:
- plugin resources deployment paths, ends with '/'
-
getPluginResourcesPath
@NotNull java.lang.String getPluginResourcesPath(@NotNull java.lang.String relativePath)
Returns absolute path without web application context of the resource by plugin relative path.- Parameters:
relativePath
- relative path of the file under plugin's "buildServerResources" directory- Returns:
- absolute server path
-
getParameterValue
@Nullable java.lang.String getParameterValue(@NotNull java.lang.String key)
Returns parameter value of parameters that was declared in teamcity-plugin.xml file.- Parameters:
key
- parameters name- Returns:
- trimmed and xml normalized parameter value if declared or null otherwise
- Since:
- 5.0
-
getPluginVersion
@Nullable java.lang.String getPluginVersion()
- Returns:
- plugin version string as written in teamcity-plugin.xml file or null
- Since:
- 6.5
-
getPluginRoot
@NotNull java.io.File getPluginRoot()
- Returns:
- path where plugin files are located on the server.
- Since:
- 7.0
-
-