Package jetbrains.buildServer.plugins

Interface PluginPaths

All Known Implementing Classes:

ServerPluginPaths

public interface PluginPaths

Since:

6.5

Author:

Eugene Petrenko (eugene.petrenko@gmail.com) Date: 30.01.11 19:39

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PluginPaths.PluginLocation

Method Summary

Modifier and Type	Method	Description
PluginPaths.PluginLocation	findLocation(String path)
PluginPaths.PluginLocation	findLocation(PluginInfo info)
File	getAgentUpdatePluginsFolder()
File	getAgentZipFile()
File	getAgentZipFolder()
File	getOriginalLocation(PluginInfo pluginInfo)	The path to the plugin installation - i.e.
String	getPluginLocation(PluginInfo pluginInfo)	Returns abstract representation of the plugin location.
File	getPluginsFolder(PluginPaths.PluginLocation location)	Get the root directory that should be scanned for the plugins
default File	getUnpackFolder(File pluginsFolder)	Where zipped plugins from the specified folder should be unpacked.

Method Detail

getPluginsFolder

@NotNull
File getPluginsFolder(@NotNull
                      PluginPaths.PluginLocation location)

Get the root directory that should be scanned for the plugins

getUnpackFolder

@NotNull
default File getUnpackFolder(@NotNull
                             File pluginsFolder)

Where zipped plugins from the specified folder should be unpacked.

Parameters:

pluginsFolder - result of the getPluginsFolder(PluginLocation)

getPluginLocation

@NotNull
String getPluginLocation(@NotNull
                         PluginInfo pluginInfo)

Returns abstract representation of the plugin location. Note that this is not a path to the plugin file

getOriginalLocation

@NotNull
File getOriginalLocation(@NotNull
                         PluginInfo pluginInfo)

The path to the plugin installation - i.e. zip file for the unpacked plugins, plugin's root directory for the plugins that were not unpacked

findLocation

@Nullable
PluginPaths.PluginLocation findLocation(@NotNull
                                        PluginInfo info)

getAgentUpdatePluginsFolder

@NotNull
File getAgentUpdatePluginsFolder()

Returns:

path to /update/plugins folder in server installation path

Since:

6.5

getAgentZipFile

@NotNull
File getAgentZipFile()

Returns:

path to buildAgent.zip file on the server

Since:

6.5

getAgentZipFolder

File getAgentZipFolder()

Returns:

to the folder containing buildAgent.zip and buildAgentFull.zip on server

Since:

2020.1.

findLocation

@Nullable
PluginPaths.PluginLocation findLocation(@NotNull
                                        String path)