| /******************************************************************************* |
| * Copyright (c) 2009, 2015 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.e4.core.services.events; |
| |
| import java.util.Dictionary; |
| import java.util.Map; |
| import org.eclipse.e4.core.contexts.IEclipseContext; |
| import org.osgi.service.event.EventHandler; |
| |
| /** |
| * To obtain an instance of the event broker service from the |
| * {@link IEclipseContext} context, use |
| * |
| * <pre> |
| * context.get(IEventBroker.class) |
| * </pre> |
| * |
| * @noimplement This interface is not intended to be implemented by clients. |
| * @since 1.1 |
| */ |
| public interface IEventBroker { |
| |
| /** |
| * The name of the default event attribute used to pass data. |
| */ |
| String DATA = "org.eclipse.e4.data"; //$NON-NLS-1$ |
| |
| /** |
| * Publish event synchronously (the method does not return until the event is processed). |
| * <p> |
| * If data is a {@link Map} or a {@link Dictionary}, it is passed as is. Otherwise, a new Map is |
| * constructed and its {@link #DATA} attribute is populated with this value. |
| * </p> |
| * |
| * @param topic |
| * topic of the event to be published |
| * @param data |
| * data to be published with the event |
| * @return <code>true</code> if this operation was performed successfully; <code>false</code> |
| * otherwise |
| */ |
| boolean send(String topic, Object data); |
| |
| /** |
| * Publish event asynchronously (this method returns immediately). |
| * <p> |
| * If data is a {@link Map} or a {@link Dictionary}, it is passed as is. Otherwise, a new Map is |
| * constructed and its {@link #DATA} attribute is populated with this value. |
| * </p> |
| * |
| * @param topic |
| * topic of the event to be published |
| * @param data |
| * data to be published with the event |
| * @return <code>true</code> if this operation was performed successfully; <code>false</code> |
| * otherwise |
| */ |
| boolean post(String topic, Object data); |
| |
| /** |
| * Subscribe for events on the given topic. |
| * <p> |
| * The handler will be called on the UI thread. |
| * </p> |
| * |
| * @param topic |
| * topic of interest |
| * @param eventHandler |
| * object to call when an event of interest arrives |
| * @return <code>true</code> if this operation was performed successfully; <code>false</code> |
| * otherwise |
| */ |
| boolean subscribe(String topic, EventHandler eventHandler); |
| |
| /** |
| * Subscribe for events on the given topic. |
| * <p> |
| * The handler will be called on the UI thread if "headless" is set to |
| * <code>false</code>. |
| * </p> |
| * |
| * @param topic |
| * topic of interest |
| * @param filter |
| * the LDAP event filter |
| * @param eventHandler |
| * object to call when an event of interest arrives |
| * @param headless |
| * <code>true</code> if handing of the events does not require |
| * UI; <code>false</code> otherwise |
| * @return <code>true</code> if this operation was performed successfully; |
| * <code>false</code> otherwise |
| */ |
| boolean subscribe(String topic, String filter, EventHandler eventHandler, |
| boolean headless); |
| |
| /** |
| * Unsubscribe handler previously registered using {@link #subscribe(String, EventHandler)}. |
| * |
| * @param eventHandler |
| * previously registered event handler |
| * @return <code>true</code> if this operation was performed successfully; <code>false</code> |
| * otherwise |
| */ |
| boolean unsubscribe(EventHandler eventHandler); |
| } |