io.jenkins.tools.pluginmanager.impl

Class PluginManager

java.lang.Object

io.jenkins.tools.pluginmanager.impl.PluginManager

public class PluginManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
PluginManager(Config cfg)

Method Summary

Modifier and Type	Method and Description
List<String>	bundledPlugins() Finds the plugins and their versions bundled in the war file specified in the Config class.
void	checkAndSetLatestUpdateCenter() Determines if there is an update center for the version of Jenkins in the war file.
void	downloadDependencies(List<Plugin> dependentPlugins) Downloads a list of dependencies.
boolean	downloadPlugin(Plugin plugin) 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) Downloads a plugin from a url
String	getAttributefromManifest(File file, String key)
String	getJenkinsUCLatest() Gets the update center url string
hudson.util.VersionNumber	getJenkinsVersion() Gets the Jenkins version
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) Gets the json object at the given url
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
void	getSecurityWarnings() Gets the security warnings for plugins from the update center json and creates a list of all the security warnings
void	getUCJson() Gets update center json, which is later used to determine plugin dependencies and security warnings
List<String>	installedPlugins() Finds all the plugins and their versions currently in the plugin directory specified in the Config class
void	outputFailedPlugins() Prints out plugins that failed to download.
void	resolveDependencies(Plugin plugin) Finds the dependencies for a plugins by using the update center plugin-versions json.
void	resolveDependenciesFromManifest(Plugin plugin) Resolves dependencies from downloaded plugin manifest.
void	setJenkinsUCLatest(String updateCenterLatest) Sets the update center url string
void	setJenkinsVersion(hudson.util.VersionNumber jenkinsVersion) Sets Jenkins Version.
void	showAllSecurityWarnings() Prints out all security warnings if isShowAllWarnings is set to true in the config file
void	start() Drives the process to download plugins.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

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

getSecurityWarnings

public void getSecurityWarnings()

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

showAllSecurityWarnings

public void showAllSecurityWarnings()

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

checkAndSetLatestUpdateCenter

public void checkAndSetLatestUpdateCenter()

Determines if there is an update center for the version of Jenkins in the war file. If so, sets jenkins update center url String to include Jenkins Version. Otherwise, sets update center url to match the update center in the configuration class

outputFailedPlugins

public void outputFailedPlugins()

Prints out plugins that failed to download. Exits with status of 1 if any plugins failed to download.

downloadPlugins

public void downloadPlugins(List<Plugin> plugins)

Downloads a list of plugins

Parameters:

plugins - list of plugins to download

getJson

public org.json.JSONObject getJson(String urlString)

Gets the json object at the given url

Parameters:

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

Returns:

json object

getUCJson

public void getUCJson()

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

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

resolveDependenciesFromManifest

public void resolveDependenciesFromManifest(Plugin plugin)

Resolves 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

Parameters:

plugin -

resolveDependencies

public void resolveDependencies(Plugin plugin)

Finds the dependencies for a plugins by using the update center plugin-versions json.

Parameters:

plugin - for which to find and download dependencies

downloadDependencies

public void downloadDependencies(List<Plugin> dependentPlugins)

Downloads a list of dependencies. Skips downloading plugins that are optional or have already been installed. If an installed version of a plugin is lower than the required version, will download the higher version of the plugin to replace the currently installed version.

Parameters:

dependentPlugins -

downloadPlugin

public boolean downloadPlugin(Plugin plugin)

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

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)

Downloads a plugin from a url

Parameters:

urlString - url to download the plugin from

plugin - Plugin object representing plugin to be downloaded

Returns:

true if download is successful, false otherwise

getAttributefromManifest

public String getAttributefromManifest(File file,
                                       String key)

getJenkinsVersionFromWar

public hudson.util.VersionNumber getJenkinsVersionFromWar()

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

Returns:

Jenkins version

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

installedPlugins

public List<String> 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 List<String> 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

setJenkinsVersion

public void setJenkinsVersion(hudson.util.VersionNumber jenkinsVersion)

Sets Jenkins Version. Jenkins version also set based on Jenkins war manifest

Parameters:

jenkinsVersion - version of Jenkins, used for checking/setting version specific update center

getJenkinsVersion

public hudson.util.VersionNumber getJenkinsVersion()

Gets the Jenkins version

Returns:

the Jenkins version

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