[MRESOLVER-512] ScopeManager

maven-resolver-api/src/main/java/org/eclipse/aether/AbstractForwardingRepositorySystemSession.java

@@ -34,6 +34,8 @@
 import org.eclipse.aether.repository.WorkspaceReader;
 import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
 import org.eclipse.aether.resolution.ResolutionErrorPolicy;
+import org.eclipse.aether.scope.ScopeManager;
+import org.eclipse.aether.scope.SystemDependencyScope;
 import org.eclipse.aether.transfer.TransferListener;
 
 /**
@@ -192,8 +194,13 @@ public RepositoryCache getCache() {
     }
 
     @Override
-    public SystemScopeHandler getSystemScopeHandler() {
-        return getSession().getSystemScopeHandler();
+    public ScopeManager getScopeManager() {
+        return getSession().getScopeManager();
+    }
+
+    @Override
+    public SystemDependencyScope getSystemDependencyScope() {
+        return getSession().getSystemDependencyScope();
     }
 
     @Override

maven-resolver-api/src/main/java/org/eclipse/aether/DefaultRepositorySystemSession.java

@@ -42,6 +42,8 @@
 import org.eclipse.aether.repository.WorkspaceReader;
 import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
 import org.eclipse.aether.resolution.ResolutionErrorPolicy;
+import org.eclipse.aether.scope.ScopeManager;
+import org.eclipse.aether.scope.SystemDependencyScope;
 import org.eclipse.aether.transfer.TransferListener;
 
 import static java.util.Objects.requireNonNull;
@@ -124,7 +126,7 @@ public final class DefaultRepositorySystemSession implements RepositorySystemSes
 
     private RepositoryCache cache;
 
-    private SystemScopeHandler systemScopeHandler;
+    private ScopeManager scopeManager;
 
     private final Function<Runnable, Boolean> onSessionEndedRegistrar;
 
@@ -164,7 +166,6 @@ public DefaultRepositorySystemSession(Function<Runnable, Boolean> onSessionEnded
         authenticationSelector = NullAuthenticationSelector.INSTANCE;
         artifactTypeRegistry = NullArtifactTypeRegistry.INSTANCE;
         data = new DefaultSessionData();
-        systemScopeHandler = SystemScopeHandler.LEGACY;
         this.onSessionEndedRegistrar = requireNonNull(onSessionEndedRegistrar, "onSessionEndedRegistrar");
     }
 
@@ -204,7 +205,7 @@ public DefaultRepositorySystemSession(RepositorySystemSession session) {
         setDependencyGraphTransformer(session.getDependencyGraphTransformer());
         setData(session.getData());
         setCache(session.getCache());
-        setSystemScopeHandler(session.getSystemScopeHandler());
+        setScopeManager(session.getScopeManager());
         this.onSessionEndedRegistrar = session::addOnSessionEndedHandler;
     }
 
@@ -806,23 +807,32 @@ public DefaultRepositorySystemSession setCache(RepositoryCache cache) {
     }
 
     @Override
-    public SystemScopeHandler getSystemScopeHandler() {
-        return systemScopeHandler;
+    public ScopeManager getScopeManager() {
+        return scopeManager;
     }
 
     /**
-     * Sets the system scope handler, must not be {@code null}.
+     * Sets the scope manager, may be {@code null}.
      *
-     * @param systemScopeHandler The system scope handler, cannot be {@code null}.
+     * @param scopeManager The scope manager, may be {@code null}.
      * @return The session for chaining, never {@code null}.
      * @since 2.0.0
      */
