io.jenkins.tools.pluginmanager.impl

Class PluginManager

java.lang.Object

io.jenkins.tools.pluginmanager.impl.PluginManager

public class PluginManager
extends Object

Constructor Summary

Constructors

Constructor and Description
PluginManager(Config cfg)

Method Summary

Modifier and Type	Method and Description
Map<String,Plugin>	bundledPlugins() Finds the plugins and their versions bundled in the war file specified in the Config class.
void	checkVersionCompatibility(hudson.util.VersionNumber jenkinsVersion, List<Plugin> pluginsToBeDownloaded) Checks that required Jenkins version of all plugins to be downloaded is less than the Jenkins version in the user specified Jenkins war file
boolean	downloadPlugin(Plugin plugin, File location) Downloads a plugin, skipping if already installed or bundled in the war.
void	downloadPlugins(List<Plugin> plugins) Downloads a list of plugins.
boolean	downloadToFile(String urlString, Plugin plugin, File fileLocation) Downloads a plugin from a url to a file.
boolean	downloadToFile(String urlString, Plugin plugin, File fileLocation, int maxRetries) Downloads a plugin from a url to a file.
Map<String,Plugin>	findEffectivePlugins(List<Plugin> pluginsToBeDownloaded) Finds the final set of plugins that have been either been installed or will be downloaded.
Map<String,Plugin>	findPluginsAndDependencies(List<Plugin> requestedPlugins) Given a list of plugins, finds the recursive set of all dependent plugins.
List<Plugin>	findPluginsToDownload(Map<String,Plugin> requestedPlugins) Compares the list of all requested plugins to the currently installed plugins to determine the final list of plugins that will be downloaded
String	getAttributeFromManifest(File file, String key) Deprecated. Use ManifestTools.getAttributeFromManifest(File, String)
List<Plugin>	getFailedPlugins() Gets the list of failed plugins
String	getJenkinsUCLatest() Gets the update center url string
hudson.util.VersionNumber	getJenkinsVersion() Gets Jenkins version using one of the available methods.
hudson.util.VersionNumber	getJenkinsVersionFromWar() Gets the Jenkins version from the manifest in the Jenkins war specified in the Config class
org.json.JSONObject	getJson(String urlString) Deprecated. see getJson(URL, String)
org.json.JSONObject	getJson(URL url, String cacheKey) Retrieves JSON from a URL and caches it
hudson.util.VersionNumber	getLatestPluginVersion(String pluginName) Retrieves the latest available version of a specified plugin.
List<Plugin>	getLatestVersionsOfPlugins(List<Plugin> plugins) Takes a list of plugins and returns the latest version Returns existing version if no update
org.json.JSONArray	getPluginDependencyJsonArray(Plugin plugin, org.json.JSONObject ucJson) Gets the JSONArray containing plugin a
String	getPluginDownloadUrl(Plugin plugin) Determines the plugin download url.
String	getPluginVersion(File file) Finds the plugin version by reading the manifest of a .hpi or .jpi file
Map<String,List<SecurityWarning>>	getSecurityWarnings() Gets the security warnings for plugins from the update center json and creates a list of all the security warnings
void	getUCJson(hudson.util.VersionNumber jenkinsVersion) Gets update center json, which is later used to determine plugin dependencies and security warnings
Map<String,Plugin>	installedPlugins() Finds all the plugins and their versions currently in the plugin directory specified in the Config class
void	listPlugins() Lists installed plugins, bundled plugins, set of all recurively determined requested plugins, which plugins will actually be downloaded based on the requested plugins and currently installed plugins, and the effective plugin set, which includes all currently installed plugins and plugins that will be downloaded by the tool
void	logPlugins(String description, List<Plugin> plugins) Given a list of plugins and a description, prints them out
void	logVerbose(String message) Outputs information to the console if verbose option was set to true
void	outputPluginReplacementInfo(Plugin lowerVersion, Plugin higherVersion) Outputs information about a lower version of a plugin being replaced by a higher version
List<Plugin>	resolveDependenciesFromJson(Plugin plugin, org.json.JSONObject pluginJson) Given a plugin and json that contains plugin information, determines the dependencies and returns the list of dependencies.
List<Plugin>	resolveDependenciesFromManifest(Plugin plugin) Resolves direct dependencies from downloaded plugin manifest.
List<Plugin>	resolveDirectDependencies(Plugin plugin) Finds the dependencies for plugins by either resolving the information from the manifest or update center json.
Map<String,Plugin>	resolveRecursiveDependencies(Plugin plugin) Finds all recursive dependencies for a given plugin.
void	setAllPluginsAndDependencies(Map<String,Plugin> allPluginsAndDependencies) Sets all plugins and their recursive dependencies
void	setAllSecurityWarnings(Map<String,List<SecurityWarning>> securityWarnings) Sets the security warnings
void	setBundledPluginVersions(Map<String,Plugin> bundledPlugins) Sets the bundled plugins
void	setCm(CacheManager cm)
void	setEffectivePlugins(Map<String,Plugin> effectivePlugins) Sets the list of effective plugins
void	setExperimentalPlugins(org.json.JSONObject experimentalPlugins) Sets the json object containing latest experimental plugin information
void	setExperimentalUcJson(org.json.JSONObject experimentalUcJson) Sets the json object containing latest experimental plugin information
void	setInstalledPluginVersions(Map<String,Plugin> installedPlugins) Sets the installed plugins
void	setJenkinsUCLatest(String updateCenterLatest) Sets the update center url string
void	setLatestUcJson(org.json.JSONObject latestUcJson) Sets the latest update center json
void	setLatestUcPlugins(org.json.JSONObject latestPlugins) Sets the json object containing latest plugin information
void	setPluginInfoJson(org.json.JSONObject pluginInfoJson) Sets the plugin version json
void	setPluginsToBeDownloaded(List<Plugin> pluginsToBeDownloaded) Sets the list of plugins to be downloaded
void	showAllSecurityWarnings() Prints out all security warnings if isShowAllWarnings is set to true in the config file
void	showSpecificSecurityWarnings(List<Plugin> plugins) Prints out security warning information for a list of plugins if isShowWarnings is set to true in the config file
void	start() Drives the process to download plugins.
void	start(boolean downloadUc) Drives the process to download plugins.
boolean	warningExists(Plugin plugin) Checks if a security warning exists for a plugin and its version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginManager

