Attachment #113875 for bug #240724

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 1-5 Link Here

(-)src/org/eclipse/osgi/tests/eclipseadaptor/AllTests.java (-1 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2005 IBM Corporation and others.	2	* Copyright (c) 2005, 2008 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Chris Aniszczyk <zx@code9.com> - bug 240724
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.osgi.tests.eclipseadaptor;	12	package org.eclipse.osgi.tests.eclipseadaptor;
12		13
Lines 18-23 Link Here
18	TestSuite suite = new TestSuite(AllTests.class.getName());	19	TestSuite suite = new TestSuite(AllTests.class.getName());
19	suite.addTest(EnvironmentInfoTest.suite());	20	suite.addTest(EnvironmentInfoTest.suite());
20	suite.addTest(FilePathTest.suite());	21	suite.addTest(FilePathTest.suite());
		22	suite.addTest(ExecutionEnvironmentTest.suite());
21	return suite;	23	return suite;
22	}	24	}
23	}	25	}




/*******************************************************************************
 * Copyright (c) 2008 Code 9 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:
 *     Code 9 Corporation - initial API and implementation
 *     Chris Aniszczyk <zx@code9.com> - bug 240724
 *******************************************************************************/
package org.eclipse.osgi.tests.eclipseadaptor;

import junit.framework.*;
import org.eclipse.osgi.service.environment.ExecutionEnvironment;
import org.eclipse.osgi.service.environment.ExecutionEnvironmentService;
import org.eclipse.osgi.tests.OSGiTestsActivator;
import org.osgi.framework.ServiceReference;

public class ExecutionEnvironmentTest extends TestCase {

	public static Test suite() {
		return new TestSuite(ExecutionEnvironmentTest.class);
	}

	public ExecutionEnvironmentTest(String name) {
		super(name);
	}

	public void testExecutionEnvironments() {
		ServiceReference reference = null;
		reference = OSGiTestsActivator.getContext().getServiceReference(ExecutionEnvironmentService.class.getName());
		assertNotNull(reference);

		ExecutionEnvironmentService eeService = (ExecutionEnvironmentService) OSGiTestsActivator.getContext().getService(reference);
		assertNotNull(eeService);

		ExecutionEnvironment[] environments = eeService.getExecutionEnvironments();
		assertNotNull(environments);

		ExecutionEnvironment env1 = eeService.getExecutionEnvironment("CDC-1.1/Foundation-1.1"); //$NON-NLS-1$
		assertNotNull(env1);

		// TODO add more tests
	}
}




import java.util.Dictionary;
import java.util.Hashtable;
import org.eclipse.osgi.framework.debug.FrameworkDebugOptions;
import org.eclipse.osgi.service.environment.ExecutionEnvironmentService;
import org.osgi.framework.*;
import org.osgi.service.condpermadmin.ConditionalPermissionAdmin;


 */

public class SystemBundleActivator implements BundleActivator {
	private BundleContext context;
	private Framework framework;
	private ServiceRegistration packageAdmin;
	private ServiceRegistration securityAdmin;
	private ServiceRegistration startLevel;
	private ServiceRegistration debugOptions;
	private ServiceRegistration eeService;

	public SystemBundleActivator() {
	}

	public void start(BundleContext context) throws Exception {
		this.context = context;
		SystemBundle bundle = (SystemBundle) context.getBundle();
		framework = bundle.framework;

		if (framework.packageAdmin != null)

		if ((dbgOptions = FrameworkDebugOptions.getDefault()) != null)
			debugOptions = register(new String[] {org.eclipse.osgi.service.debug.DebugOptions.class.getName()}, dbgOptions);

		eeService = register(new String[] {ExecutionEnvironmentService.class.getName()}, new ExecutionEnvironmentServiceImpl(bundle));
		// Always call the adaptor.frameworkStart() at the end of this method.
		framework.adaptor.frameworkStart(context);
		// attempt to resolve all bundles

			startLevel.unregister();
		if (debugOptions != null)
			debugOptions.unregister();
		if (eeService != null)
			eeService.unregister();
		framework = null;
		bundle = null;
		this.context = null;
	}


