hudson

Class ClassicPluginStrategy

java.lang.Object

hudson.ClassicPluginStrategy

All Implemented Interfaces:

ExtensionPoint, PluginStrategy

public class ClassicPluginStrategy
extends Object
implements PluginStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassicPluginStrategy.DetachedPlugin Information about plugins that were originally in the core.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DISABLE_TRANSFORMER
static boolean	useAntClassLoader

Constructor Summary

Constructors

Constructor and Description
ClassicPluginStrategy(PluginManager pluginManager)

Method Summary

Modifier and Type	Method and Description
protected ClassLoader	createClassLoader(List<File> paths, ClassLoader parent) Deprecated.
protected ClassLoader	createClassLoader(List<File> paths, ClassLoader parent, Attributes atts) Creates the classloader that can load all the specified jar files and delegate to the given parent.
PluginWrapper	createPluginWrapper(File archive) Creates a plugin wrapper, which provides a management interface for the plugin
<T> List<ExtensionComponent<T>>	findComponents(Class<T> type, Hudson hudson) Find components of the given type using the assigned strategy.
static List<ClassicPluginStrategy.DetachedPlugin>	getDetachedPlugins() Get the list of all plugins that have ever been detached from Jenkins core.
static List<ClassicPluginStrategy.DetachedPlugin>	getDetachedPlugins(VersionNumber since) Get the list of plugins that have been detached since a specific Jenkins release version.
static List<PluginWrapper.Dependency>	getImpliedDependencies(String pluginName, String jenkinsVersion) Returns all the plugin dependencies that are implicit based on a particular Jenkins version
String	getShortName(File archive) Finds the plugin name without actually unpacking anything PluginStrategy.createPluginWrapper(java.io.File) would.
void	initializeComponents(PluginWrapper plugin) Optionally start services provided by the plugin.
static boolean	isDetachedPlugin(String pluginId) Is the named plugin a plugin that was detached from Jenkins at some point in the past.
void	load(PluginWrapper wrapper) Loads the plugin and starts it.
void	startPlugin(PluginWrapper plugin)
void	updateDependency(PluginWrapper depender, PluginWrapper dependee) Called when a plugin is installed, but there was already a plugin installed which optionally depended on that plugin.

Methods inherited from class java.lang.Object

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

Field Detail

useAntClassLoader

public static boolean useAntClassLoader

DISABLE_TRANSFORMER

public static boolean DISABLE_TRANSFORMER

Constructor Detail

ClassicPluginStrategy

public ClassicPluginStrategy(PluginManager pluginManager)

Method Detail

getShortName

public String getShortName(File archive)
                    throws IOException

Description copied from interface: PluginStrategy

Finds the plugin name without actually unpacking anything PluginStrategy.createPluginWrapper(java.io.File) would. Needed by PluginManager.dynamicLoad(java.io.File) to decide whether such a plugin is already installed.

Specified by:

getShortName in interface PluginStrategy

Returns:

the PluginWrapper.getShortName()

Throws:

IOException

createPluginWrapper

public PluginWrapper createPluginWrapper(File archive)
                                  throws IOException

Description copied from interface: PluginStrategy

Creates a plugin wrapper, which provides a management interface for the plugin

Specified by:

createPluginWrapper in interface PluginStrategy

Parameters:

archive - Either a directory that points to a pre-exploded plugin, or an jpi file, or an jpl file.

Throws:

IOException

getImpliedDependencies

@Nonnull
public static List<PluginWrapper.Dependency> getImpliedDependencies(String pluginName,
                                                                             String jenkinsVersion)

Returns all the plugin dependencies that are implicit based on a particular Jenkins version

Since:

2.0

createClassLoader

@Deprecated
protected ClassLoader createClassLoader(List<File> paths,
                                                    ClassLoader parent)
                                             throws IOException

Deprecated.

Throws:

IOException

createClassLoader

protected ClassLoader createClassLoader(List<File> paths,
                                        ClassLoader parent,
                                        Attributes atts)
                                 throws IOException

Creates the classloader that can load all the specified jar files and delegate to the given parent.

Throws:

IOException

getDetachedPlugins

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Nonnull
public static List<ClassicPluginStrategy.DetachedPlugin> getDetachedPlugins()

Get the list of all plugins that have ever been detached from Jenkins core.

Returns:

A List of ClassicPluginStrategy.DetachedPlugins.

getDetachedPlugins

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @Nonnull
public static List<ClassicPluginStrategy.DetachedPlugin> getDetachedPlugins(@Nonnull
                                                                                                                                                             VersionNumber since)

Get the list of plugins that have been detached since a specific Jenkins release version.

Parameters:

since - The Jenkins version.

Returns:

A List of ClassicPluginStrategy.DetachedPlugins.

isDetachedPlugin

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean isDetachedPlugin(@Nonnull
                                                                                                              String pluginId)

Is the named plugin a plugin that was detached from Jenkins at some point in the past.

Parameters:

pluginId - The plugin ID.

Returns:

true if the plugin is a plugin that was detached from Jenkins at some point in the past, otherwise false.

initializeComponents

public void initializeComponents(PluginWrapper plugin)

Description copied from interface: PluginStrategy

Optionally start services provided by the plugin. Should be called when all plugins are loaded.

Specified by:

initializeComponents in interface PluginStrategy

findComponents

public <T> List<ExtensionComponent<T>> findComponents(Class<T> type,
                                                      Hudson hudson)

Description copied from interface: PluginStrategy

Find components of the given type using the assigned strategy.

Specified by:

findComponents in interface PluginStrategy

Parameters:

type - The component type

hudson - The Hudson scope

Returns:

Sequence of components

load

public void load(PluginWrapper wrapper)
          throws IOException

Description copied from interface: PluginStrategy

Loads the plugin and starts it.

This should be done after all the classloaders are constructed for all the plugins, so that dependencies can be properly loaded by plugins.

Specified by:

load in interface PluginStrategy

Throws:

IOException

startPlugin

public void startPlugin(PluginWrapper plugin)
                 throws Exception

Throws:

Exception

updateDependency

public void updateDependency(PluginWrapper depender,
                             PluginWrapper dependee)

Description copied from interface: PluginStrategy

Called when a plugin is installed, but there was already a plugin installed which optionally depended on that plugin. The class loader of the existing depending plugin should be updated to load classes from the newly installed plugin.

Specified by:

updateDependency in interface PluginStrategy

Parameters:

depender - plugin depending on dependee.

dependee - newly loaded plugin.