Package de.osshangar.plugin

Class Plugin<T>

java.lang.Object

de.osshangar.plugin.Plugin<T>

Type Parameters:

T - type of the object created

public class Plugin<T>
extends Object

This class loads the plugins

Constructor Summary

Constructors

Constructor	Description
Plugin()

Method Summary

Modifier and Type	Method	Description
T	load(JarInputStream jarInputStream)	This loads the plugin from the provided JarInputStream.
T	load(JarInputStream jarInputStream, Arguments constructorArguments)	This loads the plugin from the provided JarInputStream and provides the given arguments to its constructor
T	load(Map<String,byte[]> classFiles, Map<String,byte[]> resources, String classToLoadName)	This loads a plugin from a Map of class byte codes and provides the given arguments to its constructor
T	load(Map<String,byte[]> classFiles, Map<String,byte[]> resources, String classToLoadName, Arguments constructorArguments)	This loads a plugin from a Map of class byte codes and provides the given arguments to its constructor

Methods inherited from class java.lang.Object

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

Constructor Details

Plugin

public Plugin()

Method Details

load

public T load(JarInputStream jarInputStream)
       throws FileFormatException,
IOException,
ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

This loads the plugin from the provided JarInputStream.

Parameters:

jarInputStream - The input stream to a JAR package to load the plugin from

Returns:

The instantiated plugin instance

Throws:

FileFormatException - when the structure of the plugin JAR is wrong

IOException - when an I/O operation fails

ClassNotFoundException - when the PluginClassLoader does not find a requested class

InvocationTargetException - when the provided constructor arguments does not match the signature of the requested constructor

NoSuchMethodException - when then plugin does not have a constructor that matches the requested signature

InstantiationException - when the class of the plugin which implements the required plugin interface is an abstract class

IllegalAccessException - when the requested constructor of the plugin is inaccessible due to an enforced Java language access control

load

public T load(Map<String,byte[]> classFiles,
 Map<String,byte[]> resources,
 String classToLoadName)
       throws ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

This loads a plugin from a Map of class byte codes and provides the given arguments to its constructor

Parameters:

classFiles - A Map of full qualified class names as its keys and the classes byte codes as its values

classToLoadName - The name of the plugin class to load

Returns:

The instance of the loaded plugin

Throws:

ClassNotFoundException - when the PluginClassLoader does not find a requested class

InvocationTargetException - when the provided constructor arguments does not match the signature of the requested constructor

NoSuchMethodException - when then plugin does not have a constructor that matches the requested signature

InstantiationException - when the class of the plugin which implements the required plugin interface is an abstract class

IllegalAccessException - when the requested constructor of the plugin is inaccessible due to an enforced Java language access control

load

public T load(JarInputStream jarInputStream,
 Arguments constructorArguments)
       throws FileFormatException,
IOException,
ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

This loads the plugin from the provided JarInputStream and provides the given arguments to its constructor

Parameters:

jarInputStream - The input stream to a JAR package to load the plugin from

constructorArguments - The arguments to be provided to the constructor of the plugin on its instantiation

Returns:

The instance of the loaded plugin

Throws:

FileFormatException - when the structure of the plugin JAR is wrong

IOException - when an I/O operation fails

ClassNotFoundException - when the PluginClassLoader does not find a requested class

InvocationTargetException - when the provided constructor arguments does not match the signature of the requested constructor

NoSuchMethodException - when then plugin does not have a constructor that matches the requested signature

InstantiationException - when the class of the plugin which implements the required plugin interface is an abstract class

IllegalAccessException - when the requested constructor of the plugin is inaccessible due to an enforced Java language access control

load

public T load(Map<String,byte[]> classFiles,
 Map<String,byte[]> resources,
 String classToLoadName,
 Arguments constructorArguments)
       throws ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

This loads a plugin from a Map of class byte codes and provides the given arguments to its constructor

Parameters:

classFiles - A Map of full qualified class names as its keys and the classes byte codes as its values

resources - A Map of package paths as its keys and their related resources as its values

classToLoadName - The name of the plugin class to load

constructorArguments - The arguments to be provided to the constructor of the plugin on its instantiation

Returns:

The instance of the loaded plugin

Throws:

ClassNotFoundException - when the PluginClassLoader does not find a requested class

InvocationTargetException - when the provided constructor arguments does not match the signature of the requested constructor

NoSuchMethodException - when then plugin does not have a constructor that matches the requested signature

InstantiationException - when the class of the plugin which implements the required plugin interface is an abstract class

IllegalAccessException - when the requested constructor of the plugin is inaccessible due to an enforced Java language access control