org.apache.felix.eventadmin.impl.handler

Class EventAdminImpl

java.lang.Object

org.apache.felix.eventadmin.impl.handler.EventAdminImpl

All Implemented Interfaces:

org.osgi.service.event.EventAdmin

public class EventAdminImpl
extends Object
implements org.osgi.service.event.EventAdmin

This is the actual implementation of the OSGi R4 Event Admin Service (see the Compendium 113 for details). The implementation uses a HandlerTasks in order to determine applicable EventHandler for a specific event and subsequently dispatches the event to the handlers via DeliverTasks. To do this, it uses two different DeliverTasks one for asynchronous and one for synchronous event delivery depending on whether its post() or its send() method is called. Note that the actual work is done in the implementations of the DeliverTasks. Additionally, a stop method is provided that prevents subsequent events to be delivered.

Author:

Felix Project Team

Constructor Summary

Constructors

Constructor and Description
EventAdminImpl(org.osgi.framework.BundleContext bundleContext, org.apache.felix.eventadmin.impl.tasks.DefaultThreadPool syncPool, org.apache.felix.eventadmin.impl.tasks.DefaultThreadPool asyncPool, int timeout, String[] ignoreTimeout, boolean requireTopic, String[] ignoreTopics, boolean addTimestamp, boolean addSubject) The constructor of the EventAdmin implementation.

Method Summary

Modifier and Type	Method and Description
void	postEvent(org.osgi.service.event.Event event) Post an asynchronous event.
void	sendEvent(org.osgi.service.event.Event event) Send a synchronous event.
void	stop() This method can be used to stop the delivery of events.
void	update(int timeout, String[] ignoreTimeout, boolean requireTopic, String[] ignoreTopics, boolean addTimestamp, boolean addSubject) Update the event admin with new configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventAdminImpl

public EventAdminImpl(org.osgi.framework.BundleContext bundleContext,
                      org.apache.felix.eventadmin.impl.tasks.DefaultThreadPool syncPool,
                      org.apache.felix.eventadmin.impl.tasks.DefaultThreadPool asyncPool,
                      int timeout,
                      String[] ignoreTimeout,
                      boolean requireTopic,
                      String[] ignoreTopics,
                      boolean addTimestamp,
                      boolean addSubject)

The constructor of the EventAdmin implementation.

Parameters:

bundleContext - The bundle context to use.

syncPool - The synchronous thread pool.

asyncPool - The asynchronous thread pool.

timeout - The thread execution timeout.

ignoreTimeout - The thread ignore timeout.

requireTopic - True to define the topic as required, false else.

ignoreTopics - The array of topics to ignore.

addTimestamp - True to add timestamp to the event, false else.

addSubject - True to add subject to the event, false else.

Method Detail

postEvent

public void postEvent(org.osgi.service.event.Event event)

Post an asynchronous event.

Specified by:

postEvent in interface org.osgi.service.event.EventAdmin

Parameters:

event - The event to be posted by this service.

Throws:

IllegalStateException - In case we are stopped.

See Also:

EventAdmin.postEvent(org.osgi.service.event.Event)

sendEvent

public void sendEvent(org.osgi.service.event.Event event)

Send a synchronous event.

Specified by:

sendEvent in interface org.osgi.service.event.EventAdmin

Parameters:

event - The event to be send by this service.

Throws:

IllegalStateException - In case we are stopped.

See Also:

EventAdmin.sendEvent(org.osgi.service.event.Event)

stop

public void stop()

This method can be used to stop the delivery of events.

update

public void update(int timeout,
                   String[] ignoreTimeout,
                   boolean requireTopic,
                   String[] ignoreTopics,
                   boolean addTimestamp,
                   boolean addSubject)

Update the event admin with new configuration.

Parameters:

timeout - The event timeout.

ignoreTimeout - The event ignore timeout.

requireTopic - True if the event require a topic, false else.

ignoreTopics - The array of topic to ignore.

addTimestamp - True to add timestamp to the event, false else.

addSubject - True to add subject to the event, false else.