expoint.bundleClasspathResolvers.name = Bundle Classpath Resolvers

     <extension-point id="bundleClasspathResolvers" name="%expoint.bundleClasspathResolvers.name" schema="schema/bundleClasspathResolvers.exsd"/>

<?xml version='1.0' encoding='UTF-8'?>

<!-- Schema file written by PDE -->

<schema targetNamespace="org.eclipse.pde.core" xmlns="http://www.w3.org/2001/XMLSchema">

<annotation>

      <appInfo>

         <meta.schema plugin="org.eclipse.pde.core" id="bundleClasspathResolvers" name="Bundle Classpath Resolver"/>

      </appInfo>

      <documentation>

         This extension point allows clients to add bundle classpath entries and source lookup path entries locations and source lookup path.

      </documentation>

   </annotation>

   <element name="extension">

      <annotation>

         <appInfo>

            <meta.element />

         </appInfo>

      </annotation>

      <complexType>

         <sequence>

            <element ref="resolver" minOccurs="0" maxOccurs="unbounded"/>

         </sequence>

         <attribute name="point" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="id" type="string">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="name" type="string">

            <annotation>

               <documentation>

               </documentation>

               <appInfo>

                  <meta.attribute translatable="true"/>

               </appInfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <element name="resolver">

      <complexType>

         <attribute name="nature" type="string" use="required">

            <annotation>

               <documentation>

                  Nature of the projects this resolver is enabled for.

               </documentation>

            </annotation>

         </attribute>

         <attribute name="class" type="string" use="required">

            <annotation>

               <documentation>

                  The class that implements this dynamic bundle classpath entry resolver. The class must implement <code>IBundleClasspathResolver</code>

               </documentation>

               <appInfo>

                  <meta.attribute kind="java" basedOn=":org.eclipse.pde.core.IBundleClasspathResolver"/>

               </appInfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <annotation>

      <appInfo>

         <meta.section type="since"/>

      </appInfo>

      <documentation>

         3.8

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="examples"/>

      </appInfo>

      <documentation>

         The following is an example of a classpath provider: 

<p>

<pre>

  <extension

        point="org.eclipse.pde.core.bundleClasspathResolvers">

     <resolver

           class="org.eclipse.example.pde.SomeResolver"

           nature="org.eclipse.example.projectNature">

     </resolver>

  </extension>

</pre>

</p>

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="apiinfo"/>

      </appInfo>

      <documentation>

         Each classpath resolver must provide a class that implements <code>org.eclipse.pde.core.IBundleClasspathResolver</code> interface.

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="copyright"/>

      </appInfo>

      <documentation>

         Copyright (c) 2011 Sonatype, Inc. and others.<br>

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

<a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

      </documentation>

   </annotation>

</schema>

/*******************************************************************************

 * Copyright (c) 2011 Sonatype, Inc. 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:

 *      Sonatype, Inc. - initial API and implementation

 *      IBM Corporation - ongoing enhancements

 *******************************************************************************/

package org.eclipse.pde.core;

import java.util.Collection;

import java.util.Map;

import org.eclipse.core.runtime.IPath;

import org.eclipse.jdt.core.IJavaProject;

import org.eclipse.jdt.launching.IRuntimeClasspathEntry;

/**

 * Resolves dynamically generated bundle classpath entries in the context of a java project.

 * 

 * <p>

 * Generally, dynamically generated bundle classpath entries are not present under project

 * source tree but included in the bundle as part build process. During development time such bundle classpath entries

 * can be resolved to external jar files or workspace resources. Resolution of the

 * same entry may change over time, similarly to how Plug-in Dependencies classpath container can switch between 

 * external bundles and workspace projects.

 * </p>

 * 

 * <p>

 * A resolver is declared as an extension (<code>org.eclipse.pde.core.bundleClasspathResolvers</code>). This 

 * extension has the following attributes: 

 * <ul>

 * <li><code>nature</code> specified nature of the projects this resolver is registered for.</li>

 * <li><code>class</code> specifies the fully qualified name of the Java class that implements 

 *     <code>IBundleClasspathResolver</code>.</li>

 * </ul>

 * </p>

 * <p> 

 * The resolver is consulted when dynamically generated bundle is added to OSGi runtime launch and when looking up 

 * sources from the bundle.

 * </p>

 * 

 * @since 3.8

 */

public interface IBundleClasspathResolver {

	/**

	 * Returns a possibly empty map describing additional bundle classpath entries for a project in the workspace.

	 * 

	 * <p>The map key is a {@link IPath} describing the project relative path to a source directory or library.  The value

	 * is the {@link Collection} of {@link IPath} locations (relative to the project or absolute) that should be added

	 * to the bundle classpath.</p>

	 * 

	 * @param javaProject the java project to collect classpath entries for

	 * @return additional entries to add to the bundle classpath. Map of IPath to Collection, possibly empty

	 */

