org.eclipse.osbp.runtime.web.vaadin.osgi/src/org/eclipse/osbp/runtime/web/vaadin/osgi/common/OSGiUI.java

/**
 * Copyright (c) 2011, 2015 - 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 v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.runtime.web.vaadin.osgi.common;

import org.eclipse.osbp.runtime.common.dispose.IDisposable;
import org.osgi.service.component.ComponentInstance;

import com.vaadin.server.SessionDestroyEvent;
import com.vaadin.server.SessionDestroyListener;
import com.vaadin.server.VaadinSession;
import com.vaadin.ui.UI;

// TODO: Auto-generated Javadoc
/**
 * The Class OSGiUI.
 */
@SuppressWarnings("serial")
public abstract class OSGiUI extends UI implements SessionDestroyListener,
		IDisposable.Listener {

	/** The instance. */
	private ComponentInstance instance;

	/**
	 * Sets the component instance that can be used to dispose the instance of
	 * that UI.
	 *
	 * @param instance
	 *            the new component instance
	 */
	public void setComponentInstance(ComponentInstance instance) {
		if (this.instance != null) {
			throw new IllegalArgumentException(
					"Component instance may only be set onece!");
		}
		this.instance = instance;
	}

	/* (non-Javadoc)
	 * @see com.vaadin.ui.UI#setSession(com.vaadin.server.VaadinSession)
	 */
	@Override
	public void setSession(VaadinSession session) {
		super.setSession(session);
	}

	/* (non-Javadoc)
	 * @see com.vaadin.ui.UI#attach()
	 */
	@Override
	public void attach() {
		super.attach();

		getSession().getService().addSessionDestroyListener(this);
	}

	/* (non-Javadoc)
	 * @see com.vaadin.server.SessionDestroyListener#sessionDestroy(com.vaadin.server.SessionDestroyEvent)
	 */
	public void sessionDestroy(SessionDestroyEvent event) {
		dispose();
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osbp.runtime.common.dispose.IDisposable.Listener#notifyDisposed(org.eclipse.osbp.runtime.common.dispose.IDisposable)
	 */
	@Override
	public void notifyDisposed(IDisposable notifier) {
		// context was disposed
		if (!isClosing()) {
			close();
		}
	}

	/* (non-Javadoc)
	 * @see com.vaadin.ui.UI#detach()
	 */
	@Override
	public void detach() {
		getSession().getService().removeSessionDestroyListener(this);

		super.detach();

		dispose();
	}

	/**
	 * Is called to remove the instance as an OSGi service and to cleanup the
	 * OSGi runtime.
	 */
	protected void dispose() {
		if (instance != null) {
			instance.dispose();
			instance = null;
		}
	}
}