hudson.model

Class UpdateSite.Plugin

java.lang.Object

hudson.model.UpdateSite.Entry

hudson.model.UpdateSite.Plugin

Enclosing class:

UpdateSite

public final class UpdateSite.Plugin
extends UpdateSite.Entry

Field Summary

Fields

Modifier and Type	Field and Description
String[]	categories Categories for grouping plugins, taken from labels assigned to wiki page.
String	compatibleSinceVersion Optional version # from which this plugin release is configuration-compatible.
Map<String,String>	dependencies Dependencies of this plugin, a name -> version mapping.
String	excerpt Optional excerpt string.
String	minimumJavaVersion Version of Java this plugin requires to run.
Map<String,String>	optionalDependencies Optional dependencies of this plugin.
String	requiredCore Version of Jenkins core this plugin was compiled against.
String	title Human readable title of the plugin, taken from Wiki page.
String	wiki Optional URL to the Wiki page that discusses this plugin.

Fields inherited from class hudson.model.UpdateSite.Entry

name, sourceId, url, version

Constructor Summary

Constructors

Constructor and Description
Plugin(String sourceId, net.sf.json.JSONObject o)

Method Summary

Modifier and Type	Method and Description
Future<UpdateCenter.UpdateCenterJob>	deploy()
Future<UpdateCenter.UpdateCenterJob>	deploy(boolean dynamicLoad) Schedules the installation of this plugin.
Future<UpdateCenter.UpdateCenterJob>	deploy(boolean dynamicLoad, UUID correlationId, List<PluginWrapper> batch) Schedules the installation of this plugin.
Future<UpdateCenter.UpdateCenterJob>	deployBackup() Schedules the downgrade of this plugin.
org.kohsuke.stapler.HttpResponse	doDowngrade() Performs the downgrade of the plugin.
org.kohsuke.stapler.HttpResponse	doInstall() Making the installation web bound.
org.kohsuke.stapler.HttpResponse	doInstallNow()
List<UpdateSite.Plugin>	getDependenciesIncompatibleWithInstalledVersion(PluginManager.MetadataCache cache) Get the list of incompatible dependencies (if there are any, as determined by isNeededDependenciesCompatibleWithInstalledVersion)
String	getDisplayName()
Set<UpdateSite.Plugin>	getIncompatibleParentPlugins()
PluginWrapper	getInstalled() If some version of this plugin is currently installed, return PluginWrapper.
List<UpdateSite.Plugin>	getNeededDependencies() Returns a list of dependent plugins which need to be installed or upgraded for this plugin to work.
VersionNumber	getNeededDependenciesMinimumJavaVersion() Returns the minimum Java version needed to use the plugin and all its dependencies.
VersionNumber	getNeededDependenciesRequiredCore()
Set<UpdateSite.Warning>	getWarnings()
boolean	hasIncompatibleParentPlugins()
boolean	hasWarnings()
void	install() Deprecated. as of 1.326 Use deploy().
boolean	isCompatible() Returns true if the plugin and its dependencies are fully compatible with the current installation This is set to restricted for now, since it is only being used by Jenkins UI at the moment.
boolean	isCompatible(PluginManager.MetadataCache cache)
boolean	isCompatibleWithInstalledVersion() If the plugin is already installed, and the new version of the plugin has a "compatibleSinceVersion" value (i.e., it's only directly compatible with that version or later), this will check to see if the installed version is older than the compatible-since version.
boolean	isForNewerHudson()
boolean	isForNewerJava() Returns true iff the plugin declares a minimum Java version and it's newer than what the Jenkins master is running on.
boolean	isNeededDependenciesCompatibleWithInstalledVersion() If at least some of the plugin's needed dependencies are already installed, and the new version of the needed dependencies plugin have a "compatibleSinceVersion" value (i.e., it's only directly compatible with that version or later), this will check to see if the installed version is older than the compatible-since version.
boolean	isNeededDependenciesCompatibleWithInstalledVersion(PluginManager.MetadataCache cache)
boolean	isNeededDependenciesForNewerJava() Returns true iff any of the plugin dependencies require a newer Java than Jenkins is running on.
boolean	isNeededDependenciesForNewerJenkins()
boolean	isNeededDependenciesForNewerJenkins(PluginManager.MetadataCache cache)
void	setIncompatibleParentPlugins(Set<UpdateSite.Plugin> incompatibleParentPlugins)

Methods inherited from class hudson.model.UpdateSite.Entry

getApi, getSha1, getSha256, getSha512, isNewerThan

Methods inherited from class java.lang.Object

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

Field Detail

wiki

@Exported
public final String wiki

Optional URL to the Wiki page that discusses this plugin.

title

@Exported
public final String title

Human readable title of the plugin, taken from Wiki page. Can be null.

beware of XSS vulnerability since this data comes from Wiki

excerpt

@Exported
public final String excerpt

Optional excerpt string.

compatibleSinceVersion

@Exported
public final String compatibleSinceVersion

Optional version # from which this plugin release is configuration-compatible.

requiredCore

@Exported
public final String requiredCore

Version of Jenkins core this plugin was compiled against.

minimumJavaVersion

@Exported
public final String minimumJavaVersion

Version of Java this plugin requires to run.

Since:

2.158

categories

@Exported
public final String[] categories

Categories for grouping plugins, taken from labels assigned to wiki page. Can be null.

dependencies

@Exported
public final Map<String,String> dependencies

Dependencies of this plugin, a name -> version mapping.

optionalDependencies

@Exported
public final Map<String,String> optionalDependencies

Optional dependencies of this plugin.

Constructor Detail

Plugin

