io.apiman.common.plugin

Class Plugin

java.lang.Object

io.apiman.common.plugin.Plugin

public class Plugin
extends Object

An apiman plugin. This represents a plugin that has been downloaded to some local registry and successfully loaded. A plugin must contain at least the following file: META-INF/apiman/plugin.json It may also contain java classes, resources, and other configuration files. For example, multiple policy definition files may exist here: META-INF/apiman/policyDefs/*.json

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
Plugin(PluginSpec spec, PluginCoordinates coordinates, PluginClassLoader loader) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PluginCoordinates	getCoordinates()
String	getDescription()
PluginClassLoader	getLoader()
String	getName()
List<URL>	getPolicyDefinitions()
PluginSpec	getSpec()
protected void	setCoordinates(PluginCoordinates coordinates)
protected void	setLoader(PluginClassLoader loader)
void	setSpec(PluginSpec spec)

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin(PluginSpec spec,
      PluginCoordinates coordinates,
      PluginClassLoader loader)

Constructor.

Parameters:

spec - the plugin's specification

coordinates - the plugin's coordinates

loader - the plugin's classloader

Method Detail

getName

public String getName()

Returns:

the name

getDescription

public String getDescription()

Returns:

the description

getCoordinates

public PluginCoordinates getCoordinates()

Returns:

the coordinates

setCoordinates

protected void setCoordinates(PluginCoordinates coordinates)

Parameters:

coordinates - the coordinates to set

getLoader

public PluginClassLoader getLoader()

Returns:

the loader

setLoader

protected void setLoader(PluginClassLoader loader)

Parameters:

loader - the loader to set

getSpec

public PluginSpec getSpec()

Returns:

the spec

setSpec

public void setSpec(PluginSpec spec)

Parameters:

spec - the spec to set

getPolicyDefinitions

public List<URL> getPolicyDefinitions()

Returns:

any policy definitions found in the plugin (META-INF/apiman/policyDefs/*.json