org.eclipse.osbp.vaaclipse.addons.app/src/org/eclipse/osbp/vaaclipse/addons/app/webapp/HttpServiceTracker.java

/*******************************************************************************
 * Copyright (c) 2012, 2014 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * 
 * All rights reserved. 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
 * 
 * Information:
 * 		Based on original sources of 
 * 				- org.vaadin.osgi.Activator from Chris Brind
 *				- com.c4biz.osgiutils.vaadin.equinox.shiro.HttpServiceTracker from Cristiano Gaviao
 *
 * Contributors:
 *    Florian Pirchner - migrated to vaadin 7 and copied into org.eclipse.osbp namespace
 *    
 *******************************************************************************/
package org.eclipse.osbp.vaaclipse.addons.app.webapp;

import java.util.Hashtable;
import java.util.IdentityHashMap;
import java.util.Map;

import org.eclipse.equinox.http.servlet.ExtendedHttpService;
import org.eclipse.osbp.ecview.jetty.manager.IJettyManager;
import org.eclipse.osbp.vaaclipse.addons.app.common.Constants;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Filter;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.cm.ConfigurationException;
import org.osgi.service.cm.ManagedService;
import org.osgi.service.component.ComponentFactory;
import org.osgi.util.tracker.ServiceTracker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This tracker takes a {@link ComponentFactory} and then creates a
 * {@link VaadinWebApplicationRegister} class which is then registered as a
 * {@link ManagedService} to receive configuration for that specific
 * application.
 * 
 * @author brindy - initial contribution cvgaviao - using ExtendedHttpService
 *         that added support to filters
 */
@SuppressWarnings(value = { "rawtypes", "unchecked" })
public class HttpServiceTracker extends ServiceTracker {

	/** The logger. */
	private static Logger logger = LoggerFactory
			.getLogger(HttpServiceTracker.class);

	/** The web application. */
	private VaadinWebApplication webApplication;

	/** The configs. */
	private Map<ExtendedHttpService, VaadinWebApplicationRegister> configs = new IdentityHashMap<ExtendedHttpService, VaadinWebApplicationRegister>();

	/**
	 * Instantiates a new http service tracker.
	 *
	 * @param ctx
	 *            the ctx
	 * @param webApplication
	 *            the web application
	 */
	public HttpServiceTracker(BundleContext ctx,
			VaadinWebApplication webApplication) {
		super(ctx, createFilter(ctx, webApplication), null);
		this.webApplication = webApplication;
	}

	/**
	 * Creates the filter.
	 *
	 * @param ctx
	 *            the ctx
	 * @param webApplication
	 *            the web application
	 * @return the filter
	 */
	private static Filter createFilter(BundleContext ctx,
			VaadinWebApplication webApplication) {
		// search for http service with the given context path of type
		// application.
		String filter = String.format("(&(%s=%s)(%s=%s)(%s=%s))",
				org.osgi.framework.Constants.OBJECTCLASS,
				ExtendedHttpService.class.getName(), "other.info",
				webApplication.getContextPath(),
				IJettyManager.PROP_SERVICE_TYPE,
				IJettyManager.SERVICE_TYPE__APPLICATION);
		try {
			return ctx.createFilter(filter);
		} catch (InvalidSyntaxException e) {
			logger.error("{}", e);
		}
		return null;
	}

	/**
	 * Gets the alias.
	 *
	 * @return the alias
	 */
	public String getAlias() {
		return webApplication.getAlias();
	}

	/* (non-Javadoc)
	 * @see org.osgi.util.tracker.ServiceTracker#addingService(org.osgi.framework.ServiceReference)
	 */
	@Override
	public Object addingService(ServiceReference reference) {
		ExtendedHttpService http = (ExtendedHttpService) super
				.addingService(reference);

		// register the application
		VaadinWebApplicationRegister config = new VaadinWebApplicationRegister(
				http, webApplication);

		logger.debug("Application for alias \"" + getAlias()
				+ "\" was created.");

		// save it for later
		configs.put(http, config);

		// register as a managed service so that alternative properties can
		// be provided
		Hashtable<String, String> properties = new Hashtable<String, String>();
		properties.put(org.osgi.framework.Constants.SERVICE_PID,
				Constants.PROP_MANAGED_SERVICE_PREFIX + "." + getAlias());
		context.registerService(ManagedService.class.getName(), config,
				properties);

		try {
			config.updated(null);
		} catch (ConfigurationException e) {
			logger.warn("Initial setup caused exception: !" + e);
		}

		return http;
	}

	/* (non-Javadoc)
	 * @see org.osgi.util.tracker.ServiceTracker#removedService(org.osgi.framework.ServiceReference, java.lang.Object)
	 */
	@Override
	public void removedService(ServiceReference reference, Object service) {
		configs.remove(service).kill();
		logger.debug("Application for alias \"" + getAlias()
				+ "\" was removed.");

		super.removedService(reference, service);
	}

}