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.supplier;
20  
21  import java.util.Arrays;
22  import java.util.Locale;
23  import java.util.function.Supplier;
24  
25  import org.apache.maven.api.DependencyScope;
26  import org.apache.maven.repository.internal.artifact.FatArtifactTraverser;
27  import org.apache.maven.utils.Os;
28  import org.eclipse.aether.RepositorySystem;
29  import org.eclipse.aether.RepositorySystemSession;
30  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
31  import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
32  import org.eclipse.aether.artifact.DefaultArtifactType;
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.impl.scope.ScopeManagerConfiguration;
39  import org.eclipse.aether.internal.impl.scope.ManagedDependencyContextRefiner;
40  import org.eclipse.aether.internal.impl.scope.ManagedScopeDeriver;
41  import org.eclipse.aether.internal.impl.scope.ManagedScopeSelector;
42  import org.eclipse.aether.internal.impl.scope.OptionalDependencySelector;
43  import org.eclipse.aether.internal.impl.scope.ScopeDependencySelector;
44  import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
45  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
46  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
47  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
48  import org.eclipse.aether.util.graph.manager.TransitiveDependencyManager;
49  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
50  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
51  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
52  import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
53  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
54  import org.eclipse.aether.util.graph.transformer.JavaDependencyContextRefiner;
55  import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver;
56  import org.eclipse.aether.util.graph.transformer.JavaScopeSelector;
57  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
58  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
59  
60  import static java.util.Objects.requireNonNull;
61  
62  /**
63   * A simple {@link Supplier} of {@link SessionBuilder} instances, that on each call supplies newly
64   * constructed instance. To create session out of builder, use {@link SessionBuilder#build()}. For proper closing
65   * of sessions, use {@link CloseableSession#close()} method on built instance(s).
66   * <p>
67   * Extend this class and override methods to customize, if needed.
68   *
69   * @since 2.0.0
70   */
71  public class SessionBuilderSupplier {
72      protected final RepositorySystem repositorySystem;
73      protected final InternalScopeManager scopeManager;
74  
75      /**
76       * Creates Resolver 2 session using Maven 4 elements without {@link InternalScopeManager}.
77       */
78      public SessionBuilderSupplier(RepositorySystem repositorySystem) {
79          this(repositorySystem, null);
80      }
81  
82      /**
83       * Creates Resolver 2 session using Maven 4 elements with or without {@link InternalScopeManager}.
84       */
85      public SessionBuilderSupplier(
86              RepositorySystem repositorySystem, ScopeManagerConfiguration scopeManagerConfiguration) {
87          this.repositorySystem = requireNonNull(repositorySystem);
88          this.scopeManager = scopeManagerConfiguration == null ? null : new ScopeManagerImpl(scopeManagerConfiguration);
89      }
90  
91      public void configureSessionBuilder(RepositorySystemSession.SessionBuilder session) {
92          session.setSystemProperties(System.getProperties());
93          boolean caseSensitive = !Os.IS_WINDOWS;
94          System.getenv().forEach((key, value) -> {
95              key = "env." + (caseSensitive ? key : key.toUpperCase(Locale.ENGLISH));
96              session.setSystemProperty(key, value);
97          });
98          if (getScopeManager() != null) {
99              session.setScopeManager(getScopeManager());
100         }
101         session.setDependencyTraverser(getDependencyTraverser());
102         session.setDependencyManager(getDependencyManager());
103         session.setDependencySelector(getDependencySelector());
104         session.setDependencyGraphTransformer(getDependencyGraphTransformer());
105         session.setArtifactTypeRegistry(getArtifactTypeRegistry());
106         session.setArtifactDescriptorPolicy(getArtifactDescriptorPolicy());
107     }
108 
109     public InternalScopeManager getScopeManager() {
110         return this.scopeManager;
111     }
112 
113     public DependencyTraverser getDependencyTraverser() {
114         return new FatArtifactTraverser();
115     }
116 
117     public DependencyManager getDependencyManager() {
118         return this.getDependencyManager(true);
119     }
120 
121     public DependencyManager getDependencyManager(boolean transitive) {
122         if (getScopeManager() == null) {
123             return transitive ? new TransitiveDependencyManager() : new ClassicDependencyManager();
124         } else {
125             return transitive
126                     ? new TransitiveDependencyManager(getScopeManager())
127                     : new ClassicDependencyManager(getScopeManager());
128         }
129     }
130 
131     public DependencySelector getDependencySelector() {
132         if (getScopeManager() == null) {
133             return new AndDependencySelector(
134                     ScopeDependencySelector.legacy(
135                             null, Arrays.asList(DependencyScope.TEST.id(), DependencyScope.PROVIDED.id())),
136                     OptionalDependencySelector.fromDirect(),
137                     new ExclusionDependencySelector());
138         } else {
139             return new AndDependencySelector(
140                     ScopeDependencySelector.legacy(
141                             null, Arrays.asList(DependencyScope.TEST.id(), DependencyScope.PROVIDED.id())),
142                     OptionalDependencySelector.fromDirect(),
143                     new ExclusionDependencySelector());
144         }
145     }
146 
147     public DependencyGraphTransformer getDependencyGraphTransformer() {
148         if (getScopeManager() == null) {
149             return new ChainedDependencyGraphTransformer(
150                     new ConflictResolver(
151                             new ConfigurableVersionSelector(),
152                             new JavaScopeSelector(),
153                             new SimpleOptionalitySelector(),
154                             new JavaScopeDeriver()),
155                     new JavaDependencyContextRefiner());
156         } else {
157             return new ChainedDependencyGraphTransformer(
158                     new ConflictResolver(
159                             new ConfigurableVersionSelector(),
160                             new ManagedScopeSelector(getScopeManager()),
161                             new SimpleOptionalitySelector(),
162                             new ManagedScopeDeriver(getScopeManager())),
163                     new ManagedDependencyContextRefiner(getScopeManager()));
164         }
165     }
166 
167     public DefaultArtifactTypeRegistry getArtifactTypeRegistry() {
168         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
169         stereotypes.add(new DefaultArtifactType("pom"));
170         stereotypes.add(new DefaultArtifactType("maven-plugin", "jar", "", "java"));
171         stereotypes.add(new DefaultArtifactType("jar", "jar", "", "java"));
172         stereotypes.add(new DefaultArtifactType("ejb", "jar", "", "java"));
173         stereotypes.add(new DefaultArtifactType("ejb-client", "jar", "client", "java"));
174         stereotypes.add(new DefaultArtifactType("test-jar", "jar", "tests", "java"));
175         stereotypes.add(new DefaultArtifactType("javadoc", "jar", "javadoc", "java"));
176         stereotypes.add(new DefaultArtifactType("java-source", "jar", "sources", "java", false, false));
177         stereotypes.add(new DefaultArtifactType("fatjar", "jar", "", "java", true, true));
178         stereotypes.add(new DefaultArtifactType("war", "war", "", "java", false, true));
179         stereotypes.add(new DefaultArtifactType("ear", "ear", "", "java", false, true));
180         stereotypes.add(new DefaultArtifactType("rar", "rar", "", "java", false, true));
181         stereotypes.add(new DefaultArtifactType("par", "par", "", "java", false, true));
182         return stereotypes;
183     }
184 
185     public ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
186         return new SimpleArtifactDescriptorPolicy(true, true);
187     }
188 
189     /**
190      * Creates a new Maven-like repository system session by initializing the session with values typical for
191      * Maven-based resolution. In more detail, this method configures settings relevant for the processing of dependency
192      * graphs, most other settings remain at their generic default value. Use the various setters to further configure
193      * the session with authentication, mirror, proxy and other information required for your environment. At least,
194      * local repository manager needs to be configured to make session be able to create session instance.
195      *
196      * @return SessionBuilder configured with minimally required things for "Maven-based resolution". At least LRM must
197      * be set on builder to make it able to create session instances.
198      */
199     public RepositorySystemSession.SessionBuilder get() {
200         RepositorySystemSession.SessionBuilder builder = repositorySystem.createSessionBuilder();
201         configureSessionBuilder(builder);
202         return builder;
203     }
204 }