public PluginManager(Config cfg)

Method Detail

start

public void start()

Drives the process to download plugins. Calls methods to find installed plugins, download plugins, and output the failed plugins

start

public void start(boolean downloadUc)

Drives the process to download plugins. Calls methods to find installed plugins, download plugins, and output the failed plugins.

Parameters:

downloadUc - false to disable Update Center and other external resources download. In such case the update center metadata should be provided by API.

Since:

TODO

findPluginsToDownload

public List<Plugin> findPluginsToDownload(Map<String,Plugin> requestedPlugins)

Compares the list of all requested plugins to the currently installed plugins to determine the final list of plugins that will be downloaded

Parameters:

requestedPlugins - list of all requested plugins, determined from the highest required versions of the initial user requested plugins and their recursive dependencies

Returns:

list of plugins that will be downloaded when taking into account the already installed plugins and the highest required versions of the same plugin

findEffectivePlugins

public Map<String,Plugin> findEffectivePlugins(List<Plugin> pluginsToBeDownloaded)

Finds the final set of plugins that have been either been installed or will be downloaded. If a plugin is in more than one set of the already installed plugins, bundled plugins, or plugins that will be installed, the highest version of the plugin is taken.

Parameters:

pluginsToBeDownloaded - list of plugins and recursive dependencies requested by user

Returns:

set of plugins that is downloaded or will be downloaded

listPlugins

public void listPlugins()

Lists installed plugins, bundled plugins, set of all recurively determined requested plugins, which plugins will actually be downloaded based on the requested plugins and currently installed plugins, and the effective plugin set, which includes all currently installed plugins and plugins that will be downloaded by the tool

logPlugins

public void logPlugins(String description,
                       List<Plugin> plugins)

Given a list of plugins and a description, prints them out

Parameters:

description - string describing plugins to be printed