@DataBoundConstructor
public Plugin(String sourceId,
                                    net.sf.json.JSONObject o)

Method Detail

getDisplayName

public String getDisplayName()

getInstalled

@Exported
public PluginWrapper getInstalled()

If some version of this plugin is currently installed, return PluginWrapper. Otherwise null.

isCompatible

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isCompatible()

Returns true if the plugin and its dependencies are fully compatible with the current installation This is set to restricted for now, since it is only being used by Jenkins UI at the moment.

Since:

2.175

isCompatible

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isCompatible(PluginManager.MetadataCache cache)

isCompatibleWithInstalledVersion

@Exported
public boolean isCompatibleWithInstalledVersion()

If the plugin is already installed, and the new version of the plugin has a "compatibleSinceVersion" value (i.e., it's only directly compatible with that version or later), this will check to see if the installed version is older than the compatible-since version. If it is older, it'll return false. If it's not older, or it's not installed, or it's installed but there's no compatibleSinceVersion specified, it'll return true.

getNeededDependencies

@Exported
public List<UpdateSite.Plugin> getNeededDependencies()

Returns a list of dependent plugins which need to be installed or upgraded for this plugin to work.

isForNewerHudson

public boolean isForNewerHudson()

isForNewerJava

public boolean isForNewerJava()

Returns true iff the plugin declares a minimum Java version and it's newer than what the Jenkins master is running on.

Since:

2.158

getNeededDependenciesRequiredCore

public VersionNumber getNeededDependenciesRequiredCore()

getNeededDependenciesMinimumJavaVersion

@CheckForNull
public VersionNumber getNeededDependenciesMinimumJavaVersion()

Returns the minimum Java version needed to use the plugin and all its dependencies.

Returns:

the minimum Java version needed to use the plugin and all its dependencies, or null if unspecified.

Since:

2.158

isNeededDependenciesForNewerJenkins

public boolean isNeededDependenciesForNewerJenkins()

isNeededDependenciesForNewerJenkins

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isNeededDependenciesForNewerJenkins(PluginManager.MetadataCache cache)

isNeededDependenciesForNewerJava

public boolean isNeededDependenciesForNewerJava()

Returns true iff any of the plugin dependencies require a newer Java than Jenkins is running on.

Since:

2.158

isNeededDependenciesCompatibleWithInstalledVersion

public boolean isNeededDependenciesCompatibleWithInstalledVersion()

If at least some of the plugin's needed dependencies are already installed, and the new version of the needed dependencies plugin have a "compatibleSinceVersion" value (i.e., it's only directly compatible with that version or later), this will check to see if the installed version is older than the compatible-since version. If it is older, it'll return false. If it's not older, or it's not installed, or it's installed but there's no compatibleSinceVersion specified, it'll return true.

isNeededDependenciesCompatibleWithInstalledVersion

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isNeededDependenciesCompatibleWithInstalledVersion(PluginManager.MetadataCache cache)

getDependenciesIncompatibleWithInstalledVersion

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<UpdateSite.Plugin> getDependenciesIncompatibleWithInstalledVersion(PluginManager.MetadataCache cache)

Get the list of incompatible dependencies (if there are any, as determined by isNeededDependenciesCompatibleWithInstalledVersion)

Since:

TODO

setIncompatibleParentPlugins

public void setIncompatibleParentPlugins(Set<UpdateSite.Plugin> incompatibleParentPlugins)

getIncompatibleParentPlugins

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Set<UpdateSite.Plugin> getIncompatibleParentPlugins()

hasIncompatibleParentPlugins

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean hasIncompatibleParentPlugins()

getWarnings

@CheckForNull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Set<UpdateSite.Warning> getWarnings()

Since:

2.40

hasWarnings

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public boolean hasWarnings()

Since:

2.40

install

@Deprecated
public void install()

Deprecated. as of 1.326 Use deploy().

deploy

public Future<UpdateCenter.UpdateCenterJob> deploy()

deploy

public Future<UpdateCenter.UpdateCenterJob> deploy(boolean dynamicLoad)

Schedules the installation of this plugin.

This is mainly intended to be called from the UI. The actual installation work happens asynchronously in another thread.

Parameters:

dynamicLoad - If true, the plugin will be dynamically loaded into this Jenkins. If false, the plugin will only take effect after the reboot. See UpdateCenter.isRestartRequiredForCompletion()

deploy

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Future<UpdateCenter.UpdateCenterJob> deploy(boolean dynamicLoad,
                                                                                                                          @CheckForNull
                                                                                                                          UUID correlationId,
                                                                                                                          @CheckForNull
                                                                                                                          List<PluginWrapper> batch)

Schedules the installation of this plugin.

This is mainly intended to be called from the UI. The actual installation work happens asynchronously in another thread.

Parameters:

dynamicLoad - If true, the plugin will be dynamically loaded into this Jenkins. If false, the plugin will only take effect after the reboot. See UpdateCenter.isRestartRequiredForCompletion()

correlationId - A correlation ID to be set on the job.

batch - if defined, a list of plugins to add to, which will be started later

deployBackup

public Future<UpdateCenter.UpdateCenterJob> deployBackup()

Schedules the downgrade of this plugin.

doInstall

public org.kohsuke.stapler.HttpResponse doInstall()
                                           throws IOException

Making the installation web bound.

Throws:

IOException

doInstallNow

public org.kohsuke.stapler.HttpResponse doInstallNow()
                                              throws IOException

Throws:

IOException

doDowngrade

public org.kohsuke.stapler.HttpResponse doDowngrade()
                                             throws IOException

Performs the downgrade of the plugin.

Throws:

IOException