replace guava eventbus with legman

This commit is contained in:
Sebastian Sdorra
2014-01-03 12:56:18 +01:00
parent 5e6259f3b7
commit 0c7d6fa62f
17 changed files with 114 additions and 454 deletions

View File

@@ -1,90 +0,0 @@
/**
* 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;
/**
* Exception is thrown from the {@link ScmEventBus} if an error occurs
* during a synchronous event post operation.
*
* @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);
}
}

View File

@@ -35,8 +35,8 @@ package sonia.scm.event;
//~--- non-JDK imports --------------------------------------------------------
import com.google.common.eventbus.EventBus;
import com.google.common.eventbus.Subscribe;
import com.github.legman.EventBus;
import com.github.legman.Subscribe;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -120,9 +120,8 @@ public abstract class ScmEventBus
* subscriber for the event bus.
*
* @param subscriber subscriber object
* @param async should the subscriber receive the event in async manner
*/
public abstract void register(Object subscriber, boolean async);
public abstract void register(Object subscriber);
/**
* Unregister the given subscriber object from the event bus.
@@ -130,24 +129,4 @@ public abstract class ScmEventBus
* @param subscriber subscriber object to unregister
*/
public abstract void unregister(Object subscriber);
/**
* Calls the {@link #register(Object, boolean)} method, after reading the
* value of {@link Subscriber#async()}. If the {@link Subscriber} annotation
* is not present than the object is registered as async.
*
* @param subscriber subscriber object
*/
public void register(Object subscriber)
{
boolean async = true;
Subscriber a = subscriber.getClass().getAnnotation(Subscriber.class);
if (a != null)
{
async = a.async();
}
register(subscriber, async);
}
}

View File

@@ -1,82 +0,0 @@
/**
* 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 com.google.common.eventbus.Subscribe;
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;
import sonia.scm.EagerSingleton;
/**
* The subscriber annotation could be use to register listener classes to the
* {@link ScmEventBus}. A registered listener object can use the
* {@link Subscribe} annotation for methods to receive events,
* for more informations have a look at {@link ScmEventBus}. The annotated object
* is only bind to the {@link ScmEventBus}, if the the object is loaded from the
* injection system of SCM-Manager. If your object is not loaded by the
* injection system you have to register your object by yourself with the
* {@link ScmEventBus#register(Object, boolean)} method. If you would like to
* register object which is a "listener only" object you have to use the
* {@link EagerSingleton} scope for your object. E.g.:
*
* <pre><code>
* {@code @}Extension
* {@code @}Subscriber
* {@code @}EagerSingleton
* public class MyListener {
*
* @Subscribe
* public void receiveEvent(Event event){
* // do something with the event
* }
*
* }
* </code></pre>
*
* @author Sebastian Sdorra
* @since 1.23
*
* @apiviz.landmark
*/
@Documented
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Subscriber
{
boolean async() default true;
}

View File

@@ -35,9 +35,9 @@ package sonia.scm.repository.api;
//~--- non-JDK imports --------------------------------------------------------
import com.github.legman.Subscribe;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.eventbus.Subscribe;
import com.google.inject.Inject;
import com.google.inject.Singleton;

View File

@@ -37,11 +37,14 @@ package sonia.scm.event;
import org.junit.Test;
import static org.junit.Assert.*;
import org.junit.Ignore;
/**
* TODO
*
* @author Sebastian Sdorra
*/
@Ignore
public class ScmEventBusTest
{
@@ -71,7 +74,6 @@ public class ScmEventBusTest
* @version Enter version here..., 13/02/17
* @author Enter your name here...
*/
@Subscriber(async = true)
private static class TestAsyncSubscriber {}
@@ -106,9 +108,8 @@ public class ScmEventBusTest
* @param async
*/
@Override
public void register(Object subscriber, boolean async)
public void register(Object subscriber)
{
this.async = async;
}
/**
@@ -138,6 +139,5 @@ public class ScmEventBusTest
* @version Enter version here..., 13/02/17
* @author Enter your name here...
*/
@Subscriber(async = false)
private static class TestSynchronousSubscriber {}
}