io.apiman.common.plugin

Class PluginClassLoader

java.lang.Object

java.lang.ClassLoader

io.apiman.common.plugin.PluginClassLoader

public class PluginClassLoader
extends ClassLoader

A classloader that is capable of loading classes from an apiman plugin artifact.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
PluginClassLoader(File pluginArtifactFile) Constructor.
PluginClassLoader(File pluginArtifactFile, ClassLoader parent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes any resources the plugin classloader is holding open.
protected File	createWorkDir(File pluginArtifactFile) Creates a work directory into which various resources discovered in the plugin artifact can be extracted.
protected void	finalize()
protected Class<?>	findClass(String name)
protected InputStream	findClassContent(String className) Searches the plugin artifact ZIP and all dependency ZIPs for a zip entry for the given fully qualified class name.
protected URL	findResource(String name)
protected Enumeration<URL>	findResources(String name)
List<URL>	getPolicyDefinitionResources()

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResourceAsStream, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginClassLoader

public PluginClassLoader(File pluginArtifactFile)
                  throws IOException

Constructor.

Parameters:

pluginArtifactFile - plugin artifact

Throws:

IOException - if an I/O error has occurred

PluginClassLoader

public PluginClassLoader(File pluginArtifactFile,
                 ClassLoader parent)
                  throws IOException

Constructor.

Parameters:

pluginArtifactFile - plugin artifact

parent - parent classloader

Throws:

IOException - if an I/O error has occurred

Method Detail

createWorkDir

protected File createWorkDir(File pluginArtifactFile)
                      throws IOException

Creates a work directory into which various resources discovered in the plugin artifact can be extracted.

Parameters:

pluginArtifactFile - plugin artifact

Throws:

IOException - if an I/O error has occurred

findClass

protected Class<?> findClass(String name)
                      throws ClassNotFoundException

Overrides:

findClass in class ClassLoader

Throws:

ClassNotFoundException

See Also:

ClassLoader.findClass(java.lang.String)

findClassContent

protected InputStream findClassContent(String className)
                                throws IOException

Searches the plugin artifact ZIP and all dependency ZIPs for a zip entry for the given fully qualified class name.

Parameters:

className - name of class

Throws:

IOException - if an I/O error has occurred

findResource

protected URL findResource(String name)

Overrides:

findResource in class ClassLoader

See Also:

ClassLoader.findResource(java.lang.String)

findResources

protected Enumeration<URL> findResources(String name)
                                  throws IOException

Overrides:

findResources in class ClassLoader

Throws:

IOException

See Also:

ClassLoader.findResources(java.lang.String)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

close

public void close()
           throws IOException

Closes any resources the plugin classloader is holding open.

Throws:

IOException - if an I/O error has occurred

getPolicyDefinitionResources

public List<URL> getPolicyDefinitionResources()

Returns:

gets any policy definition resources from the plugin artifact (located in META-INF/apiman/policyDefs/*.json