org.eclipse.osbp.runtime.usernotification/src/org/eclipse/osbp/runtime/notification/impl/UserNotificationService.java

/*******************************************************************************
 * Copyright (c) 2009, 2013 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Florian Pirchner - adjustments to osbp code
 *******************************************************************************/
package org.eclipse.osbp.runtime.notification.impl;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;

import org.eclipse.osbp.runtime.common.event.IEventBroker;
import org.eclipse.osbp.runtime.notification.IUserNotificationService;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventAdmin;
import org.osgi.service.event.EventConstants;
import org.osgi.service.event.EventHandler;

// TODO: Auto-generated Javadoc
/**
 * The Class UserNotificationService.
 */
@Component
public class UserNotificationService implements IUserNotificationService {

	/** The registrations. */
	private Map<EventHandler, Collection<ServiceRegistration<?>>> registrations = new HashMap<EventHandler, Collection<ServiceRegistration<?>>>();

	/** The event admin. */
	private EventAdmin eventAdmin;

	/** The context. */
	private ComponentContext context;

	/**
	 * Instantiates a new user notification service.
	 */
	public UserNotificationService() {
	}

	/**
	 * Activate.
	 *
	 * @param context
	 *            the context
	 */
	@Activate
	protected void activate(ComponentContext context) {
		this.context = context;
	}

	/**
	 * Deactivate.
	 *
	 * @param context
	 *            the context
	 */
	@Deactivate
	protected void deactivate(ComponentContext context) {
		Collection<Collection<ServiceRegistration<?>>> values = new ArrayList<Collection<ServiceRegistration<?>>>(
				registrations.values());
		registrations.clear();
		for (Collection<ServiceRegistration<?>> handled : values) {
			for (ServiceRegistration<?> registration : handled) {
				registration.unregister();
			}
		}

		this.context = null;
	}

	/**
	 * Bind event admin.
	 *
	 * @param eventAdmin
	 *            the event admin
	 */
	@Reference(cardinality = ReferenceCardinality.MANDATORY, unbind = "unbindEventAdmin")
	protected void bindEventAdmin(EventAdmin eventAdmin) {
		this.eventAdmin = eventAdmin;
	}

	/**
	 * Unbind event admin.
	 *
	 * @param eventAdmin
	 *            the event admin
	 */
	protected void unbindEventAdmin(EventAdmin eventAdmin) {
		this.eventAdmin = null;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.notification.IUserNotificationService#send(java.lang.String, java.lang.Object)
	 */
	@Override
	public boolean send(String userId, Object data) {
		Event event = constructEvent(userId, data);
		eventAdmin.sendEvent(event);
		return true;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.notification.IUserNotificationService#post(java.lang.String, java.lang.Object)
	 */
	@Override
	public boolean post(String userId, Object data) {
		Event event = constructEvent(userId, data);
		eventAdmin.postEvent(event);
		return true;
	}

	/**
	 * Construct event.
	 *
	 * @param userId
	 *            the user id
	 * @param data
	 *            the data
	 * @return the event
	 */
	@SuppressWarnings("unchecked")
	private Event constructEvent(String userId, Object data) {
		Event event;
		if (data instanceof Dictionary<?, ?>) {
			event = new Event(userId, (Dictionary<String, ?>) data);
		} else if (data instanceof Map<?, ?>) {
			event = new Event(userId, (Map<String, ?>) data);
		} else {
			Dictionary<String, Object> d = new Hashtable<String, Object>(2);
			d.put(EventConstants.EVENT_TOPIC, userId);
			if (data != null)
				d.put(IEventBroker.DATA, data);
			event = new Event(userId, d);
		}
		return event;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.notification.IUserNotificationService#subscribe(java.lang.String, org.osgi.service.event.EventHandler)
	 */
	@Override
	public boolean subscribe(String userId, EventHandler eventHandler) {
		return subscribe(userId, null, eventHandler, false);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.notification.IUserNotificationService#subscribe(java.lang.String, java.lang.String, org.osgi.service.event.EventHandler, boolean)
	 */
	@Override
	public boolean subscribe(String userId, String filter,
			EventHandler eventHandler, boolean headless) {
		BundleContext bundleContext = context.getBundleContext();
		String[] userIds = new String[] { userId };
		Dictionary<String, Object> d = new Hashtable<String, Object>();
		d.put(EventConstants.EVENT_TOPIC, userIds);
		if (filter != null) {
			d.put(EventConstants.EVENT_FILTER, filter);
		}
		ServiceRegistration<?> registration = bundleContext.registerService(
				EventHandler.class.getName(), eventHandler, d);
		Collection<ServiceRegistration<?>> handled = registrations
				.get(eventHandler);
		if (handled == null) {
			registrations.put(eventHandler,
					handled = new ArrayList<ServiceRegistration<?>>());
		}
		handled.add(registration);
		return true;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.notification.IUserNotificationService#unsubscribe(org.osgi.service.event.EventHandler)
	 */
	@Override
	public boolean unsubscribe(EventHandler eventHandler) {
		Collection<ServiceRegistration<?>> handled = registrations
				.remove(eventHandler);
		if (handled == null || handled.isEmpty())
			return false;
		for (ServiceRegistration<?> r : handled) {
			r.unregister();
		}
		return true;
	}

}