PluginLoaderTest contains tests for the class
+ * {@link PluginLoader}.
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
+public class PluginLoaderTest {
+
+ @Test
+ public void testPluginLoader_1() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ assertNotNull(loader);
+ }
+
+ @Test(expected = java.security.InvalidParameterException.class)
+ public void testPluginLoader_2() throws Exception {
+ new PluginLoader(null);
+ }
+
+ @Test(expected = java.security.InvalidParameterException.class)
+ public void testPluginLoader_3() throws Exception {
+ new PluginLoader(new File("testdata/de.ugoe.cs.quest.plugin.PluginLoaderTest/jfcmonitor.jar"));
+ }
+
+ @Test
+ public void testCheckNameConformity_1() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugin-jfc-1.0.jar";
+ boolean expected = true;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_2() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugin-jf-c-1.0.jar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_3() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugin-jfc.jar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_4() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugi-jfc-1.0.jar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_5() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-pluginjfc-1.0.jar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_6() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugin-jfc-1-0.jar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_7() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "quest-plugin-jfc-1.0.nojar";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_8() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = null;
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testCheckNameConformity_9() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ String filename = "";
+ boolean expected = false;
+
+ boolean result = loader.checkNameConformity(filename);
+
+ assertEquals(expected, result);
+ }
+
+ @Test
+ public void testGetClassPathFromJar_1() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ File jarFile = new File("testdata/de.ugoe.cs.quest.plugin.PluginLoaderTest/jfcmonitor.jar");
+
+ String[] expected = new String[]{ "file:" + jarFile.getParentFile().getAbsolutePath()+"/javahelperlib.jar" };
+
+ String[] result = loader.getClassPathFromJar(jarFile);
+
+ ArrayAssert.assertEquivalenceArrays(expected, result);
+ }
+
+ @Test
+ public void testGetClassPathFromJar_2() throws Exception {
+ PluginLoader loader = new PluginLoader(new File("."));
+ File jarFile = new File("testdata/de.ugoe.cs.quest.plugin.PluginLoaderTest/jmi.jar");
+
+ String[] expected = new String[]{ };
+
+ String[] result = loader.getClassPathFromJar(jarFile);
+
+ ArrayAssert.assertEquivalenceArrays(expected, result);
+ }
+
+}
Index: /trunk/quest-plugin-core/.classpath
===================================================================
--- /trunk/quest-plugin-core/.classpath (revision 511)
+++ /trunk/quest-plugin-core/.classpath (revision 511)
@@ -0,0 +1,26 @@
+
++ * This class provides the functionality to load QUEST plug-ins from a + * pre-defined folder. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class PluginLoader { + + /** + *+ * Handle of the plug-in directory. + *
+ */ + private final File pluginDir; + + /** + *+ * Collection of the loaded plug-ins. + *
+ */ + private final Collection+ * Constructor. Creates a new PluginLoader that can load plug-ins the + * defined directory. + *
+ * + * @param pluginDir + * handle of the directory; in case the handle is + *null or does not describe a directory, an
+ * {@link InvalidParameterException} is thrown
+ */
+ public PluginLoader(File pluginDir) {
+ if (pluginDir == null) {
+ throw new InvalidParameterException(
+ "Parameter pluginDir must not be null!");
+ }
+ if (!pluginDir.isDirectory()) {
+ throw new InvalidParameterException("File " + pluginDir.getPath()
+ + " is not a directory");
+ }
+ this.pluginDir = pluginDir;
+ plugins = new LinkedList+ * Loads plug-ins from {@link #pluginDir}. + *
+ * + * @throws PluginLoaderException + * thrown if there is a problem loading a plug-in or updating + * the classpath + */ + public void load() throws PluginLoaderException { + File[] jarFiles = pluginDir.listFiles(new FilenameFilter() { + @Override + public boolean accept(File dir, String name) { + return checkNameConformity(name); + } + }); + + for (File jarFile : jarFiles) { + updateClassLoader(jarFile); + + String pluginName = jarFile.getName().split("-")[2]; + String pluginClassName = "de.ugoe.cs.quest.plugin." + pluginName + + "." + pluginName.toUpperCase() + "Plugin"; + + Class pluginClass = null; + try { + pluginClass = Class.forName(pluginClassName); + } catch (ClassNotFoundException e) { + throw new PluginLoaderException("No class '" + pluginClassName + + "' found in " + pluginDir + "/" + jarFile.getName()); + } + if (!pluginClass.isInstance(QuestPlugin.class)) { + throw new PluginLoaderException("Class " + pluginClassName + + " not instance of QuestPlugin"); + } + try { + QuestPlugin pluginObject = (QuestPlugin) pluginClass + .newInstance(); + plugins.add(pluginObject); + } catch (InstantiationException e) { + throw new PluginLoaderException("Could not instantiate " + + pluginClassName); + } catch (IllegalAccessException e) { + throw new PluginLoaderException("Could not access " + + pluginClassName); + } + } + } + + /** + *+ * Retrieves the classpath from a Jar file's MANIFEST. + *
+ * + * @throws IOException + * @throws FileNotFoundException + */ + protected String[] getClassPathFromJar(File jarFile) { + String[] classPath; + + JarInputStream jarInputStream = null; + try { + jarInputStream = new JarInputStream(new FileInputStream(jarFile)); + } catch (FileNotFoundException e) { + throw new AssertionError( + "FileNotFoundException should be impossible!"); + } catch (IOException e) { + throw new PluginLoaderException(e); + } + + Manifest manifest = jarInputStream.getManifest(); + + String jarClassPath = manifest.getMainAttributes().getValue( + "Class-Path"); + + if (jarClassPath != null) { + String[] jarClassPathElements = jarClassPath.split(" "); + classPath = new String[jarClassPathElements.length]; + for (int i = 0; i < jarClassPathElements.length; i++) { + classPath[i] = "file:" + + jarFile.getParentFile().getAbsolutePath() + "/" + + jarClassPathElements[i]; + } + try { + jarInputStream.close(); + } catch (IOException e) { + throw new PluginLoaderException(e); + } + } else { + classPath = new String[] {}; + } + return classPath; + } + + /** + *
+ * Updates the classpath of the {@link ClassLoader} to include the plug-in
+ * jar as well as further libraries required by the plug-in jar as defined
+ * in the Class-Path section of its manifest.
+ *
+ * Checks if the name of a file indicates that it defines a QUEST plug-in.
+ * The structure of valid plug-in filenames is
+ * quest-plugin-%PLUGIN_NAME%-version.jar, where
+ * %PLUGIN_NAME% is replaced by the name of the plug-in. Note
+ * that plug-in names must not contain any dashes.
+ *
+ * This exception is thrown in case there is an error during the loading of + * QUEST plugins. Note that the failures during the loading may result in an + * invalid classpath and this exception should, therefore, be treated with + * appropriate care. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ +public class PluginLoaderException extends RuntimeException { + + /** + * @see RuntimeException#RuntimeException(String) + */ + public PluginLoaderException(String msg) { + super(msg); + } + + /** + * @see RuntimeException#RuntimeException(Throwable) + */ + public PluginLoaderException(Throwable throwable) { + super(throwable); + } + + /** + *+ * Id for object serialization. + *
+ */ + private static final long serialVersionUID = 1L; + +} Index: /trunk/quest-plugin-core/src/main/java/de/ugoe/cs/quest/plugin/QuestPlugin.java =================================================================== --- /trunk/quest-plugin-core/src/main/java/de/ugoe/cs/quest/plugin/QuestPlugin.java (revision 511) +++ /trunk/quest-plugin-core/src/main/java/de/ugoe/cs/quest/plugin/QuestPlugin.java (revision 511) @@ -0,0 +1,25 @@ +package de.ugoe.cs.quest.plugin; + +import java.util.Collection; + +/** + *Interface for QUEST plug-ins.
+ * + * @author Steffen Herbold + * @version 1.0 + */ +interface QuestPlugin { + + /** + *Title of the plug-in.
+ * @return + */ + public String getTitle(); + + /** + *Collection of {@link String}s that contain the commands defined by this plug-in.
+ *Consult the de.ugoe.cs.utils.console package of the java-utils project for more information.
+ * @return + */ + public Collection