com.atlassian.plugin.loaders

Class ForwardingPluginLoader

java.lang.Object

com.google.common.collect.ForwardingObject

com.atlassian.plugin.loaders.ForwardingPluginLoader

All Implemented Interfaces:

DiscardablePluginLoader, DynamicPluginLoader, PluginLoader

Direct Known Subclasses:

PermissionCheckingPluginLoader

public class ForwardingPluginLoader
extends com.google.common.collect.ForwardingObject
implements DynamicPluginLoader, DiscardablePluginLoader

Constructor Summary

Constructors

Constructor and Description
ForwardingPluginLoader(PluginLoader delegate)

Method Summary

Modifier and Type	Method and Description
String	canLoad(PluginArtifact pluginArtifact) Determines if this loader can load the jar.
ModuleDescriptor<?>	createModule(Plugin plugin, org.dom4j.Element module, ModuleDescriptorFactory moduleDescriptorFactory) If this loader is capable of loading a plugin of the type passed, attempt to create a module descriptor.
protected PluginLoader	delegate()
void	discardPlugin(Plugin plugin) Notify the PluginLoader that the system will not be loading the given plugin.
boolean	isDynamicPluginLoader()
Iterable<Plugin>	loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory) Loads all plugins that can be installed in the plugin system.
Iterable<Plugin>	loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory) Load all newly found plugins that can be installed in the plugin system.
void	removePlugin(Plugin plugin) Remove a specific plugin
boolean	supportsAddition()
boolean	supportsRemoval()

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingPluginLoader

public ForwardingPluginLoader(PluginLoader delegate)

Method Detail

delegate

protected final PluginLoader delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

loadAllPlugins

public Iterable<Plugin> loadAllPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
                                throws PluginParseException

Description copied from interface: PluginLoader

Loads all plugins that can be installed in the plugin system.

Specified by:

loadAllPlugins in interface PluginLoader

Parameters:

moduleDescriptorFactory - the factory for module descriptors

Returns:

the list of found plugins, may be empty

Throws:

PluginParseException - if any error occurred loading plugins

loadFoundPlugins

public Iterable<Plugin> loadFoundPlugins(ModuleDescriptorFactory moduleDescriptorFactory)
                                  throws PluginParseException

Description copied from interface: PluginLoader

Load all newly found plugins that can be installed in the plugin system. Only plugins not previously loaded will be added.

Specified by:

loadFoundPlugins in interface PluginLoader

Parameters:

moduleDescriptorFactory - the factory for module descriptors

Returns:

a list of newly discovered plugins since the last time plugins were loaded

Throws:

PluginParseException - if any error occurred loading plugins

supportsAddition

public boolean supportsAddition()

Specified by:

supportsAddition in interface PluginLoader

Returns:

true if this PluginLoader tracks whether or not plugins are added to it.

supportsRemoval

public boolean supportsRemoval()

Specified by:

supportsRemoval in interface PluginLoader

Returns:

true if this PluginLoader tracks whether or not plugins are removed from it.

removePlugin

public void removePlugin(Plugin plugin)
                  throws PluginException

Description copied from interface: PluginLoader

Remove a specific plugin

Specified by:

removePlugin in interface PluginLoader

Throws:

PluginException

isDynamicPluginLoader

public boolean isDynamicPluginLoader()

Specified by:

isDynamicPluginLoader in interface PluginLoader

Returns:

true if this plugin loader can load plugins dynamically

createModule

public ModuleDescriptor<?> createModule(Plugin plugin,
                                        org.dom4j.Element module,
                                        ModuleDescriptorFactory moduleDescriptorFactory)

Description copied from interface: PluginLoader

If this loader is capable of loading a plugin of the type passed, attempt to create a module descriptor. Add that module descriptor to the plugin.

If capable, always return a ModuleDescriptor, even if it indicates a failure case. Caller is responsible for handling exceptional ModuleDescriptor.

Specified by:

createModule in interface PluginLoader

Parameters:

plugin - that the module will be added to

module - to create

moduleDescriptorFactory - basic factory, may be overridden

Returns:

null if incapable of creating

canLoad

public String canLoad(PluginArtifact pluginArtifact)
               throws PluginParseException

Description copied from interface: DynamicPluginLoader

Determines if this loader can load the jar.

Specified by:

canLoad in interface DynamicPluginLoader

Parameters:

pluginArtifact - The jar to test

Returns:

The plugin key, null if it cannot load the jar

Throws:

PluginParseException - If there are exceptions parsing the plugin configuration

discardPlugin

public void discardPlugin(Plugin plugin)

Description copied from interface: DiscardablePluginLoader

Notify the PluginLoader that the system will not be loading the given plugin. This instructs the PluginLoader to discard any resources associated with the Plugin.

Specified by:

discardPlugin in interface DiscardablePluginLoader