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