	public Map/*<IPath, Collection<IPath>>*/getAdditionalClasspathEntries(IJavaProject javaProject);

	/**

	 * Returns a possibly empty collection listing additional classpath entries for the source lookup path of a project in the workspace.

	 * 

	 * <p>The {@link Collection} will contain {@link IRuntimeClasspathEntry} describing locations where source can be obtained from.</p>

	 * 

	 * @param javaProject the java project to collect source entries for

	 * @return additional entries for the source lookup path. Collection of IRuntimeClasspathEntry, possibly empty

	 */

	public Collection/*<IRuntimeClasspathEntry>*/getAdditionalSourceEntries(IJavaProject javaProject);

}

/*******************************************************************************

 * Copyright (c) 2011 Sonatype, Inc. 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:

 *      Sonatype, Inc. - initial API and implementation

 *      IBM Corporation - ongoing enhancements

 *******************************************************************************/

package org.eclipse.pde.internal.core;

import java.util.ArrayList;

import java.util.List;

import org.eclipse.core.resources.IProject;

import org.eclipse.core.runtime.*;

import org.eclipse.pde.core.IBundleClasspathResolver;

/**

 * Manager for client contributed IBundleClasspathResolvers. Collects the resolvers from the <code>

 * org.eclipse.pde.core.bundleClasspathResolvers</code> extension point.  Classpath resolvers

 * can then be asked to provide additional bundle classpath and source lookup entries for a project.

 * 

 * @see IBundleClasspathResolver

 */

public class ClasspathContainerResolverManager {

	private static final String POINT_ID = "org.eclipse.pde.core.bundleClasspathResolvers"; //$NON-NLS-1$

	private static final String ATT_NATURE = "nature"; //$NON-NLS-1$

	private static final String ATT_CLASS = "class"; //$NON-NLS-1$

	/**

	 * Returns all classpath resolvers contributed via extension point that support the given project's nature.

	 * 

	 * @param project project to check nature of

	 * @return all classpath resolvers that support the nature, possibly empty

	 */

	public IBundleClasspathResolver[] getBundleClasspathResolvers(IProject project) {

		List result = new ArrayList();

		IExtensionRegistry registry = Platform.getExtensionRegistry();

		IConfigurationElement[] elements = registry.getConfigurationElementsFor(POINT_ID);

		for (int i = 0; i < elements.length; i++) {

			String attrNature = elements[i].getAttribute(ATT_NATURE);

			try {

				if (project.isNatureEnabled(attrNature)) {

					result.add(elements[i].createExecutableExtension(ATT_CLASS));

				}

			} catch (CoreException e) {

				PDECore.log(e.getStatus());

			}

		}

		return (IBundleClasspathResolver[]) result.toArray(new IBundleClasspathResolver[result.size()]);

	}

}

import org.eclipse.pde.core.IBundleClasspathResolver;

			}

		}

		// Add additional entries from contributed bundle classpath resolvers

		IBundleClasspathResolver[] resolvers = PDECore.getDefault().getClasspathContainerResolverManager().getBundleClasspathResolvers(project);

		for (int i = 0; i < resolvers.length; i++) {

			Map resolved = resolvers[i].getAdditionalClasspathEntries(jProject);

			Iterator resolvedIter = resolved.entrySet().iterator();

			while (resolvedIter.hasNext()) {

				Map.Entry resolvedEntry = (Map.Entry) resolvedIter.next();

				IPath ceSource = (IPath) resolvedEntry.getKey();

				ArrayList list = (ArrayList) map.get(ceSource);

				if (list == null) {

					list = new ArrayList();

					map.put(ceSource, list);

				}

				list.addAll((Collection) resolvedEntry.getValue());

			else

				path = new Path(libName);

import org.eclipse.pde.core.IBundleClasspathResolver;

	private ClasspathContainerResolverManager fClasspathContainerResolverManager;

	/**

	 * Returns the singleton instance of the classpath container resolver manager used to dynamically

	 * resolve a project's classpath. Clients may contribute a {@link IBundleClasspathResolver} to the

	 * manager through the <code>org.eclipse.pde.core.bundleClasspathResolvers</code> extension.

	 * 

	 * @return singleton instance of the classpath container resolver manager

	 */

	public synchronized ClasspathContainerResolverManager getClasspathContainerResolverManager() {

		if (fClasspathContainerResolverManager == null) {

			fClasspathContainerResolverManager = new ClasspathContainerResolverManager();

		}

		return fClasspathContainerResolverManager;

	}

import org.eclipse.pde.core.IBundleClasspathResolver;

		// Add additional entries from contributed classpath container resolvers

		IBundleClasspathResolver[] resolvers = PDECore.getDefault().getClasspathContainerResolverManager().getBundleClasspathResolvers(project);

		for (int i = 0; i < resolvers.length; i++) {

			result.addAll(resolvers[i].getAdditionalSourceEntries(jProject));

		}