plugins - list of plugins to be output

getSecurityWarnings

public Map<String,List<SecurityWarning>> getSecurityWarnings()

Gets the security warnings for plugins from the update center json and creates a list of all the security warnings

Returns:

map of plugins and their security warnings

showAllSecurityWarnings

public void showAllSecurityWarnings()

Prints out all security warnings if isShowAllWarnings is set to true in the config file

showSpecificSecurityWarnings

public void showSpecificSecurityWarnings(List<Plugin> plugins)

Prints out security warning information for a list of plugins if isShowWarnings is set to true in the config file

Parameters:

plugins - list of plugins for which to see security warnings

getLatestVersionsOfPlugins

public List<Plugin> getLatestVersionsOfPlugins(List<Plugin> plugins)

Takes a list of plugins and returns the latest version Returns existing version if no update

Parameters:

plugins - updated list of plugins

Returns:

latest plugin versions

warningExists

public boolean warningExists(Plugin plugin)

Checks if a security warning exists for a plugin and its version. If that plugin version is affected by a security warning, adds the security warning to the list of security warnings for plugin

Parameters:

plugin - to check for security warning

Returns:

true if security warning for plugin exists, false otherwise

checkVersionCompatibility

public void checkVersionCompatibility(hudson.util.VersionNumber jenkinsVersion,
                                      List<Plugin> pluginsToBeDownloaded)

Checks that required Jenkins version of all plugins to be downloaded is less than the Jenkins version in the user specified Jenkins war file

Parameters:

pluginsToBeDownloaded - list of plugins to check version compatibility with the Jenkins version

downloadPlugins

public void downloadPlugins(List<Plugin> plugins)

Downloads a list of plugins. Plugins will be downloaded to a temporary directory, and then copied over to the final destination.

Parameters:

plugins - list of plugins to download

findPluginsAndDependencies

public Map<String,Plugin> findPluginsAndDependencies(List<Plugin> requestedPlugins)

Given a list of plugins, finds the recursive set of all dependent plugins. If multiple plugins rely on different versions of the same plugin, the higher version required will replace the lower version dependency

Parameters:

requestedPlugins - list of plugins to find all dependencies for

Returns:

set of all requested plugins and their recursive dependencies

outputPluginReplacementInfo

public void outputPluginReplacementInfo(Plugin lowerVersion,
                                        Plugin higherVersion)

Outputs information about a lower version of a plugin being replaced by a higher version

Parameters:

lowerVersion - lower version of plugin

higherVersion - higher version of plugin

getJson

@Deprecated
public org.json.JSONObject getJson(String urlString)

Deprecated. see getJson(URL, String)

Gets the json object at the given url

Parameters:

urlString - string representing the url from which to get the json object

Returns:

json object

getJson

public org.json.JSONObject getJson(URL url,
                                   String cacheKey)

Retrieves JSON from a URL and caches it

Parameters:

url - the url to retrieve json from

cacheKey - a key to use for caching i.e. 'update-center'

Returns:

the JSON

getUCJson

public void getUCJson(hudson.util.VersionNumber jenkinsVersion)

Gets update center json, which is later used to determine plugin dependencies and security warnings

Parameters:

jenkinsVersion - the version of Jenkins to use

getPluginDependencyJsonArray

public org.json.JSONArray getPluginDependencyJsonArray(Plugin plugin,
                                                       org.json.JSONObject ucJson)

Gets the JSONArray containing plugin a

Parameters:

plugin - to get depedencies for

ucJson - update center json from which to parse dependencies

Returns:

JSONArray containing plugin dependencies

getLatestPluginVersion

public hudson.util.VersionNumber getLatestPluginVersion(String pluginName)

Retrieves the latest available version of a specified plugin.

Parameters:

pluginName - the name of the plugin

Returns:

latest version of the specified plugin

Throws:

IllegalStateException - Update Center JSON has not been retrieved yet

resolveDependenciesFromManifest

public List<Plugin> resolveDependenciesFromManifest(Plugin plugin)

