rebuild plugin system

scm-core/src/main/java/sonia/scm/plugin/DefaultPluginManager.java

@@ -0,0 +1,241 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import sonia.scm.plugin.ext.ExtensionObject;
+import sonia.scm.plugin.ext.ExtensionProcessor;
+import sonia.scm.plugin.ext.JARExtensionScanner;
+import sonia.scm.util.IOUtil;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import java.net.URL;
+
+import java.util.Collection;
+import java.util.Enumeration;
+import java.util.HashSet;
+import java.util.Set;
+
+import javax.xml.bind.JAXB;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class DefaultPluginManager implements PluginManager
+{
+
+  /** Field description */
+  public static final String DEFAULT_PACKAGE = "sonia.scm";
+
+  /** Field description */
+  public static final String PATH_PLUGINCONFIG = "META-INF/scm/plugin.xml";
+
+  /** the logger for DefaultPluginManager */
+  private static final Logger logger =
+    LoggerFactory.getLogger(DefaultPluginManager.class);
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   */
+  public DefaultPluginManager()
+  {
+    ClassLoader classLoader = getClassLoader();
+
+    try
+    {
+      load(classLoader);
+    }
+    catch (IOException ex)
+    {
+      throw new RuntimeException(ex);
+    }
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param processor
+   */
+  @Override
+  public void processExtensions(ExtensionProcessor processor)
+  {
+    Set<ExtensionObject> extensions = new HashSet<ExtensionObject>();
+    ClassLoader classLoader = getClassLoader();
+    JARExtensionScanner scanner = new JARExtensionScanner();
+
+    for (Plugin plugin : plugins)
+    {
+      InputStream input = null;
+
+      try
+      {
+        Set<String> packageSet = plugin.getPackageSet();
+
+        if (packageSet == null)
+        {
+          packageSet = new HashSet<String>();
+        }
+
+        packageSet.add(DEFAULT_PACKAGE);
+        input = new FileInputStream(plugin.getPath());
+        scanner.processExtensions(classLoader, extensions, input, packageSet);
+      }
+      catch (IOException ex)
+      {
+        logger.error(ex.getMessage(), ex);
+      }
+      finally
+      {
+        IOUtil.close(input);
+      }
+    }
+
+    for (ExtensionObject exo : extensions)
+    {
+      processor.processExtension(exo.getExtension(), exo.getExtensionClass());
+    }
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  @Override
+  public Collection<Plugin> getPlugins()
+  {
+    return plugins;
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param classLoader
+   *
+   * @throws IOException
+   */
+  private void load(ClassLoader classLoader) throws IOException
+  {
+    Enumeration<URL> urlEnum = classLoader.getResources(PATH_PLUGINCONFIG);
+
+    if (urlEnum != null)
+    {
+      while (urlEnum.hasMoreElements())
+      {
+        URL url = urlEnum.nextElement();
+
+        loadPlugin(url);
+      }
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param url
+   */
+  private void loadPlugin(URL url)
+  {
+    try
+    {
+
+      // jar:file:/some/path/file.jar!/META-INF/scm/plugin.xml
+      String path = url.toExternalForm();
+
+      path = path.substring("jar:file:".length(), path.lastIndexOf("!"));
+
+      if (logger.isInfoEnabled())
+      {
+        logger.info("load plugin {}", path);
+      }
+
+      Plugin plugin = JAXB.unmarshal(url, Plugin.class);
+
+      plugin.setPath(path);
+      plugins.add(plugin);
+    }
+    catch (Exception ex)
+    {
+      logger.error(ex.getMessage(), ex);
+    }
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  private ClassLoader getClassLoader()
+  {
+    ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
+
+    if (classLoader == null)
+    {
+      classLoader = DefaultPluginManager.class.getClassLoader();
+    }
+
+    return classLoader;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private Set<Plugin> plugins = new HashSet<Plugin>();
+}

scm-core/src/main/java/sonia/scm/plugin/Plugin.java

@@ -0,0 +1,164 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.net.URL;
+
+import java.util.Set;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlElementWrapper;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlTransient;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
+public class Plugin
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public PluginInformation getInformation()
+  {
+    return information;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Set<String> getPackageSet()
+  {
+    return packageSet;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getPath()
+  {
+    return path;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public PluginResources getResources()
+  {
+    return resources;
+  }
+
+  //~--- set methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param information
+   */
+  public void setInformation(PluginInformation information)
+  {
+    this.information = information;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param packageSet
+   */
+  public void setPackageSet(Set<String> packageSet)
+  {
+    this.packageSet = packageSet;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param path
+   */
+  public void setPath(String path)
+  {
+    this.path = path;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param resources
+   */
+  public void setResources(PluginResources resources)
+  {
+    this.resources = resources;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private PluginInformation information;
+
+  /** Field description */
+  @XmlElement(name = "package")
+  @XmlElementWrapper(name = "packages")
+  private Set<String> packageSet;
+
+  /** Field description */
+  @XmlTransient
+  private String path;
+
+  /** Field description */
+  private PluginResources resources;
+}

scm-core/src/main/java/sonia/scm/plugin/PluginInformation.java

@@ -0,0 +1,171 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class PluginInformation
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getAuthor()
+  {
+    return author;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getDescription()
+  {
+    return description;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getName()
+  {
+    return name;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getUrl()
+  {
+    return url;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public String getVersion()
+  {
+    return version;
+  }
+
+  //~--- set methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param author
+   */
+  public void setAuthor(String author)
+  {
+    this.author = author;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param description
+   */
+  public void setDescription(String description)
+  {
+    this.description = description;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param name
+   */
+  public void setName(String name)
+  {
+    this.name = name;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param url
+   */
+  public void setUrl(String url)
+  {
+    this.url = url;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param version
+   */
+  public void setVersion(String version)
+  {
+    this.version = version;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private String author;
+
+  /** Field description */
+  private String description;
+
+  /** Field description */
+  private String name;
+
+  /** Field description */
+  private String url;
+
+  /** Field description */
+  private String version;
+}

scm-core/src/main/java/sonia/scm/plugin/PluginManager.java

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.inject.Binder;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.util.Collection;
+import sonia.scm.plugin.ext.ExtensionProcessor;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public interface PluginManager
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @param binder
+   */
+  public void processExtensions(ExtensionProcessor processor);
+
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Collection<Plugin> getPlugins();
+}

scm-core/src/main/java/sonia/scm/plugin/PluginResources.java

@@ -0,0 +1,107 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.util.Set;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@XmlAccessorType(XmlAccessType.NONE)
+public class PluginResources
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Set<String> getScriptResources()
+  {
+    return scriptResources;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Set<String> getStylesheetResources()
+  {
+    return stylesheetResources;
+  }
+
+  //~--- set methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param scriptResources
+   */
+  public void setScriptResources(Set<String> scriptResources)
+  {
+    this.scriptResources = scriptResources;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param stylesheetResources
+   */
+  public void setStylesheetResources(Set<String> stylesheetResources)
+  {
+    this.stylesheetResources = stylesheetResources;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  @XmlElement(name = "script")
+  private Set<String> scriptResources;
+
+  /** Field description */
+  @XmlElement(name = "stylesheet")
+  private Set<String> stylesheetResources;
+}

scm-core/src/main/java/sonia/scm/plugin/ext/Extension.java

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin.ext;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@Documented
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Extension {}

scm-core/src/main/java/sonia/scm/plugin/ext/ExtensionObject.java

@@ -0,0 +1,87 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin.ext;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class ExtensionObject
+{
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param extension
+   * @param extensionClass
+   */
+  public ExtensionObject(Extension extension, Class<?> extensionClass)
+  {
+    this.extension = extension;
+    this.extensionClass = extensionClass;
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Extension getExtension()
+  {
+    return extension;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public Class<?> getExtensionClass()
+  {
+    return extensionClass;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private Extension extension;
+
+  /** Field description */
+  private Class<?> extensionClass;
+}

scm-core/src/main/java/sonia/scm/plugin/ext/ExtensionProcessor.java

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin.ext;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public interface ExtensionProcessor
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @param extension
+   * @param extensionClass
+   */
+  public void processExtension(Extension extension, Class<?> extensionClass);
+}

scm-core/src/main/java/sonia/scm/plugin/ext/ExtensionScanner.java

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin.ext;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import java.util.Collection;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public interface ExtensionScanner
+{
+
+  /**
+   * Method description
+   *
+   *
+   *
+   * @param classLoader
+   * @param extensionObjects
+   * @param input
+   * @param packagess
+   *
+   * @throws IOException
+   */
+  public void processExtensions(ClassLoader classLoader,
+                                Collection<ExtensionObject> extensionObjects,
+                                InputStream input, Collection<String> packagess)
+          throws IOException;
+}

scm-core/src/main/java/sonia/scm/plugin/ext/JARExtensionScanner.java

@@ -0,0 +1,228 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of SCM-Manager; nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin.ext;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import sonia.scm.util.IOUtil;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import java.util.Collection;
+import java.util.jar.JarEntry;
+import java.util.jar.JarInputStream;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class JARExtensionScanner implements ExtensionScanner
+{
+
+  /** the logger for JARExtensionScanner */
+  private static final Logger logger =
+    LoggerFactory.getLogger(JARExtensionScanner.class);
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   *
+   * @param classLoader
+   * @param extensionObjects
+   * @param inputStream
+   * @param packages
+   *
+   * @throws IOException
+   */
+  @Override
+  public void processExtensions(ClassLoader classLoader,
+                                Collection<ExtensionObject> extensionObjects,
+                                InputStream inputStream,
+                                Collection<String> packages)
+          throws IOException
+  {
+    JarInputStream input = null;
+
+    try
+    {
+      input = new JarInputStream(inputStream);
+
+      JarEntry entry = input.getNextJarEntry();
+
+      while (entry != null)
+      {
+        if (!entry.isDirectory())
+        {
+          processEntry(classLoader, extensionObjects, packages, entry);
+        }
+
+        entry = input.getNextJarEntry();
+      }
+    }
+    finally
+    {
+      IOUtil.close(input);
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param classLoader
+   * @param name
+   *
+   * @return
+   */
+  private Class<?> createClass(ClassLoader classLoader, String name)
+  {
+    Class<?> clazz = null;
+
+    try
+    {
+      clazz = classLoader.loadClass(name);
+    }
+    catch (Exception ex)
+    {
+      logger.error(ex.getMessage(), ex);
+    }
+
+    return clazz;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   *
+   * @param classLoader
+   * @param extensionObjects
+   * @param packages
+   * @param entry
+   */
+  private void processEntry(ClassLoader classLoader,
+                            Collection<ExtensionObject> extensionObjects,
+                            Collection<String> packages, JarEntry entry)
+  {
+    String name = entry.getName();
+
+    if (name.endsWith(".class"))
+    {
+      name = getClassName(name);
+
+      if (isManagedClass(packages, name))
+      {
+        Class<?> managedClass = createClass(classLoader, name);
+
+        if (managedClass != null)
+        {
+          processManagedClass(extensionObjects, managedClass);
+        }
+      }
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param extensionObjects
+   * @param managedClass
+   */
+  private void processManagedClass(
+          Collection<ExtensionObject> extensionObjects, Class<?> managedClass)
+  {
+    Extension extension = managedClass.getAnnotation(Extension.class);
+
+    if (extension != null)
+    {
+      if (logger.isDebugEnabled())
+      {
+        logger.debug("found extension class {}", managedClass.getName());
+      }
+
+      extensionObjects.add(new ExtensionObject(extension, managedClass));
+    }
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param name
+   *
+   * @return
+   */
+  private String getClassName(String name)
+  {
+    return name.replaceAll("/", ".").substring(0, name.length() - 6);
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param packages
+   * @param name
+   *
+   * @return
+   */
+  private boolean isManagedClass(Collection<String> packages, String name)
+  {
+    boolean result = false;
+
+    for (String pkg : packages)
+    {
+      if (name.startsWith(pkg))
+      {
+        result = true;
+
+        break;
+      }
+    }
+
+    return result;
+  }
+}