io.apiman.manager.api.core.plugin

Class AbstractPluginRegistry

java.lang.Object

io.apiman.manager.api.core.plugin.AbstractPluginRegistry

All Implemented Interfaces:

IPluginRegistry

public abstract class AbstractPluginRegistry
extends Object
implements IPluginRegistry

Serves as a common base class for concrete implementations of IPluginRegistry.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
AbstractPluginRegistry() Constructor.
AbstractPluginRegistry(File pluginsDir) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected io.apiman.common.plugin.PluginClassLoader	createPluginClassLoader(File pluginFile) Creates a plugin classloader for the given plugin file.
protected boolean	downloadFromMavenRepo(File pluginFile, io.apiman.common.plugin.PluginCoordinates coordinates, URL mavenRepoUrl) Tries to download the plugin from the given remote maven repository.
protected void	downloadPlugin(File pluginFile, io.apiman.common.plugin.PluginCoordinates coordinates) Downloads the plugin via its maven GAV information.
protected Set<URL>	getMavenRepositories() A valid set of remove maven repository URLs.
io.apiman.common.plugin.Plugin	loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates) Loads a plugin with the given coordinates.
void	setPluginsDir(File pluginsDir)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPluginRegistry

public AbstractPluginRegistry()

Constructor.

AbstractPluginRegistry

public AbstractPluginRegistry(File pluginsDir)

Constructor.

Parameters:

pluginsDir - the plugin's directory

Method Detail

loadPlugin

public io.apiman.common.plugin.Plugin loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates)
                                          throws InvalidPluginException

Description copied from interface: IPluginRegistry

Loads a plugin with the given coordinates.

Specified by:

loadPlugin in interface IPluginRegistry

Parameters:

coordinates - plugin coordinates

Returns:

the loaded plugin

Throws:

InvalidPluginException - the plugin is invalid

See Also:

IPluginRegistry.loadPlugin(io.apiman.common.plugin.PluginCoordinates)

createPluginClassLoader

protected io.apiman.common.plugin.PluginClassLoader createPluginClassLoader(File pluginFile)
                                                                     throws IOException

Creates a plugin classloader for the given plugin file.

Parameters:

pluginFile -

Throws:

IOException

downloadPlugin

protected void downloadPlugin(File pluginFile,
                  io.apiman.common.plugin.PluginCoordinates coordinates)

Downloads the plugin via its maven GAV information. This will first look in the local .m2 directory. If the plugin is not found there, then it will try to download the plugin from one of the configured remote maven repositories.

Parameters:

pluginFile -

coordinates -

downloadFromMavenRepo

protected boolean downloadFromMavenRepo(File pluginFile,
                            io.apiman.common.plugin.PluginCoordinates coordinates,
                            URL mavenRepoUrl)

Tries to download the plugin from the given remote maven repository.

Parameters:

pluginFile -

coordinates -

mavenRepoUrl -

getMavenRepositories

protected Set<URL> getMavenRepositories()

A valid set of remove maven repository URLs.

setPluginsDir

public void setPluginsDir(File pluginsDir)

Parameters:

pluginsDir - the pluginsDir to set