Resolves direct dependencies from downloaded plugin manifest. Done for plugins in which dependencies can't be determined via easily via json, such as when a user downloads a plugin directly from url or incremental plugins, or in other cases when getting information from json fails

Parameters:

plugin - plugin to resolve direct dependencies for

Returns:

list of dependencies that were parsed from the plugin's manifest file

resolveDependenciesFromJson

public List<Plugin> resolveDependenciesFromJson(Plugin plugin,
                                                org.json.JSONObject pluginJson)

Given a plugin and json that contains plugin information, determines the dependencies and returns the list of dependencies. Optional dependencies will be excluded.

Parameters:

plugin - for which to find dependencies

pluginJson - json that will be parsed to find requested plugin's dependencies

Returns:

list of plugin's dependencies, or null if dependencies are unable to be determined

resolveDirectDependencies

public List<Plugin> resolveDirectDependencies(Plugin plugin)

Finds the dependencies for plugins by either resolving the information from the manifest or update center json. If the requested plugin has a url from which it will be downloaded (by default if a plugin has a url, that will override using the version to download the plugin), nothing is done to try to determine the plugin version which might be used to find dependency information in the update center json; instead, the plugin manifest is used to find the dependencies. Similarly, incremental plugins don't have their dependencies listed anywhere, so the plugin manifest will also be used for these. If a plugin's dependencies can be determined by looking at update center json, it will. If that fails, the manifest will be used.

Parameters:

plugin - for which to find and download dependencies

Returns:

plugin's list of direct dependencies

resolveRecursiveDependencies

public Map<String,Plugin> resolveRecursiveDependencies(Plugin plugin)

Finds all recursive dependencies for a given plugin. If the same plugin is required by different plugins, the highest required version will be taken.

Parameters:

plugin - to resolve dependencies for

Returns:

map of plugin names and plugins representing all of the dependencies of the requested plugin, including the requested plugin itself

downloadPlugin

public boolean downloadPlugin(Plugin plugin,
                              @CheckForNull
                              File location)

Downloads a plugin, skipping if already installed or bundled in the war. A plugin's dependencies will be resolved after the plugin is downloaded.

Parameters:

plugin - to download

location - location to download plugin to. If location is set to null, will download to the plugin folder otherwise will download to the temporary location specified.

Returns:

boolean signifying if plugin was successful

getPluginDownloadUrl

public String getPluginDownloadUrl(Plugin plugin)

Determines the plugin download url. If a url is specified from the CLI or plugins file, that url will be used and the plugin verison and Jenkins version will be ignored. If no url is specified, the url will be determined from the Jenkins update center and plugin name.

Parameters:

plugin - to download

Returns:

url to download plugin from

downloadToFile

public boolean downloadToFile(String urlString,
                              Plugin plugin,
                              @CheckForNull
                              File fileLocation)

Downloads a plugin from a url to a file.

Parameters:

urlString - String url to download the plugin from

plugin - Plugin object representing plugin to be downloaded

fileLocation - contains the temp file if the plugin is downloaded so that dependencies can be parsed from the manifest, if the plugin will be downloaded to the plugin download location, this will be null

Returns:

true if download is successful, false otherwise

downloadToFile

public boolean downloadToFile(String urlString,
                              Plugin plugin,
                              @CheckForNull
                              File fileLocation,
                              int maxRetries)

Downloads a plugin from a url to a file.

Parameters:

urlString - String url to download the plugin from

plugin - Plugin object representing plugin to be downloaded

fileLocation - contains the temp file if the plugin is downloaded so that dependencies can be parsed from the manifest, if the plugin will be downloaded to the plugin download location, this will be null

maxRetries - Maximum number of times to retry the download before failing

Returns:

true if download is successful, false otherwise

getJenkinsVersion

@CheckForNull
public hudson.util.VersionNumber getJenkinsVersion()

Gets Jenkins version using one of the available methods.

Returns:

Jenkins version or null if it cannot be determined

getJenkinsVersionFromWar

@CheckForNull
public hudson.util.VersionNumber getJenkinsVersionFromWar()

Gets the Jenkins version from the manifest in the Jenkins war specified in the Config class

Returns:

Jenkins version or null if the version cannot be determined

