Commits

Sebastian Sdorra committed 123e872

start implementation of a new event api based on guavas EventBus

Comments (0)

Files changed (8)

scm-core/src/main/java/com/google/common/eventbus/ThrowingEventBus.java

+/**
+ * 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 com.google.common.eventbus;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import sonia.scm.event.EventBusException;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.lang.reflect.InvocationTargetException;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ * @since 1.23
+ */
+public class ThrowingEventBus extends EventBus
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @param event
+   * @param wrapper
+   */
+  @Override
+  void dispatch(Object event, EventHandler wrapper)
+  {
+    try
+    {
+      wrapper.handleEvent(event);
+    }
+    catch (InvocationTargetException ex)
+    {
+      throw new EventBusException(
+        "could not handle event ".concat(event.toString()), ex);
+    }
+  }
+}

scm-core/src/main/java/sonia/scm/event/EventBusException.java

+/**
+ * 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.event;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ * @since 1.23
+ */
+public class EventBusException extends RuntimeException
+{
+
+  /** Field description */
+  private static final long serialVersionUID = -6090833234971972368L;
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   */
+  public EventBusException() {}
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param message
+   */
+  public EventBusException(String message)
+  {
+    super(message);
+  }
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param cause
+   */
+  public EventBusException(Throwable cause)
+  {
+    super(cause);
+  }
+
+  /**
+   * Constructs ...
+   *
+   *
+   * @param message
+   * @param cause
+   */
+  public EventBusException(String message, Throwable cause)
+  {
+    super(message, cause);
+  }
+}

scm-core/src/main/java/sonia/scm/event/HandlerEventBase.java

+/**
+ * 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.event;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import sonia.scm.HandlerEvent;
+
+/**
+ *
+ * TODO for 2.0 rename to HandlerEvent
+ *
+ * @author Sebastian Sdorra
+ * @since 1.23
+ *
+ * @param <T>
+ */
+public interface HandlerEventBase<T>
+{
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public HandlerEvent getEventType();
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public T getItem();
+}

scm-core/src/main/java/sonia/scm/event/ScmEventBus.java

