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.utils.Os;
26  import org.eclipse.aether.RepositorySystem;
27  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
28  import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
29  import org.eclipse.aether.artifact.ArtifactTypeRegistry;
30  import org.eclipse.aether.artifact.DefaultArtifactType;
31  import org.eclipse.aether.collection.DependencyGraphTransformer;
32  import org.eclipse.aether.collection.DependencyManager;
33  import org.eclipse.aether.collection.DependencySelector;
34  import org.eclipse.aether.collection.DependencyTraverser;
35  import org.eclipse.aether.internal.impl.scope.ManagedDependencyContextRefiner;
36  import org.eclipse.aether.internal.impl.scope.ManagedScopeDeriver;
37  import org.eclipse.aether.internal.impl.scope.ManagedScopeSelector;
38  import org.eclipse.aether.internal.impl.scope.OptionalDependencySelector;
39  import org.eclipse.aether.internal.impl.scope.ScopeDependencySelector;
40  import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
41  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
42  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
43  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
44  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
45  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
46  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
47  import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
48  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
49  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
50  import org.eclipse.aether.util.graph.traverser.FatArtifactTraverser;
51  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
52  
53  import static java.util.Objects.requireNonNull;
54  
55  /**
56   * A simple {@link Supplier} of {@link SessionBuilder} instances, that on each call supplies newly
57   * constructed instance. To create session out of builder, use {@link SessionBuilder#build()}. For proper closing
58   * of sessions, use {@link CloseableSession#close()} method on built instance(s).
59   * <p>
60   * Extend this class and override methods to customize, if needed.
61   * <p>
62   * Resolver created as this is NOT using {@link org.eclipse.aether.scope.ScopeManager}!
63   *
64   * @since 2.0.0
65   */
66  public class SessionBuilderSupplier implements Supplier<SessionBuilder> {
67      protected final RepositorySystem repositorySystem;
68      protected final ScopeManagerImpl scopeManager;
69  
70      public SessionBuilderSupplier(RepositorySystem repositorySystem) {
71          this.repositorySystem = requireNonNull(repositorySystem);
72          this.scopeManager = new ScopeManagerImpl(Maven3ScopeManagerConfiguration.INSTANCE);
73      }
74  
75      protected void configureSessionBuilder(SessionBuilder session) {
76          session.setSystemProperties(System.getProperties());
77          boolean caseSensitive = !Os.IS_WINDOWS;
78          System.getenv().forEach((key, value) -> {
79              key = "env." + (caseSensitive ? key : key.toUpperCase(Locale.ENGLISH));
80              session.setSystemProperty(key, value);
81          });
82          session.setScopeManager(scopeManager);
83          session.setDependencyTraverser(getDependencyTraverser());
84          session.setDependencyManager(getDependencyManager());
85          session.setDependencySelector(getDependencySelector());
86          session.setDependencyGraphTransformer(getDependencyGraphTransformer());
87          session.setArtifactTypeRegistry(getArtifactTypeRegistry());
88          session.setArtifactDescriptorPolicy(getArtifactDescriptorPolicy());
89      }
90  
91      protected DependencyTraverser getDependencyTraverser() {
92          return new FatArtifactTraverser();
93      }
94  
95      protected DependencyManager getDependencyManager() {
96          return new ClassicDependencyManager(false, scopeManager);
97      }
98  
99      protected DependencySelector getDependencySelector() {
100         return new AndDependencySelector(
101                 ScopeDependencySelector.legacy(
102                         null,
103                         Arrays.asList(
104                                 Maven3ScopeManagerConfiguration.DS_TEST, Maven3ScopeManagerConfiguration.DS_PROVIDED)),
105                 OptionalDependencySelector.fromDirect(),
106                 new ExclusionDependencySelector());
107     }
108 
109     protected DependencyGraphTransformer getDependencyGraphTransformer() {
110         return new ChainedDependencyGraphTransformer(
111                 new ConflictResolver(
112                         new ConfigurableVersionSelector(),
113                         new ManagedScopeSelector(this.scopeManager),
114                         new SimpleOptionalitySelector(),
115                         new ManagedScopeDeriver(this.scopeManager)),
116                 new ManagedDependencyContextRefiner(this.scopeManager));
117     }
118 
119     protected ArtifactTypeRegistry getArtifactTypeRegistry() {
120         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
121         stereotypes.add(new DefaultArtifactType("pom"));
122         stereotypes.add(new DefaultArtifactType("maven-plugin", "jar", "", "java"));
123         stereotypes.add(new DefaultArtifactType("jar", "jar", "", "java"));
124         stereotypes.add(new DefaultArtifactType("ejb", "jar", "", "java"));
125         stereotypes.add(new DefaultArtifactType("ejb-client", "jar", "client", "java"));
126         stereotypes.add(new DefaultArtifactType("test-jar", "jar", "tests", "java"));
127         stereotypes.add(new DefaultArtifactType("javadoc", "jar", "javadoc", "java"));
128         stereotypes.add(new DefaultArtifactType("java-source", "jar", "sources", "java", false, false));
129         stereotypes.add(new DefaultArtifactType("war", "war", "", "java", false, true));
130         stereotypes.add(new DefaultArtifactType("ear", "ear", "", "java", false, true));
131         stereotypes.add(new DefaultArtifactType("rar", "rar", "", "java", false, true));
132         stereotypes.add(new DefaultArtifactType("par", "par", "", "java", false, true));
133         return stereotypes;
134     }
135 
136     protected ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
137         return new SimpleArtifactDescriptorPolicy(true, true);
138     }
139 
140     /**
141      * Creates a new Maven-like repository system session by initializing the session with values typical for
142      * Maven-based resolution. In more detail, this method configures settings relevant for the processing of dependency
143      * graphs, most other settings remain at their generic default value. Use the various setters to further configure
144      * the session with authentication, mirror, proxy and other information required for your environment. At least,
145      * local repository manager needs to be configured to make session be able to create session instance.
146      *
147      * @return SessionBuilder configured with minimally required things for "Maven-based resolution". At least LRM must
148      * be set on builder to make it able to create session instances.
149      */
150     @Override
151     public SessionBuilder get() {
152         SessionBuilder builder = repositorySystem.createSessionBuilder();
153         configureSessionBuilder(builder);
154         return builder;
155     }
156 }