	 */
	protected ServiceRegistration register(String[] names, Object service) {
		Hashtable properties = new Hashtable(7);
		Dictionary headers = context.getBundle().getHeaders();
		properties.put(Constants.SERVICE_VENDOR, headers.get(Constants.BUNDLE_VENDOR));
		properties.put(Constants.SERVICE_RANKING, new Integer(Integer.MAX_VALUE));
		properties.put(Constants.SERVICE_PID, context.getBundle().getBundleId() + "." + service.getClass().getName()); //$NON-NLS-1$
		return context.registerService(names, service, properties);
	}





/*******************************************************************************
 * Copyright (c) 2008 Code 9 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:
 *     Chris Aniszczyk <zx@code9.com> - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.service.environment;

/**
 * An execution environment describes the VM which the 
 * framework can run in.  Execution environments describe 
 * the packages available from the VM and the other 
 * execution environments which are supported by the 
 * execution environment (subsets of the execution environment). 
 * 
 * @since 3.5
 * @noimplement This interface is not intended to be implemented by clients.
 */
// TODO Consider making this a concrete class instead of an interface.
public interface ExecutionEnvironment {

	/**
	 * The unique and primary name of the execution environment profile
	 * 
	 * @since 3.5
	 */
	public String getName();

	/**
	 * A comma separated list of export package descriptions that specify
	 * the packages available from this execution environment.
	 * 
	 * @see {@link org.osgi.framework.Constants#FRAMEWORK_SYSTEMPACKAGES}
	 */
	public String getSystemPackages();

	/**
	 * A comma separated list of environment names supported by this 
	 * execution environment.
	 * @see {@link org.osgi.framework.Constants#FRAMEWORK_EXECUTIONENVIRONMENT}
	 */
	public String getSupportedEnvironments();

}




/*******************************************************************************
 * Copyright (c) 2008 Code 9 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:
 *     Chris Aniszczyk <zx@code9.com> - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.service.environment;

/**
 * The profile service is used to register, unregister and acquire profiles.
 * 
 * <p>
 * Profiles available by default:
 * <ul>
 * 	<li>OSGi/Minimum-1.0</li>
 * 	<li>OSGi/Minimum-1.1</li>
 *  <li>CDC-1.0/Foundation-1.0</li>
 *  <li>CDC-1.1/Foundation-1.1</li>
 *  <li>JRE-1.1</li>
 *  <li>J2SE-1.2</li>
 *  <li>J2SE-1.3</li>
 *  <li>J2SE-1.4</li>
 *  <li>J2SE-1.5</li>
 *  <li>JavaSE-1.6</li>
 * </p>
 * 
 * <p>
 * This interface is not intended to be implemented by clients.
 * </p>
 * 
 * @since 3.5
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface ExecutionEnvironmentService {
	/**
	 * Get an execution environment profile.
	 * 
	 * @param name the unique name of the execution environment
	 * 
	 * @return A <code>ExecutionEnvironment</code> for the given unique name.
	 * A value of <code>null</code> is returned if the execution environment 
	 * does not exist.
	 */
	public ExecutionEnvironment getExecutionEnvironment(String name);

	/**
	 * Acquire the list of all available execution environment profiles
	 * 
	 * @param name the unique name of the profile
	 * 
	 * @return A list of <code>ExecutionEnvironment</code> available.  An 
	 * empty array is returned if no execution environments are available.
	 */
	public ExecutionEnvironment[] getExecutionEnvironments();

}




