com.azaptree.services.eventbus.EventBusService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azaptree-eventbus-service Show documentation

Wrapper around Guava's EventBus. Value adds are: 1. Spring enabled 2. Can be configured to be synchronous / asynchronous 3. Logs warning messages for DeadEvents 4. Spring bean name is used by default as the EventBus identifier, but can be configured to use any identifier

The newest version!

package com.azaptree.services.eventbus;

/*
 * #%L
 * EventBus Service
 * %%
 * Copyright (C) 2012 AZAPTREE.COM
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Wrapper service around Guava's EventBus
 * 
 * 
 * @author Alfio Zappala
 * 
 */
public interface EventBusService extends EventBusServiceJmxApi {
	public static final Logger log = LoggerFactory.getLogger(EventBusService.class);

	

	/**
	 * 
	 * @param event
	 *            REQUIRED
	 * @throws IllegalArgumentException
	 *             if event is null
	 */
	void post(Object event);

	/**
	 * Each of the object's methods that are annotated with the com.google.common.eventbus.Subscribe annotation will be
	 * registered as handler methods.
	 * 
	 * @param eventHandler
	 *            Immediately upon invoking register(Object) , the listener being registered is checked for the well-formedness of its handler methods.
	 *            Specifically, the object must have at least one method annotated with @Subscribe and any methods marked with @Subscribe must take only a
	 *            single argument. Any violations of this rule will cause an IllegalArgumentException to be thrown.
	 * @throws IllegalArgumentException
	 */
	void register(Object eventHandler);

	/**
	 * 
	 * @param eventHandler
	 *            REQUIRED
	 * 
	 * @throws IllegalArgumentException
	 *             if event is null
	 */
	void unregister(Object eventHandler);
}