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.apache.maven.impl.resolver;
20  
21  import java.util.Arrays;
22  import java.util.function.Supplier;
23  
24  import org.apache.maven.api.DependencyScope;
25  import org.apache.maven.impl.resolver.artifact.FatArtifactTraverser;
26  import org.apache.maven.impl.resolver.scopes.Maven3ScopeManagerConfiguration;
27  import org.apache.maven.impl.resolver.scopes.Maven4ScopeManagerConfiguration;
28  import org.apache.maven.impl.resolver.type.DefaultTypeProvider;
29  import org.eclipse.aether.RepositorySystem;
30  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
31  import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
32  import org.eclipse.aether.artifact.ArtifactTypeRegistry;
33  import org.eclipse.aether.collection.DependencyGraphTransformer;
34  import org.eclipse.aether.collection.DependencyManager;
35  import org.eclipse.aether.collection.DependencySelector;
36  import org.eclipse.aether.collection.DependencyTraverser;
37  import org.eclipse.aether.impl.scope.InternalScopeManager;
38  import org.eclipse.aether.internal.impl.scope.ManagedDependencyContextRefiner;
39  import org.eclipse.aether.internal.impl.scope.ManagedScopeDeriver;
40  import org.eclipse.aether.internal.impl.scope.ManagedScopeSelector;
41  import org.eclipse.aether.internal.impl.scope.OptionalDependencySelector;
42  import org.eclipse.aether.internal.impl.scope.ScopeDependencySelector;
43  import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
44  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
45  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
46  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
47  import org.eclipse.aether.util.graph.manager.TransitiveDependencyManager;
48  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
49  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
50  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
51  import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
52  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
53  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
54  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
55  
56  import static java.util.Objects.requireNonNull;
57  
58  /**
59   * A simple {@link Supplier} of {@link SessionBuilder} instances, that on each call supplies newly
60   * constructed instance. To create session out of builder, use {@link SessionBuilder#build()}. For proper closing
61   * of sessions, use {@link CloseableSession#close()} method on built instance(s).
62   * <p>
63   * Extend this class and override methods to customize, if needed.
64   *
65   * @since 4.0.0
66   */
67  public class MavenSessionBuilderSupplier implements Supplier<SessionBuilder> {
68      protected final RepositorySystem repositorySystem;
69      protected final boolean mavenMaven3Personality;
70      protected final InternalScopeManager scopeManager;
71  
72      public MavenSessionBuilderSupplier(RepositorySystem repositorySystem, boolean mavenMaven3Personality) {
73          this.repositorySystem = requireNonNull(repositorySystem);
74          this.mavenMaven3Personality = mavenMaven3Personality;
75          this.scopeManager = new ScopeManagerImpl(
76                  mavenMaven3Personality
77                          ? Maven3ScopeManagerConfiguration.INSTANCE
78                          : Maven4ScopeManagerConfiguration.INSTANCE);
79      }
80  
81      protected DependencyTraverser getDependencyTraverser() {
82          return new FatArtifactTraverser();
83      }
84  
85      protected InternalScopeManager getScopeManager() {
86          return scopeManager;
87      }
88  
89      protected DependencyManager getDependencyManager() {
90          return getDependencyManager(!mavenMaven3Personality);
91      }
92  
93      public DependencyManager getDependencyManager(boolean transitive) {
94          if (transitive) {
95              return new TransitiveDependencyManager(getScopeManager());
96          }
97          return new ClassicDependencyManager(getScopeManager());
98      }
99  
100     protected DependencySelector getDependencySelector() {
101         return new AndDependencySelector(
102                 ScopeDependencySelector.legacy(
103                         null, Arrays.asList(DependencyScope.TEST.id(), DependencyScope.PROVIDED.id())),
104                 OptionalDependencySelector.fromDirect(),
105                 new ExclusionDependencySelector());
106     }
107 
108     protected DependencyGraphTransformer getDependencyGraphTransformer() {
109         return new ChainedDependencyGraphTransformer(
110                 new ConflictResolver(
111                         new ConfigurableVersionSelector(), new ManagedScopeSelector(getScopeManager()),
112                         new SimpleOptionalitySelector(), new ManagedScopeDeriver(getScopeManager())),
113                 new ManagedDependencyContextRefiner(getScopeManager()));
114     }
115 
116     /**
117      * This method produces "surrogate" type registry that is static: it aims users that want to use
118      * Maven-Resolver without involving Maven Core and related things.
119      * <p>
120      * This type registry is NOT used by Maven Core: Maven replaces it during Session creation with a type registry
121      * that supports extending it (i.e. via Maven Extensions).
122      * <p>
123      * Important: this "static" list of types should be in-sync with core provided types.
124      */
125     protected ArtifactTypeRegistry getArtifactTypeRegistry() {
126         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
127         new DefaultTypeProvider().types().forEach(stereotypes::add);
128         return stereotypes;
129     }
130 
131     protected ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
132         return new SimpleArtifactDescriptorPolicy(true, true);
133     }
134 
135     protected void configureSessionBuilder(SessionBuilder session) {
136         session.setDependencyTraverser(getDependencyTraverser());
137         session.setDependencyManager(getDependencyManager());
138         session.setDependencySelector(getDependencySelector());
139         session.setDependencyGraphTransformer(getDependencyGraphTransformer());
140         session.setArtifactTypeRegistry(getArtifactTypeRegistry());
141         session.setArtifactDescriptorPolicy(getArtifactDescriptorPolicy());
142         session.setScopeManager(getScopeManager());
143     }
144 
145     /**
146      * Creates a new Maven-like repository system session by initializing the session with values typical for
147      * Maven-based resolution. In more detail, this method configures settings relevant for the processing of dependency
148      * graphs, most other settings remain at their generic default value. Use the various setters to further configure
149      * the session with authentication, mirror, proxy and other information required for your environment. At least,
150      * local repository manager needs to be configured to make session be able to create session instance.
151      *
152      * @return SessionBuilder configured with minimally required things for "Maven-based resolution". At least LRM must
153      * be set on builder to make it able to create session instances.
154      */
155     @Override
156     public SessionBuilder get() {
157         requireNonNull(repositorySystem, "repositorySystem");
158         SessionBuilder builder = repositorySystem.createSessionBuilder();
159         configureSessionBuilder(builder);
160         return builder;
161     }
162 }