Need more clarification for: getRuntimeClasspathElements() from the type MavenProject is deprecated.

[eitan-rosenberg]

Affected version

4.0.0-rc-5

Bug description

I am migrating a Mojo of mine to Maven 4.0.
I am using org.apache.maven.project.MavenProject and I am getting
"The method getRuntimeClasspathElements() from the type MavenProject is deprecated"

MavenProject.getRuntimeClasspathElements() is deprecated, and the documentation is pointing to org.apache.maven.api.JavaPathType.

Is there somewhere an example of how to use org.apache.maven.api.JavaPathType ?
Can I safely use getRuntimeClasspathElements ?

Thanks for any response.

[desruisseaux]

In my understanding, the whole org.apache.maven.project.MavenProject class is deprecated, even if it does not yet have the @Deprecated annotation (maybe because it is still used internally by Maven). It is replaced by org.apache.maven.api.Project. For getting the dependencies, you can use:

import org.apache.maven.api.PathScope;
import org.apache.maven.api.PathType;
import org.apache.maven.api.Project;
import org.apache.maven.api.Session;
import org.apache.maven.api.di.Inject;
import org.apache.maven.api.plugin.Mojo;
import org.apache.maven.api.plugin.MojoException;
import org.apache.maven.api.services.DependencyResolver;
import org.apache.maven.api.services.DependencyResolverRequest;
import org.apache.maven.api.services.DependencyResolverResult;

class MyMojo implements Mojo {
    @Inject
    private Session session;

    @Inject
    private Project project;

    @Override
    public void execute() throws MojoException {
        DependencyResolver resolver = session.getService(DependencyResolver.class);
        DependencyResolverResult dependencies = resolver.resolve(DependencyResolverRequest.builder()
                .session(session)
                .project(project)
                .requestType(DependencyResolverRequest.RequestType.RESOLVE)
                .pathScope(PathScope.MAIN_RUNTIME)
                .pathTypeFilter(EnumSet.of(JavaPathType.CLASSES, JavaPathType.MODULES))
                .build());

        // Skipping `dependencies.getExceptions()` for simplicity, but it should be verified in real applications.

        Map<PathType, List<Path>> dependencies.getDispatchedPaths();
    }
}

A key point is that we need to specify in which paths we are interested: class-path, module-path, processor-path, doclet-path, taglet-path, etc. Above example filter the dependencies for the class-path and module-path. Then, the result is a map with the key (the PathType) telling whether the files should be placed on the class-path or on the module-path.

A problem of the old deprecated method is that it totally ignores this class-path versus module-path issue.

[eitan-rosenberg]

Thank you very much.
I will try this ASAP
Regards and season greetings.

[eitan-rosenberg]

Updates....
Works as advertised. 💯
I noticed annotation @resolution, but no luck so far. Have you tried this?
Here is my code:

package myTestMojos;

import java.nio.file.Path;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;

import org.apache.maven.api.JavaPathType;
import org.apache.maven.api.Node;
import org.apache.maven.api.PathScope;
import org.apache.maven.api.PathType;
import org.apache.maven.api.Project;
import org.apache.maven.api.Session;
import org.apache.maven.api.di.Inject;
import org.apache.maven.api.plugin.MojoException;
import org.apache.maven.api.plugin.annotations.Mojo;
import org.apache.maven.api.plugin.annotations.Resolution;
import org.apache.maven.api.services.DependencyResolver;
import org.apache.maven.api.services.DependencyResolverRequest;
import org.apache.maven.api.services.DependencyResolverResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Mojo(name = "test")
public class MyTestMojo implements org.apache.maven.api.plugin.Mojo {

	private static final Logger logger = LoggerFactory.getLogger(MyTestMojo.class);

	@Resolution()
	Node node;

	@Inject
	private Project project;

	@Inject
	private Session session;

	@Override
	public void execute() throws MojoException {

		{
			logger.info(String.format("node  %s", node));
		}
		logger.info(String.format("%s", ""));
		{

			final DependencyResolver resolver = session.getService(DependencyResolver.class);

			final DependencyResolverResult dependencies = resolver.resolve(DependencyResolverRequest.builder()
					.session(session).project(project).requestType(DependencyResolverRequest.RequestType.RESOLVE)
					.pathScope(PathScope.MAIN_RUNTIME)
					.pathTypeFilter(EnumSet.of(JavaPathType.CLASSES, JavaPathType.MODULES)).build());

			dependencies.getExceptions().forEach(exception -> {
				logger.info(String.format("exception %s", exception));
			});

			final Map<PathType, List<Path>> dispatchedPaths = dependencies.getDispatchedPaths();

			dispatchedPaths.entrySet().forEach(entry -> {

				logger.info(String.format("PathType %s", entry.getKey()));

				entry.getValue().forEach(path -> {
					logger.info(String.format("\t %s", path));
				});

			});

		}

	}
}