/*******************************************************************************
 * Copyright (c) 2008 Code 9 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:
 *     Chris Aniszczyk <zx@code9.com> - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.framework.internal.core;

import java.io.*;
import java.net.URL;
import java.util.*;
import org.eclipse.osgi.service.environment.ExecutionEnvironment;
import org.eclipse.osgi.service.environment.ExecutionEnvironmentService;
import org.osgi.framework.Bundle;

public class ExecutionEnvironmentServiceImpl implements ExecutionEnvironmentService {

	private final static String PROFILE_EXT = ".profile";
	private final Bundle systemBundle;
	private Map profileMap;

	/** This constructor is called by the Framework */
	protected ExecutionEnvironmentServiceImpl(Bundle systemBundle) {
		this.systemBundle = systemBundle;
	}

	public synchronized ExecutionEnvironment getExecutionEnvironment(String name) {
		return (ExecutionEnvironment) getProfiles().get(name);
	}

	public synchronized ExecutionEnvironment[] getExecutionEnvironments() {
		return (ExecutionEnvironment[]) getProfiles().values().toArray(new ExecutionEnvironment[profileMap.size()]);
	}

	// @GuardedBy(this)
	private Map getProfiles() {
		if (profileMap == null)
			profileMap = new HashMap(7);
		discoverProfiles(profileMap);
		return profileMap;
	}

	private void discoverProfiles(Map profiles) {
		Enumeration frameworkEntries = systemBundle.getEntryPaths("/"); //$NON-NLS-1$
		if (frameworkEntries != null)
			while (frameworkEntries.hasMoreElements()) {
				String path = (String) frameworkEntries.nextElement();
				if (path.endsWith(PROFILE_EXT)) {
					URL profile = systemBundle.getEntry(path);
					ExecutionEnvironment ee = loadEE(profile);
					if (ee != null)
						profiles.put(ee.getName(), ee);
				}
			}
		Enumeration fragmentEntries = systemBundle.findEntries("profiles", "*.profile", false); //$NON-NLS-1$ //$NON-NLS-2$
		if (fragmentEntries != null)
			while (fragmentEntries.hasMoreElements()) {
				URL profile = (URL) fragmentEntries.nextElement();
				ExecutionEnvironment ee = loadEE(profile);
				if (ee != null)
					profiles.put(ee.getName(), ee);
			}
	}

	private ExecutionEnvironment loadEE(URL profile) {
		InputStream in = null;
		try {
			Properties properties = new Properties();
			in = profile.openStream();
			properties.load(new BufferedInputStream(in));
			// time to create profiles!
			return new ExecutionEnvironmentImpl(properties);
		} catch (IOException ex) {
			// TODO consider logging or throwing...
			return null;
		} finally {
			if (in != null)
				try {
					in.close();
				} catch (IOException ee) {
					// do nothing
				}
		}
	}

}




/*******************************************************************************
 * Copyright (c) 2008 Code 9 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:
 *     Chris Aniszczyk <zx@code9.com> - initial API and implementation
 *******************************************************************************/
package org.eclipse.osgi.framework.internal.core;

import java.util.Properties;
import org.eclipse.osgi.service.environment.ExecutionEnvironment;

public class ExecutionEnvironmentImpl implements ExecutionEnvironment {

	private final String name;
	private final String environments;
	private final String packages;

	public ExecutionEnvironmentImpl(Properties properties) {
		this.name = properties.getProperty(Constants.OSGI_JAVA_PROFILE_NAME);
		this.environments = properties.getProperty(Constants.FRAMEWORK_EXECUTIONENVIRONMENT);
		this.packages = properties.getProperty(Constants.FRAMEWORK_SYSTEMPACKAGES);
	}

	public String getName() {
		return name;
	}

	public String getSupportedEnvironments() {
		return environments;
	}

	public String getSystemPackages() {
		return packages;
	}

	public String toString() {
		return name;
	}

}

Return to bug 240724

Lines 14-19 Link Here

