org.eclipse.osbp.runtime.event

Class EventBroker

java.lang.Object

org.eclipse.osbp.runtime.event.EventBroker

All Implemented Interfaces:

IEventBroker

public class EventBroker
extends Object
implements IEventBroker

Field Summary

Fields inherited from interface org.eclipse.osbp.runtime.common.event.IEventBroker

DATA

Constructor Summary

Constructors

Constructor and Description
EventBroker()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
protected void	bindEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)
protected void	deactivate(org.osgi.service.component.ComponentContext context)
boolean	post(String topic, Object data) Publish event asynchronously (this method returns immediately).
boolean	send(String topic, Object data) Publish event synchronously (the method does not return until the event is processed).
boolean	subscribe(String topic, org.osgi.service.event.EventHandler eventHandler) Subscribe for events on the given topic.
boolean	subscribe(String topic, String filter, org.osgi.service.event.EventHandler eventHandler, boolean headless) Subscribe for events on the given topic.
protected void	unbindEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)
boolean	unsubscribe(org.osgi.service.event.EventHandler eventHandler) Unsubscribe handler previously registered using IEventBroker.subscribe(String, EventHandler).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventBroker

public EventBroker()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext context)

bindEventAdmin

protected void bindEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)

unbindEventAdmin

protected void unbindEventAdmin(org.osgi.service.event.EventAdmin eventAdmin)

send

public boolean send(String topic,
                    Object data)

Description copied from interface: IEventBroker

Publish event synchronously (the method does not return until the event is processed).

If data is a Map or a Dictionary, it is passed as is. Otherwise, a new Map is constructed and its IEventBroker.DATA attribute is populated with this value.

Specified by:

send in interface IEventBroker

Parameters:

topic - topic of the event to be published

data - data to be published with the event

Returns:

true if this operation was performed successfully; false otherwise

post

public boolean post(String topic,
                    Object data)

Description copied from interface: IEventBroker

Publish event asynchronously (this method returns immediately).

If data is a Map or a Dictionary, it is passed as is. Otherwise, a new Map is constructed and its IEventBroker.DATA attribute is populated with this value.

Specified by:

post in interface IEventBroker

Parameters:

topic - topic of the event to be published

data - data to be published with the event

Returns:

true if this operation was performed successfully; false otherwise

subscribe

public boolean subscribe(String topic,
                         org.osgi.service.event.EventHandler eventHandler)

Description copied from interface: IEventBroker

Subscribe for events on the given topic.

The handler will be called on the UI thread.

Specified by:

subscribe in interface IEventBroker

Parameters:

topic - topic of interest

eventHandler - object to call when an event of interest arrives

Returns:

true if this operation was performed successfully; false otherwise

subscribe

public boolean subscribe(String topic,
                         String filter,
                         org.osgi.service.event.EventHandler eventHandler,
                         boolean headless)

Description copied from interface: IEventBroker

Subscribe for events on the given topic.

The handler will be called on the UI thread if "headless" is set to true.

Specified by:

subscribe in interface IEventBroker

Parameters:

topic - topic of interest

filter - the LDAP event filter

eventHandler - object to call when an event of interest arrives

headless - true if handing of the events does not require UI; false otherwise

Returns:

true if this operation was performed successfully; false otherwise

unsubscribe

public boolean unsubscribe(org.osgi.service.event.EventHandler eventHandler)

Description copied from interface: IEventBroker

Unsubscribe handler previously registered using IEventBroker.subscribe(String, EventHandler).

Specified by:

unsubscribe in interface IEventBroker

Parameters:

eventHandler - previously registered event handler

Returns:

true if this operation was performed successfully; false otherwise