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) Constructor.
DefaultPluginRegistry(File pluginsDir, Set<URL> pluginRepositories) Constructor.
DefaultPluginRegistry(Map<String,String> configMap) 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 void	downloadArtifactTo(URL artifactUrl, File pluginFile, IAsyncResultHandler<File> handler) Download the artifact at the given URL and store it locally into the given plugin file path.
protected void	downloadFromMavenRepo(io.apiman.common.plugin.PluginCoordinates coordinates, URL mavenRepoUrl, IAsyncResultHandler<File> handler) Tries to download the plugin from the given remote maven repository.
protected void	downloadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates, IAsyncResultHandler<File> handler) Downloads the plugin via its maven GAV information.
Future<IAsyncResult<io.apiman.common.plugin.Plugin>>	loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates, IAsyncResultHandler<io.apiman.common.plugin.Plugin> userHandler) Asynchronously loads a plugin.
protected io.apiman.common.plugin.Plugin	readPluginFile(io.apiman.common.plugin.PluginCoordinates coordinates, File pluginFile) Reads the plugin into an object.

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 - the configuration map

DefaultPluginRegistry

public DefaultPluginRegistry(File pluginsDir)

Constructor.

Parameters:

pluginsDir - the plugins directory

DefaultPluginRegistry

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

Constructor.

Parameters:

pluginsDir - the plugins directory

pluginRepositories - the plugin repositories

Method Detail

loadPlugin

public Future<IAsyncResult<io.apiman.common.plugin.Plugin>> loadPlugin(io.apiman.common.plugin.PluginCoordinates coordinates,
                                                              IAsyncResultHandler<io.apiman.common.plugin.Plugin> userHandler)

Description copied from interface: IPluginRegistry

Asynchronously loads a plugin.

Specified by:

loadPlugin in interface IPluginRegistry

Parameters:

coordinates - the coordinates

userHandler - result handler

See Also:

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

readPluginFile

protected io.apiman.common.plugin.Plugin readPluginFile(io.apiman.common.plugin.PluginCoordinates coordinates,
                                            File pluginFile)
                                                 throws Exception

Reads the plugin into an object. This method will fail if the plugin is not valid. This could happen if the file is not a java archive, or if the plugin spec file is missing from the archive, etc.

Parameters:

coordinates -

pluginFile -

Throws:

Exception

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(io.apiman.common.plugin.PluginCoordinates coordinates,
                  IAsyncResultHandler<File> handler)

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:

coordinates -

handler -

downloadFromMavenRepo

protected void downloadFromMavenRepo(io.apiman.common.plugin.PluginCoordinates coordinates,
                         URL mavenRepoUrl,
                         IAsyncResultHandler<File> handler)

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

Parameters:

coordinates -

mavenRepoUrl -

handler -

downloadArtifactTo

protected void downloadArtifactTo(URL artifactUrl,
                      File pluginFile,
                      IAsyncResultHandler<File> handler)

Download the artifact at the given URL and store it locally into the given plugin file path.

Parameters:

artifactUrl -

pluginFile -

handler -