org.eclipse.osbp.runtime.web.common/src/org/eclipse/osbp/runtime/web/common/IWebContextRegistry.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.common;

import java.util.Map;

// TODO: Auto-generated Javadoc
/**
 * A registry for web contexts. Web contexts are created by that service. And it
 * also observes the lifecycle of them.
 */
public interface IWebContextRegistry {

	/**
	 * Returns the count of the contained contexts.
	 *
	 * @return the int
	 */
	int size();

	/**
	 * Creates a webcontext for the given user.
	 *
	 * @param user
	 *            The user id.
	 * @param properties
	 *            Will be passed to the context. Should only contain primitive
	 *            types, their wrappers and java types.
	 * @return the i web context
	 */
	IWebContext createContext(String user, Map<String, Object> properties);

	/**
	 * Returns the webcontext for the given id or <code>null</code> if no
	 * context is available.
	 *
	 * @param id
	 *            the id
	 * @return the context
	 */
	IWebContext getContext(String id);
}