org.eclipse.osbp.runtime.web.vaadin.osgi/src/org/eclipse/osbp/runtime/web/vaadin/osgi/common/IVaadinApplication.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 java.util.List;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.osbp.runtime.web.vaadin.osgi.webapp.OSGiUIProvider;

// TODO: Auto-generated Javadoc
/**
 * A wrapper that handles the registration of servlets, resources and filters at
 * the HttpService.
 */
public interface IVaadinApplication {

	/**
	 * Returns the current status of the vaadin application.
	 *
	 * @return the status
	 */
	IStatus getStatus();

	/**
	 * Returns the id of that application.
	 *
	 * @return the id
	 */
	String getId();

	/**
	 * Returns the name of the application.
	 *
	 * @return the name
	 */
	String getName();

	/**
	 * Returns the alias to access the vaadin web UI.
	 *
	 * @return the UI alias
	 */
	String getUIAlias();

	/**
	 * Returns the name of the HTTP application that vaadin application should
	 * be deployed at.
	 *
	 * @return the http application
	 */
	String getHttpApplication();

	/**
	 * Returns the name of the widget set.
	 *
	 * @return the widget set name
	 */
	String getWidgetSetName();

	/**
	 * Returns true, if the application is running in production mode.
	 *
	 * @return true, if is production mode
	 */
	boolean isProductionMode();

	/**
	 * Returns a list of ui providers available for the vaadin web application.
	 *
	 * @return the ui providers
	 */
	List<OSGiUIProvider> getUiProviders();

	/**
	 * Returns true, if the application is started.
	 *
	 * @return true, if is started
	 */
	boolean isStarted();

	/**
	 * Returns true, if the application is deployed to a servlet container.
	 *
	 * @return true, if is deployed
	 */
	boolean isDeployed();

	/**
	 * Starts the application. All required servlets, resources and filters will
	 * be registered at the http service.
	 */
	void start();

	/**
	 * Stops the application. All servlets, resources and filters will be
	 * unregistered at the http service.
	 */
	void stop();

}