(-)core/framework/org/eclipse/osgi/framework/internal/core/SystemBundleActivator.java (-12 / +14 lines)
14	import java.util.Dictionary;	14	import java.util.Dictionary;
15	import java.util.Hashtable;	15	import java.util.Hashtable;
16	import org.eclipse.osgi.framework.debug.FrameworkDebugOptions;	16	import org.eclipse.osgi.framework.debug.FrameworkDebugOptions;
		17	import org.eclipse.osgi.service.environment.ExecutionEnvironmentService;
17	import org.osgi.framework.*;	18	import org.osgi.framework.*;
18	import org.osgi.service.condpermadmin.ConditionalPermissionAdmin;	19	import org.osgi.service.condpermadmin.ConditionalPermissionAdmin;
19		20
Lines 22-41 Link Here
22	*/	23	*/
23		24
24	public class SystemBundleActivator implements BundleActivator {	25	public class SystemBundleActivator implements BundleActivator {
25	protected BundleContext context;	26	private BundleContext context;
26	protected SystemBundle bundle;	27	private Framework framework;
27	protected Framework framework;	28	private ServiceRegistration packageAdmin;
28	protected ServiceRegistration packageAdmin;	29	private ServiceRegistration securityAdmin;
29	protected ServiceRegistration securityAdmin;	30	private ServiceRegistration startLevel;
30	protected ServiceRegistration startLevel;	31	private ServiceRegistration debugOptions;
31	protected ServiceRegistration debugOptions;	32	private ServiceRegistration eeService;
32		33
33	public SystemBundleActivator() {	34	public SystemBundleActivator() {
34	}	35	}
35		36
36	public void start(BundleContext context) throws Exception {	37	public void start(BundleContext context) throws Exception {
37	this.context = context;	38	this.context = context;
38	bundle = (SystemBundle) context.getBundle();	39	SystemBundle bundle = (SystemBundle) context.getBundle();
39	framework = bundle.framework;	40	framework = bundle.framework;
40		41
41	if (framework.packageAdmin != null)	42	if (framework.packageAdmin != null)
Lines 48-53 Link Here
48	if ((dbgOptions = FrameworkDebugOptions.getDefault()) != null)	49	if ((dbgOptions = FrameworkDebugOptions.getDefault()) != null)
49	debugOptions = register(new String[] {org.eclipse.osgi.service.debug.DebugOptions.class.getName()}, dbgOptions);	50	debugOptions = register(new String[] {org.eclipse.osgi.service.debug.DebugOptions.class.getName()}, dbgOptions);
50		51
		52	eeService = register(new String[] {ExecutionEnvironmentService.class.getName()}, new ExecutionEnvironmentServiceImpl(bundle));
51	// Always call the adaptor.frameworkStart() at the end of this method.	53	// Always call the adaptor.frameworkStart() at the end of this method.
52	framework.adaptor.frameworkStart(context);	54	framework.adaptor.frameworkStart(context);
53	// attempt to resolve all bundles	55	// attempt to resolve all bundles
Lines 70-78 Link Here
70	startLevel.unregister();	72	startLevel.unregister();
71	if (debugOptions != null)	73	if (debugOptions != null)
72	debugOptions.unregister();	74	debugOptions.unregister();
73		75	if (eeService != null)
		76	eeService.unregister();
74	framework = null;	77	framework = null;
75	bundle = null;
76	this.context = null;	78	this.context = null;
77	}	79	}
78		80
Lines 82-91 Link Here
82	*/	84	*/
83	protected ServiceRegistration register(String[] names, Object service) {	85	protected ServiceRegistration register(String[] names, Object service) {
84	Hashtable properties = new Hashtable(7);	86	Hashtable properties = new Hashtable(7);
85	Dictionary headers = bundle.getHeaders();	87	Dictionary headers = context.getBundle().getHeaders();
86	properties.put(Constants.SERVICE_VENDOR, headers.get(Constants.BUNDLE_VENDOR));	88	properties.put(Constants.SERVICE_VENDOR, headers.get(Constants.BUNDLE_VENDOR));
87	properties.put(Constants.SERVICE_RANKING, new Integer(Integer.MAX_VALUE));	89	properties.put(Constants.SERVICE_RANKING, new Integer(Integer.MAX_VALUE));
88	properties.put(Constants.SERVICE_PID, bundle.getBundleId() + "." + service.getClass().getName()); //$NON-NLS-1$	90	properties.put(Constants.SERVICE_PID, context.getBundle().getBundleId() + "." + service.getClass().getName()); //$NON-NLS-1$
89	return context.registerService(names, service, properties);	91	return context.registerService(names, service, properties);
90	}	92	}
91		93

Added Link Here

(-)src/org/eclipse/osgi/tests/eclipseadaptor/ExecutionEnvironmentTest.java (+46 lines)
1	/*******************************************************************************
2	* Copyright (c) 2008 Code 9 Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Code 9 Corporation - initial API and implementation
10	* Chris Aniszczyk <zx@code9.com> - bug 240724
11	*******************************************************************************/
12	package org.eclipse.osgi.tests.eclipseadaptor;
13
14	import junit.framework.*;
15	import org.eclipse.osgi.service.environment.ExecutionEnvironment;
16	import org.eclipse.osgi.service.environment.ExecutionEnvironmentService;
17	import org.eclipse.osgi.tests.OSGiTestsActivator;
18	import org.osgi.framework.ServiceReference;
19
20	public class ExecutionEnvironmentTest extends TestCase {
21
22	public static Test suite() {
23	return new TestSuite(ExecutionEnvironmentTest.class);
24	}
25
26	public ExecutionEnvironmentTest(String name) {
27	super(name);
28	}
29
30	public void testExecutionEnvironments() {
31	ServiceReference reference = null;
32	reference = OSGiTestsActivator.getContext().getServiceReference(ExecutionEnvironmentService.class.getName());
33	assertNotNull(reference);
34
35	ExecutionEnvironmentService eeService = (ExecutionEnvironmentService) OSGiTestsActivator.getContext().getService(reference);
36	assertNotNull(eeService);
37
38	ExecutionEnvironment[] environments = eeService.getExecutionEnvironments();
39	assertNotNull(environments);
40
41	ExecutionEnvironment env1 = eeService.getExecutionEnvironment("CDC-1.1/Foundation-1.1"); //$NON-NLS-1$
42	assertNotNull(env1);
43
44	// TODO add more tests
45	}
46	}

Added Link Here

(-)supplement/src/org/eclipse/osgi/service/environment/ExecutionEnvironment.java (+48 lines)
1	/*******************************************************************************
2	* Copyright (c) 2008 Code 9 Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Chris Aniszczyk <zx@code9.com> - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.osgi.service.environment;
12
13	/**
14	* An execution environment describes the VM which the
15	* framework can run in. Execution environments describe
16	* the packages available from the VM and the other
17	* execution environments which are supported by the
18	* execution environment (subsets of the execution environment).
19	*
20	* @since 3.5
21	* @noimplement This interface is not intended to be implemented by clients.
22	*/
23	// TODO Consider making this a concrete class instead of an interface.
24	public interface ExecutionEnvironment {
25
26	/**
27	* The unique and primary name of the execution environment profile
28	*
29	* @since 3.5
30	*/
31	public String getName();
32
33	/**
34	* A comma separated list of export package descriptions that specify
35	* the packages available from this execution environment.
36	*
37	* @see {@link org.osgi.framework.Constants#FRAMEWORK_SYSTEMPACKAGES}
38	*/
39	public String getSystemPackages();
40
41	/**
42	* A comma separated list of environment names supported by this
43	* execution environment.
44	* @see {@link org.osgi.framework.Constants#FRAMEWORK_EXECUTIONENVIRONMENT}
45	*/
46	public String getSupportedEnvironments();
47
48	}