Package jetbrains.buildServer.tools.installed

Interface ToolsRegistry

All Superinterfaces:

ReadonlyToolsRegistry

All Known Implementing Classes:

ServerToolRegistryImpl

public interface ToolsRegistry
extends ReadonlyToolsRegistry

Created 27.12.12 19:02

Author:

Evgeniy Koshkin

Method Summary

Modifier and Type	Method	Description
boolean	dismissToolError(String toolId)
Collection<ToolInstallationError>	getNotDismissedInstallationErrors()
ToolInstallationSource	getToolInstallationSource(String toolId)
ToolInstallationStatus	getToolInstallationStatus(String toolId)
Collection<ToolState>	getToolStates()
InstalledToolVersionEx	installTool(File toolPackage, ToolInstallationSource toolInstallationSource)
InstalledToolVersionEx	installTool(ToolVersion toolVersion, File toolContent, ToolInstallationSource toolInstallationSource)
void	markInstallationScheduled(ToolVersion tool, ToolInstallationSource installationSource)
void	markInstallationSkipped(ToolVersion tool, ToolInstallationSource installationSource, ToolInstallationSkipReason skipReason)
void	persistInstallationError(ToolInstallationError error, ToolInstallationSource installationSource)
boolean	removeTool(String toolId)	Remove tool, clean all related data from disc (unpacked content, packed agent tool)
InstalledToolVersionEx	updateTool(InstalledToolVersionEx tool, ToolInstallationSource toolInstallationSource)

Methods inherited from interface jetbrains.buildServer.tools.installed.ReadonlyToolsRegistry

findInstalledTool, getInstalledTools, getInstalledTools, isToolRegistered, isToolRegistered

Method Detail

installTool

@NotNull
InstalledToolVersionEx installTool(@NotNull
                                   ToolVersion toolVersion,
                                   @NotNull
                                   File toolContent,
                                   @NotNull
                                   ToolInstallationSource toolInstallationSource)
                            throws ToolException

Throws:

ToolException

installTool

@NotNull
InstalledToolVersionEx installTool(@NotNull
                                   File toolPackage,
                                   @NotNull
                                   ToolInstallationSource toolInstallationSource)
                            throws ToolException

Throws:

ToolException

updateTool

@Nullable
InstalledToolVersionEx updateTool(@NotNull
                                  InstalledToolVersionEx tool,
                                  @NotNull
                                  ToolInstallationSource toolInstallationSource)
                           throws ToolException

Returns:

updated installed tool entity or null if tool was actually deleted

Throws:

ToolException

removeTool

boolean removeTool(@NotNull
                   String toolId)
            throws ToolException

Remove tool, clean all related data from disc (unpacked content, packed agent tool)

Parameters:

toolVersion -

Returns:

True if tool was actually removed, False otherwise.

Throws:

ToolException

dismissToolError

boolean dismissToolError(@NotNull
                         String toolId)

getNotDismissedInstallationErrors

@NotNull
Collection<ToolInstallationError> getNotDismissedInstallationErrors()

persistInstallationError

void persistInstallationError(@NotNull
                              ToolInstallationError error,
                              @NotNull
                              ToolInstallationSource installationSource)

getToolInstallationStatus

@NotNull
ToolInstallationStatus getToolInstallationStatus(@NotNull
                                                 String toolId)

getToolInstallationSource

@NotNull
ToolInstallationSource getToolInstallationSource(@NotNull
                                                 String toolId)

markInstallationScheduled

void markInstallationScheduled(@NotNull
                               ToolVersion tool,
                               @NotNull
                               ToolInstallationSource installationSource)

markInstallationSkipped

void markInstallationSkipped(@NotNull
                             ToolVersion tool,
                             @NotNull
                             ToolInstallationSource installationSource,
                             @NotNull
                             ToolInstallationSkipReason skipReason)

getToolStates

@NotNull
Collection<ToolState> getToolStates()