io.apiman.gateway.engine.impl

Class DefaultPluginRegistry

java.lang.Object

io.apiman.gateway.engine.impl.DefaultPluginRegistry

All Implemented Interfaces:

IPluginRegistry

public class DefaultPluginRegistry
extends Object
implements IPluginRegistry

A simple plugin registry that stores plugins in a temporary location. This implementation shouldn't really be used except for testing and perhaps getting started with embedding the policy engine. The reasons to not use this implementation include: 1) not truly asynchronous (not good if embedding in a true async platform) 2) stores downloaded plugins in java.io.tmp 3) does not remember where it put plugins, so will re-download them often

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
DefaultPluginRegistry() Constructor.
DefaultPluginRegistry(File pluginsDir, Set<URL> pluginRepositories) Constructor.
DefaultPluginRegistry(Map<String,String> configMap) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyFromM2(File pluginFile, io.apiman.common.plugin.PluginCoordinates coordinates) Try to copy the plugin from the current user's .m2 directory.
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.
void	loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates, IAsyncResultHandler<io.apiman.common.plugin.Plugin> handler) Asynchronously loads a plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginRegistry

public DefaultPluginRegistry()

Constructor.

DefaultPluginRegistry

public DefaultPluginRegistry(Map<String,String> configMap)

Constructor.

Parameters:

configMap -

DefaultPluginRegistry

public DefaultPluginRegistry(File pluginsDir,
                     Set<URL> pluginRepositories)

Constructor.

Parameters:

pluginsDir -

Method Detail

loadPlugin

public void loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates,
              IAsyncResultHandler<io.apiman.common.plugin.Plugin> handler)

Description copied from interface: IPluginRegistry

Asynchronously loads a plugin.

Specified by:

loadPlugin in interface IPluginRegistry

See Also:

IPluginRegistry.loadPlugin(io.apiman.common.plugin.PluginCoordinates, io.apiman.gateway.engine.async.IAsyncResultHandler)

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

copyFromM2

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

Try to copy the plugin from the current user's .m2 directory. In production this should typically not do anything.

Parameters:

pluginFile -

coordinates -

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 -