-    public DefaultRepositorySystemSession setSystemScopeHandler(SystemScopeHandler systemScopeHandler) {
+    public DefaultRepositorySystemSession setScopeManager(ScopeManager scopeManager) {
         verifyStateForMutation();
-        this.systemScopeHandler = requireNonNull(systemScopeHandler);
+        this.scopeManager = scopeManager;
         return this;
     }
 
+    @Override
+    public SystemDependencyScope getSystemDependencyScope() {
+        if (scopeManager != null) {
+            return scopeManager.getSystemScope().orElse(null);
+        } else {
+            return SystemDependencyScope.LEGACY;
+        }
+    }
+
     /**
      * Registers onSessionEnded handler, if able to.
      *

maven-resolver-api/src/main/java/org/eclipse/aether/RepositorySystemSession.java

@@ -40,6 +40,8 @@
 import org.eclipse.aether.repository.WorkspaceReader;
 import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
 import org.eclipse.aether.resolution.ResolutionErrorPolicy;
+import org.eclipse.aether.scope.ScopeManager;
+import org.eclipse.aether.scope.SystemDependencyScope;
 import org.eclipse.aether.transfer.TransferListener;
 
 /**
@@ -390,12 +392,12 @@ interface SessionBuilder {
         SessionBuilder setCache(RepositoryCache cache);
 
         /**
-         * Sets the system scope handler for session, may not be {@code null}.
+         * Sets the scope manager for session, may be {@code null}.
          *
-         * @param systemScopeHandler The system scope handler, may not be {@code null}.
+         * @param scopeManager The scope manager, may be {@code null}.
          * @return The session for chaining, never {@code null}.
          */
-        SessionBuilder setSystemScopeHandler(SystemScopeHandler systemScopeHandler);
+        SessionBuilder setScopeManager(ScopeManager scopeManager);
 
         /**
          * Adds on session ended handler to be immediately registered when this builder creates session.
@@ -752,12 +754,27 @@ interface SessionBuilder {
     RepositoryCache getCache();
 
     /**
-     * Returns the system scope handler, never {@code null}.
+     * Returns the scope manager to be used in this session, may be {@code null} if not set.
      *
-     * @return The system scope handler, never {@code null}.
+     * @return The scope manager or {@code null} if not set.
      * @since 2.0.0
      */
-    SystemScopeHandler getSystemScopeHandler();
+    ScopeManager getScopeManager();
+
+    /**
+     * Returns the system dependency scope.
+     * <p>
+     * Shorthand method for {@link #getScopeManager()#getSystemDependencyScope()}.
+     * <p>
+     * If {@link ScopeManager} is set, {@link #getScopeManager()} returns non-null value, the result of
+     * {@link ScopeManager#getSystemScope()} is returned (that may be {@code null}). If no {@link ScopeManager}
+     * if set, then {@link SystemDependencyScope#LEGACY} instance is returned, as lack of scope manager means that
+     * resolver operates in "legacy" mode (Maven3 compatible mode).
+     *
+     * @return The system dependency scope or {@code null} if no such scope.
+     * @since 2.0.0
+     */
+    SystemDependencyScope getSystemDependencyScope();
 
     /**
      * Registers a handler to execute when this session closed.

maven-resolver-api/src/main/java/org/eclipse/aether/artifact/ArtifactProperties.java

@@ -47,8 +47,8 @@ public final class ArtifactProperties {
      *
      * @deprecated since 2.0, the semantic carried by this property and the fact this property is coupled to Resolver
      * 1.x "system" scope (that was delegated to consumer application) implies this property should not be used anymore,
-     * instead, the {@link org.eclipse.aether.SystemScopeHandler} exposed via method
-     * {@link RepositorySystemSession#getSystemScopeHandler()} should be used.
+     * instead, the {@link org.eclipse.aether.scope.ScopeManager} exposed via method
+     * {@link RepositorySystemSession#getScopeManager()} should be used.
      */
     @Deprecated
     public static final String LOCAL_PATH = "localPath";

maven-resolver-api/src/main/java/org/eclipse/aether/collection/CollectRequest.java

@@ -27,6 +27,7 @@
 import org.eclipse.aether.artifact.Artifact;
 import org.eclipse.aether.graph.Dependency;
 import org.eclipse.aether.repository.RemoteRepository;
+import org.eclipse.aether.scope.ResolutionScope;
 
 /**
  * A request to collect the transitive dependencies and to build a dependency graph from them. There are three ways to
@@ -38,6 +39,7 @@
  * @see RepositorySystem#collectDependencies(org.eclipse.aether.RepositorySystemSession, CollectRequest)
  */
 public final class CollectRequest {
+    private ResolutionScope resolutionScope;
 
     private Artifact rootArtifact;
 
@@ -100,6 +102,27 @@ public CollectRequest(
         setRepositories(repositories);
     }
 
+    /**
+     * Gets the wanted resolution scope. If set, the {@link org.eclipse.aether.scope.ScopeManager} has to be set on
+     * session as well, otherwise it is considered user error: misconfigured collect request.
+     *
+     * @since 2.0.0
+     * @return The wanted resolution scope.
+     */
+    public ResolutionScope getResolutionScope() {
+        return resolutionScope;
+    }
+
+    /**
+     * Sets the wanted resolution scope. Usable only if {@link org.eclipse.aether.scope.ScopeManager} is used.
+     *
+     * @since 2.0.0
+     * @param resolutionScope The wanted resolution scope, may be {@code null} to "drive by yourself".
+     */
+    public void setResolutionScope(ResolutionScope resolutionScope) {
+        this.resolutionScope = resolutionScope;
+    }
+
     /**
      * Gets the root artifact for the dependency graph.
      *

maven-resolver-api/src/main/java/org/eclipse/aether/scope/DependencyScope.java

@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.eclipse.aether.scope;
+
+/**
+ * Generic dependency scope.
+ *
+ * @since 2.0.0
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
+ */
+public interface DependencyScope {
+    /**
+     * The label.
+     */
+    String getId();
+
+    /**
+     * Shorthand method of {@link #getId()#equals(Object)}.
+     */
+    default boolean is(String label) {
+        return getId().equals(label);
+    }
+
+    /**
+     * Is it transitive scope?
+     */
+    boolean isTransitive();
+}

maven-resolver-api/src/main/java/org/eclipse/aether/scope/ResolutionScope.java

@@ -0,0 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.eclipse.aether.scope;
+
+/**
+ * Generic resolution scope.
+ *
+ * @since 2.0.0
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
+ */
+public interface ResolutionScope {
+    /**
+     * The label.
+     */
+    String getId();
+}

maven-resolver-api/src/main/java/org/eclipse/aether/scope/ScopeManager.java

@@ -0,0 +1,70 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.eclipse.aether.scope;
+
+import java.util.Collection;
+import java.util.Optional;
+
+/**
+ * Scope manager.
+ *
+ * @since 2.0.0
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
+ * @noextend This interface is not intended to be extended by clients.
+ */
+public interface ScopeManager {
+    /**
+     * The label.
+     */
+    String getId();
+
+    /**
+     * Returns the "system" scope, if exists.
+     * <p>
+     * This is a special scope. In this scope case, Resolver should handle it specially, as it has no POM (so is
+     * always a leaf on graph), is not in any repository, but is actually hosted on host OS file system. On resolution
+     * resolver merely checks is file present or not.
+     */
+    Optional<SystemDependencyScope> getSystemScope();
+
+    /**
+     * Returns a specific dependency scope by label.
+     * <p>
+     * Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.
+     */
+    Optional<DependencyScope> getDependencyScope(String id);
+
+    /**
+     * Returns the "universe" (all) of dependency scopes.
+     */
+    Collection<DependencyScope> getDependencyScopeUniverse();
+
+    /**
+     * Returns a specific resolution scope by label.
+     * <p>
+     * Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.
+     */
+    Optional<ResolutionScope> getResolutionScope(String id);
+
+    /**
+     * Returns the "universe" (all) of resolution scopes.
+     */
+    Collection<ResolutionScope> getResolutionScopeUniverse();
+}