Package jetbrains.buildServer.serverSide.impl.agent

Interface AgentPluginsHolder

All Superinterfaces:

OverallAgentPluginsProvider

All Known Implementing Classes:

AbstractAgentPluginsHolder, CompositeAgentPluginsHolder

public interface AgentPluginsHolder
extends OverallAgentPluginsProvider

Model interface to fetch agent plugins. Implementation should not change names in order to be consistent in multi-threaded context.

Since:

6.5

Method Summary

Modifier and Type	Method	Description
void	addAgentPlugins(AgentPluginsProvider2 provider)	Registers agent plugins for upgrade.
void	addNotLoadedAgentPlugins(AgentPluginsProvider2 provider)	Registers agent part of not loaded plugins.
AgentExtensionInfo	getPlugin(String name)	Returns build agent extensions info by its name
AgentExtensionInfo	getPlugin(String pluginPartName, String name)	Returns build agent extension info from plugin part by its name
Collection<AgentExtensionInfo>	getPlugins()	Get all registered build agent extensions (plugins, tools) For every extension from returned collection url will be formed by build agent in the form: [server url]/update/plugins/[extension.getName()]
Collection<AgentExtensionInfo>	getPlugins(String pluginPartName)	Get all registered build agent extensions (plugins, tools) For every extension from returned collection url will be formed by build agent in the form: [server url]/update/plugins/[pluginPartName]/[extension.getName()]
void	removeAgentPlugins(AgentPluginsProvider2 plugin)
void	replaceProvider(AgentPluginsProvider2 oldProvider, ServerPluginAgentPartProvider newProvider)	replace specified old provider with new provider.

Method Detail

getPlugin

@Nullable
AgentExtensionInfo getPlugin(@NotNull
                             String name)

Returns build agent extensions info by its name

Parameters:

name - extension name

Returns:

extension if registered, null otherwise

Since:

2017.1

removeAgentPlugins

void removeAgentPlugins(@NotNull
                        AgentPluginsProvider2 plugin)

getPlugin

@Nullable
AgentExtensionInfo getPlugin(@NotNull
                             String pluginPartName,
                             @NotNull
                             String name)

Returns build agent extension info from plugin part by its name

Parameters:

pluginPartName - plugin part name

name - extension name

Returns:

extension if registered, null otherwise

Since:

2017.1

getPlugins

@NotNull
Collection<AgentExtensionInfo> getPlugins()

Get all registered build agent extensions (plugins, tools) For every extension from returned collection url will be formed by build agent in the form: [server url]/update/plugins/[extension.getName()]

Returns:

all registered extensions

Since:

2017.1

getPlugins

@NotNull
Collection<AgentExtensionInfo> getPlugins(@NotNull
                                          String pluginPartName)

Get all registered build agent extensions (plugins, tools) For every extension from returned collection url will be formed by build agent in the form: [server url]/update/plugins/[pluginPartName]/[extension.getName()]

Specified by:

getPlugins in interface OverallAgentPluginsProvider

Parameters:

pluginPartName - plugin part name

Returns:

all registered extensions

Since:

2017.1

addAgentPlugins

void addAgentPlugins(@NotNull
                     AgentPluginsProvider2 provider)

Registers agent plugins for upgrade.

Parameters:

provider - agent plugins provider

Since:

8.1

addNotLoadedAgentPlugins

void addNotLoadedAgentPlugins(@NotNull
                              AgentPluginsProvider2 provider)

Registers agent part of not loaded plugins. It allows server to send this part to agents if agents try to download upgrades from the server

Parameters:

provider - agent plugins provider

Since:

2021.1

replaceProvider

void replaceProvider(AgentPluginsProvider2 oldProvider,
                     ServerPluginAgentPartProvider newProvider)

replace specified old provider with new provider. This method is atomically equivalent for #removeAgentPlugins(oldProvider) #addAgentPlugins(newProvider)}

Since:

2018.2