Package jetbrains.buildServer.plugins

Interface PluginManagerListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

PluginManagerListenerAdapter, ResetCachesOnPluginUnload

public interface PluginManagerListener
extends EventListener

Allows to listen events of loading and unloading plugins. Use PluginManager.getPluginLifecycleEventDispatcher() to subscribe. Use PluginManagerListenerAdapter for implementations.

Since:

2018.2

Method Summary

Modifier and Type	Method	Description
void	beforePluginLoaded(PluginInfo pluginInfo)	Called before plugin load is started.
void	beforePluginUnloaded(PluginInfo pluginInfo)	Called before plugin unload is started.
void	pluginLoaded(PluginData pluginData)	Called after plugin is loaded successfully.
void	pluginLoadedInRuntime(PluginData pluginData)	the same as #pluginLoaded but this method won't be called when all plugins are loading during server startup*
void	pluginLoadFailed(PluginInfo pluginInfo)	Called if plugin load wasn't successful
void	pluginResourcesCleaned(PluginInfo pluginInfo)	Called after plugin resources are cleaned.
void	pluginUnloaded(PluginInfo pluginInfo)	Called after plugin unloaded successfully.
void	pluginUnloadFailed(PluginInfo pluginInfo)	Called is plugin unload wasn't successful.

Method Detail

beforePluginLoaded

void beforePluginLoaded(@NotNull
                        PluginInfo pluginInfo)

Called before plugin load is started. NB: during server startup plugins are loading concurrently and beforePluginLoaded(PluginInfo) will be triggered for all plugins before loading any of them.

Parameters:

pluginInfo -

pluginLoaded

void pluginLoaded(@NotNull
                  PluginData pluginData)

Called after plugin is loaded successfully. Spring context is already created and filled and should not be changed in the listener. NB: during server startup plugins are loading concurrently and pluginLoaded(PluginData) will be triggered for all plugins at the same time.

Parameters:

pluginData -

pluginLoadedInRuntime

void pluginLoadedInRuntime(@NotNull
                           PluginData pluginData)

the same as #pluginLoaded but this method won't be called when all plugins are loading during server startup*

Parameters:

pluginData -

Since:

2023.05.1

pluginLoadFailed

void pluginLoadFailed(@NotNull
                      PluginInfo pluginInfo)

Called if plugin load wasn't successful

Parameters:

pluginInfo -

beforePluginUnloaded

void beforePluginUnloaded(@NotNull
                          PluginInfo pluginInfo)

Called before plugin unload is started. Not triggered when shutting down the server and shouldn't be used for plugin resources cleanup.
For plugin resources cleanup use ServerListener.serverShutdown().

Parameters:

pluginInfo -

pluginResourcesCleaned

void pluginResourcesCleaned(@NotNull
                            PluginInfo pluginInfo)

Called after plugin resources are cleaned. Could be used to clean caches and remove spring context references. Not triggered when shutting down the server.

Parameters:

pluginInfo -

pluginUnloaded

void pluginUnloaded(@NotNull
                    PluginInfo pluginInfo)

Called after plugin unloaded successfully. PluginStateProvider now treats the plugin as unloaded. Not triggered when shutting down the server.

Parameters:

pluginInfo -

pluginUnloadFailed

void pluginUnloadFailed(@NotNull
                        PluginInfo pluginInfo)

Called is plugin unload wasn't successful. PluginStateProvider will still treat the plugin as loaded. Not triggered when shutting down the server.

Parameters:

pluginInfo -