View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.util.graph.transformer;
20  
21  import org.eclipse.aether.RepositoryException;
22  import org.eclipse.aether.collection.DependencyGraphTransformationContext;
23  import org.eclipse.aether.collection.DependencyGraphTransformer;
24  import org.eclipse.aether.graph.Dependency;
25  import org.eclipse.aether.graph.DependencyNode;
26  import org.eclipse.aether.util.artifact.DependencyScopes;
27  import org.eclipse.aether.util.artifact.JavaScopes;
28  
29  import static java.util.Objects.requireNonNull;
30  
31  /**
32   * A dependency graph transformer that refines the request context for nodes that belong to the "project" context by
33   * appending the buildpath type to which the node belongs. For instance, a compile-time project dependency will be
34   * assigned the request context "project/compile".
35   *
36   * @see DependencyNode#getRequestContext()
37   *
38   * @deprecated This class belongs to consumer project. Resolver have no notion of scopes other than those defined
39   * in {@link DependencyScopes} class, moreover it has no knowledge about scope transformation
40   * of dependencies to build path scopes.
41   */
42  @Deprecated
43  public final class JavaDependencyContextRefiner implements DependencyGraphTransformer {
44  
45      public DependencyNode transformGraph(DependencyNode node, DependencyGraphTransformationContext context)
46              throws RepositoryException {
47          requireNonNull(node, "node cannot be null");
48          requireNonNull(context, "context cannot be null");
49          String ctx = node.getRequestContext();
50  
51          if ("project".equals(ctx)) {
52              String scope = getBuildpathScope(node);
53              if (scope != null) {
54                  ctx += '/' + scope;
55                  node.setRequestContext(ctx);
56              }
57          }
58  
59          for (DependencyNode child : node.getChildren()) {
60              transformGraph(child, context);
61          }
62  
63          return node;
64      }
65  
66      private String getBuildpathScope(DependencyNode node) {
67          Dependency dependency = node.getDependency();
68          if (dependency == null) {
69              return null;
70          }
71  
72          String scope = dependency.getScope();
73  
74          if (JavaScopes.COMPILE.equals(scope) || JavaScopes.SYSTEM.equals(scope) || JavaScopes.PROVIDED.equals(scope)) {
75              return JavaScopes.COMPILE;
76          } else if (JavaScopes.RUNTIME.equals(scope)) {
77              return JavaScopes.RUNTIME;
78          } else if (JavaScopes.TEST.equals(scope)) {
79              return JavaScopes.TEST;
80          }
81  
82          return null;
83      }
84  }