getPluginVersion

public String getPluginVersion(File file)

Finds the plugin version by reading the manifest of a .hpi or .jpi file

Parameters:

file - plugin .hpi or .jpi of which to get the version

Returns:

plugin version

getAttributeFromManifest

@Deprecated
public String getAttributeFromManifest(File file,
                                                    String key)

Deprecated. Use ManifestTools.getAttributeFromManifest(File, String)

installedPlugins

public Map<String,Plugin> installedPlugins()

Finds all the plugins and their versions currently in the plugin directory specified in the Config class

Returns:

list of names of plugins that are installed in the plugin directory

bundledPlugins

public Map<String,Plugin> bundledPlugins()

Finds the plugins and their versions bundled in the war file specified in the Config class. Does not include detached plugins.

Returns:

list of names of plugins that are currently installed in the war

getJenkinsUCLatest

public String getJenkinsUCLatest()

Gets the update center url string

Returns:

Jenkins update center url string

setJenkinsUCLatest

public void setJenkinsUCLatest(String updateCenterLatest)

Sets the update center url string

Parameters:

updateCenterLatest - String in which to set the update center url string

setInstalledPluginVersions

public void setInstalledPluginVersions(Map<String,Plugin> installedPlugins)

Sets the installed plugins

Parameters:

installedPlugins - hashmap of plugin names and versions of plugins that already exist in the plugin download directory

setBundledPluginVersions

public void setBundledPluginVersions(Map<String,Plugin> bundledPlugins)

Sets the bundled plugins

Parameters:

bundledPlugins - hashmap of plugin names and version numbers representing the bundled plugins

setAllPluginsAndDependencies

public void setAllPluginsAndDependencies(Map<String,Plugin> allPluginsAndDependencies)

Sets all plugins and their recursive dependencies

Parameters:

allPluginsAndDependencies - map of plugin name - plugin pairs corresponding the requested plugins and their recursive dependencies

setEffectivePlugins

public void setEffectivePlugins(Map<String,Plugin> effectivePlugins)

Sets the list of effective plugins

Parameters:

effectivePlugins - map of plugin name - plugin pairs corresponding to the highest required versions of the requested plugins, their dependencies, and the already installed plugins

setPluginsToBeDownloaded

public void setPluginsToBeDownloaded(List<Plugin> pluginsToBeDownloaded)

Sets the list of plugins to be downloaded

Parameters:

pluginsToBeDownloaded - list of all plugins that will actually be downloaded after plugin dependencies have been resolved and already installed plugins are taken into consideration

logVerbose

public void logVerbose(String message)

Outputs information to the console if verbose option was set to true

Parameters:

message - informational string to output

setLatestUcJson

public void setLatestUcJson(org.json.JSONObject latestUcJson)

Sets the latest update center json

Parameters:

latestUcJson - json to set latest update center to

setLatestUcPlugins

public void setLatestUcPlugins(org.json.JSONObject latestPlugins)

Sets the json object containing latest plugin information

Parameters:

latestPlugins - JSONObject containing info for latest plugins

setExperimentalUcJson

public void setExperimentalUcJson(org.json.JSONObject experimentalUcJson)

Sets the json object containing latest experimental plugin information

Parameters:

experimentalUcJson - JSONObject containing info for latest and experimental plugins

setExperimentalPlugins

public void setExperimentalPlugins(org.json.JSONObject experimentalPlugins)

Sets the json object containing latest experimental plugin information

Parameters:

experimentalPlugins - JSONObject containing info for latest experimental plugins

setAllSecurityWarnings

public void setAllSecurityWarnings(Map<String,List<SecurityWarning>> securityWarnings)

Sets the security warnings

Parameters:

securityWarnings - map of the plugin name to the list of security warnings for that plugin

setPluginInfoJson

public void setPluginInfoJson(org.json.JSONObject pluginInfoJson)

Sets the plugin version json

Parameters:

pluginInfoJson - json to set plugin version info to

setCm

public void setCm(CacheManager cm)

getFailedPlugins

public List<Plugin> getFailedPlugins()

Gets the list of failed plugins

Returns:

list of failed plugins