ToolEventsListener (javadoc 2024.12-174331 API)

All Superinterfaces:

EventListener

All Known Implementing Classes:

BundledToolVersionsImpl, DefaultToolVersionsImpl, ToolEventsListenerAdapter, UpdatingAgentInfoOnToolInstalledListener
```
@UserImplemented(adapterClass=ToolEventsListenerAdapter.class)
public interface ToolEventsListener
extends EventListener
```
Exposes some tool events that occur during the lifecycle of a tool on TeamCity server.
You should not implement this interface directly in your code. Use ToolEventsListenerAdapter instead.
To subscribe to this event listener, you should use a Spring bean of type EventDispatcher with ToolEventsListener and call EventDispatcher.addListener(java.util.EventListener) method.

Since:

2024.07

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`toolInstallationFailed(ToolInstallationError error)`	Called when the tool installation is interrupted because of some error
`void`	`toolInstallationScheduled(ToolVersion tool)`	Called after performing some basic validation on the server to ensure that the tool can be installed and before the actual installation is started on the server
`void`	`toolInstalled(InstalledToolVersion tool)`	Called after the tool installation is completed on the server
`void`	`toolRemoved(String toolId)`	Called after the tool is removed on the server
`void`	`toolUpdated(InstalledToolVersion tool)`	Called after the tool content is updated on the server.

- Method Detail
  - toolInstallationScheduled
```
void toolInstallationScheduled(@NotNull
                               ToolVersion tool)
```
    Called after performing some basic validation on the server to ensure that the tool can be installed and before the actual installation is started on the server
  - toolInstalled
```
void toolInstalled(@NotNull
                   InstalledToolVersion tool)
```
    Called after the tool installation is completed on the server
  - toolUpdated
```
void toolUpdated(@NotNull
                 InstalledToolVersion tool)
```
    Called after the tool content is updated on the server. The content is updated when the original tool package is changed
  - toolRemoved
```
void toolRemoved(@NotNull
                 String toolId)
```
    Called after the tool is removed on the server
  - toolInstallationFailed
```
void toolInstallationFailed(@NotNull
                            ToolInstallationError error)
```
    Called when the tool installation is interrupted because of some error