imporve plugin system

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

@@ -0,0 +1,249 @@
+/**
+ * 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.Inject;
+import com.google.inject.Singleton;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import sonia.scm.ConfigurationException;
+import sonia.scm.cache.CacheManager;
+import sonia.scm.cache.SimpleCache;
+import sonia.scm.config.ScmConfiguration;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.net.URL;
+
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBException;
+import javax.xml.bind.Unmarshaller;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+@Singleton
+public class DefaultPluginManager implements PluginManager
+{
+
+  /** Field description */
+  public static final String CACHE_NAME = "sonia.cache.plugins";
+
+  /** the logger for DefaultPluginManager */
+  private static final Logger logger =
+    LoggerFactory.getLogger(DefaultPluginManager.class);
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   *
+   *
+   * @param configuration
+   * @param pluginLoader
+   * @param cacheManager
+   */
+  @Inject
+  public DefaultPluginManager(ScmConfiguration configuration,
+                              PluginLoader pluginLoader,
+                              CacheManager cacheManager)
+  {
+    this.configuration = configuration;
+    this.cache = cacheManager.getSimpleCache(String.class, PluginCenter.class,
+            CACHE_NAME);
+    installedPlugins = new HashMap<String, PluginInformation>();
+
+    for (Plugin plugin : pluginLoader.getInstalledPlugins())
+    {
+      PluginInformation info = plugin.getInformation();
+
+      if (info != null)
+      {
+        String id = getPluginId(info);
+
+        installedPlugins.put(id, plugin.getInformation());
+      }
+    }
+
+    try
+    {
+      unmarshaller =
+        JAXBContext.newInstance(PluginCenter.class).createUnmarshaller();
+    }
+    catch (JAXBException ex)
+    {
+      throw new ConfigurationException(ex);
+    }
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param id
+   */
+  @Override
+  public void install(String id)
+  {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param id
+   */
+  @Override
+  public void uninstall(String id)
+  {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param id
+   *
+   * @return
+   */
+  @Override
+  public PluginInformation get(String id)
+  {
+    throw new UnsupportedOperationException("Not supported yet.");
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  @Override
+  public Collection<PluginInformation> getAvailable()
+  {
+    return getPluginCenter().getPlugins();
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  @Override
+  public Collection<PluginInformation> getInstalled()
+  {
+    return installedPlugins.values();
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  private PluginCenter getPluginCenter()
+  {
+    PluginCenter center = cache.get(PluginCenter.class.getName());
+
+    if (center == null)
+    {
+      if (logger.isInfoEnabled())
+      {
+        logger.info("fetch plugin informations from {}",
+                    configuration.getPluginUrl());
+      }
+
+      try
+      {
+        center = (PluginCenter) unmarshaller.unmarshal(
+          new URL(configuration.getPluginUrl()));
+        cache.put(PluginCenter.class.getName(), center);
+      }
+      catch (Exception ex)
+      {
+        throw new PluginLoadException(ex);
+      }
+    }
+
+    return center;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param info
+   *
+   * @return
+   */
+  private String getPluginId(PluginInformation info)
+  {
+    StringBuilder id = new StringBuilder(info.getGroupId());
+
+    id.append(":").append(info.getArtifactId()).append(":");
+
+    return id.append(info.getVersion()).toString();
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private SimpleCache<String, PluginCenter> cache;
+
+  /** Field description */
+  private ScmConfiguration configuration;
+
+  /** Field description */
+  private Map<String, PluginInformation> installedPlugins;
+
+  /** Field description */
+  private Unmarshaller unmarshaller;
+}