Package jetbrains.buildServer.plugins

Interface PluginsOriginalPackages

All Known Implementing Classes:

PluginsOriginalPackagesImpl

public interface PluginsOriginalPackages

Stores mapping between packed plugin zip archives and unpacked plugin roots.

Method Summary

Modifier and Type	Method	Description
String	findOriginalPackageLocation(PluginInfo pluginInfo)
String	findUnpackedLocation(String pluginPackageAbsolutePath)
boolean	originalPackageExists(PluginInfo pluginInfo)
void	pluginOriginalPackageRemoved(String originalPackageAbsolutePath)	Mark that original package was removed.
void	pluginUnpacked(String originalPackageAbsolutePath, String pluginRootAbsolutePath)	Saves mapping between original plugin package and its plugin root
void	pluginUpdated(String originalPackageAbsolutePath, String pluginRootAbsolutePath)	Removes old mapping between original plugin package and root and put new mapping.
void	pluginWithoutZipLoaded(String pluginRootAbsolutePath)	Saves same mapping (plugin root -> plugin root) for cases when plugin is loaded without zip.

Method Detail

pluginOriginalPackageRemoved

void pluginOriginalPackageRemoved(@NotNull
                                  String originalPackageAbsolutePath)

Mark that original package was removed. Plugin with removed original package could be still loaded and should be shown in the UI appropriately.

Parameters:

originalPackageAbsolutePath - Absolute path to deleted package

pluginUnpacked

void pluginUnpacked(@NotNull
                    String originalPackageAbsolutePath,
                    @NotNull
                    String pluginRootAbsolutePath)

Saves mapping between original plugin package and its plugin root

Parameters:

originalPackageAbsolutePath - Absolute path to package

pluginRootAbsolutePath - Absolute path to plugin root

pluginWithoutZipLoaded

void pluginWithoutZipLoaded(@NotNull
                            String pluginRootAbsolutePath)

Saves same mapping (plugin root -> plugin root) for cases when plugin is loaded without zip. For example plugin directory is stored in plugins zip folder

Parameters:

pluginRootAbsolutePath - Absolute path to plugin root

pluginUpdated

void pluginUpdated(@NotNull
                   String originalPackageAbsolutePath,
                   @NotNull
                   String pluginRootAbsolutePath)

Removes old mapping between original plugin package and root and put new mapping. Invocation of this method is thread-safe equivalent for #pluginOriginalPackageRemoved and #pluginUnpacked

Parameters:

originalPackageAbsolutePath - Absolute path to package

pluginRootAbsolutePath - Absolute path to plugin root

originalPackageExists

boolean originalPackageExists(@NotNull
                              PluginInfo pluginInfo)

Parameters:

pluginInfo -

Returns:

true only if the original package (zip file) of the plugin still exists on the disk. false if it was removed (or overwritten)

findOriginalPackageLocation

@Nullable
String findOriginalPackageLocation(@NotNull
                                   PluginInfo pluginInfo)

Parameters:

pluginInfo -

Returns:

Absolute path of this plugin package

findUnpackedLocation

@Nullable
String findUnpackedLocation(@NotNull
                            String pluginPackageAbsolutePath)

Parameters:

pluginPackageAbsolutePath - Absolute path to original package

Returns:

Absolute path to the plugin root if this plugin was unpacked