+/**
+ * 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.event;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.common.eventbus.AsyncEventBus;
+import com.google.common.eventbus.EventBus;
+import com.google.common.eventbus.ThrowingEventBus;
+
+import org.apache.shiro.concurrent.SubjectAwareExecutorService;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.util.concurrent.Executors;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ * @since 1.23
+ */
+public class ScmEventBus extends EventBus
+{
+
+  /** Field description */
+  private static ScmEventBus instance = new ScmEventBus();
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   *  Constructs ...
+   *
+   */
+  private ScmEventBus()
+  {
+    eventBus = new ThrowingEventBus();
+    asyncEventBus = new AsyncEventBus(
+      new SubjectAwareExecutorService(Executors.newCachedThreadPool()));
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public static ScmEventBus getInstance()
+  {
+    return instance;
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param event
+   */
+  @Override
+  public void post(Object event)
+  {
+    asyncEventBus.post(event);
+    eventBus.post(event);
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param object
+   */
+  @Override
+  public void register(Object object)
+  {
+    register(object, true);
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param object
+   * @param async
+   */
+  public void register(Object object, boolean async)
+  {
+    if (async)
+    {
+      asyncEventBus.register(object);
+    }
+    else
+    {
+      eventBus.register(object);
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param object
+   */
+  @Override
+  public void unregister(Object object)
+  {
+    asyncEventBus.unregister(object);
+    eventBus.unregister(object);
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private AsyncEventBus asyncEventBus;
+
+  /** Field description */
+  private EventBus eventBus;
+}

scm-core/src/main/java/sonia/scm/event/Subscriber.java

+/**
+ * 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.event;
+
+//~--- 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
+ * @since 1.23
+ */
+@Documented
+@Target({ ElementType.TYPE })
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Subscriber
+{
+  boolean async() default true;
+}

scm-webapp/src/main/java/sonia/scm/ScmContextListener.java

     List<Module> moduleList = Lists.newArrayList();
 
     moduleList.add(new ScmInitializerModule());
+    moduleList.add(new ScmSubscriberModule());
     moduleList.add(ShiroWebModule.guiceFilterModule());
     moduleList.add(main);
     moduleList.add(new ScmSecurityModule(servletContext));

scm-webapp/src/main/java/sonia/scm/ScmServletModule.java

 
 //~--- non-JDK imports --------------------------------------------------------
 
+import com.google.common.eventbus.EventBus;
 import com.google.inject.Provider;
 import com.google.inject.multibindings.Multibinder;
 import com.google.inject.name.Names;
 import sonia.scm.cache.CacheManager;
 import sonia.scm.cache.EhCacheManager;
 import sonia.scm.config.ScmConfiguration;
+import sonia.scm.event.ScmEventBus;
 import sonia.scm.filter.AdminSecurityFilter;
 import sonia.scm.filter.BaseUrlFilter;
 import sonia.scm.filter.GZipFilter;
       RepositoryProvider.class, Repository.class).to(
       DefaultRepositoryProvider.class).in(RequestScoped.class);
 
+    // bind event api
+    bind(ScmEventBus.class).toInstance(ScmEventBus.getInstance());
+    bind(EventBus.class).toInstance(ScmEventBus.getInstance());
+
     // bind core
     bind(StoreFactory.class, JAXBStoreFactory.class);
     bind(ListenableStoreFactory.class, JAXBStoreFactory.class);

scm-webapp/src/main/java/sonia/scm/ScmSubscriberModule.java

+/**
+ * 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;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import com.google.inject.AbstractModule;
+import com.google.inject.TypeLiteral;
+import com.google.inject.matcher.AbstractMatcher;
+import com.google.inject.matcher.Matcher;
+import com.google.inject.spi.InjectionListener;
+import com.google.inject.spi.TypeEncounter;
+import com.google.inject.spi.TypeListener;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import sonia.scm.event.ScmEventBus;
+import sonia.scm.event.Subscriber;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.lang.annotation.Annotation;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class ScmSubscriberModule extends AbstractModule
+{
+
+  /**
+   * the logger for ScmSubscriberModule
+   */
+  private static final Logger logger =
+    LoggerFactory.getLogger(ScmSubscriberModule.class);
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   */
+  @Override
+  protected void configure()
+  {
+    bindListener(annotatedWith(Subscriber.class), new TypeListener()
+    {
+
+      @Override
+      public <I> void hear(TypeLiteral<I> type,
+        final TypeEncounter<I> encounter)
+      {
+        encounter.register(new InjectionListener<I>()
+        {
+          @Override
+          public void afterInjection(Object object)
+          {
+            if (logger.isTraceEnabled())
+            {
+              logger.trace("register subscriber {}", object.getClass());
+            }
+
+            Subscriber subscriber =
+              object.getClass().getAnnotation(Subscriber.class);
+            
+
+            ScmEventBus.getInstance().register(object, subscriber.async());
+          }
+        });
+      }
+
+    });
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param aClass
+   *
+   * @return
+   */
+  private Matcher<TypeLiteral<?>> annotatedWith(
+    Class<? extends Annotation> aClass)
+  {
+    return new AnnotatedWith(aClass);
+  }
+
+  //~--- inner classes --------------------------------------------------------
+
+  /**
+   * Class description
+   *
+   *
+   * @version        Enter version here..., 12/12/07
+   * @author         Enter your name here...
+   */
+  private static class AnnotatedWith extends AbstractMatcher<TypeLiteral<?>>
+  {
+
+    /**
+     * Constructs ...
+     *
+     *
+     * @param baseClass
+     */
+    private AnnotatedWith(Class<? extends Annotation> baseClass)
+    {
+      this.baseClass = baseClass;
+    }
+
+    //~--- methods ------------------------------------------------------------
+
+    /**
+     * Method description
+     *
+     *
+     * @param t
+     *
+     * @return
+     */
+    @Override
+    public boolean matches(TypeLiteral<?> t)
+    {
+      try
+      {
+        return t.getRawType().isAnnotationPresent(baseClass);
+      }
+      catch (Exception e)
+      {
+
+        // LOG e
+        return false;
+      }
+    }
+
+    //~--- fields -------------------------------------------------------------
+
+    /** Field description */
+    private final Class<? extends Annotation> baseClass;
+  }
+}