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.impl.scope.InternalScopeManager;
36  import org.eclipse.aether.internal.impl.scope.ManagedDependencyContextRefiner;
37  import org.eclipse.aether.internal.impl.scope.ManagedScopeDeriver;
38  import org.eclipse.aether.internal.impl.scope.ManagedScopeSelector;
39  import org.eclipse.aether.internal.impl.scope.OptionalDependencySelector;
40  import org.eclipse.aether.internal.impl.scope.ScopeDependencySelector;
41  import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
42  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
43  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
44  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
45  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
46  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
47  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
48  import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
49  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
50  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
51  import org.eclipse.aether.util.graph.traverser.FatArtifactTraverser;
52  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
53  
54  import static java.util.Objects.requireNonNull;
55  
56  /**
57   * A simple {@link Supplier} of {@link SessionBuilder} instances, that on each call supplies newly
58   * constructed instance. To create session out of builder, use {@link SessionBuilder#build()}. For proper closing
59   * of sessions, use {@link CloseableSession#close()} method on built instance(s).
60   * <p>
61   * Extend this class and override methods to customize, if needed.
62   * <p>
63   * Resolver created as this is NOT using {@link org.eclipse.aether.scope.ScopeManager}!
64   *
65   * @since 2.0.0
66   */
67  public class SessionBuilderSupplier implements Supplier<SessionBuilder> {
68      protected final RepositorySystem repositorySystem;
69      protected final InternalScopeManager scopeManager;
70  
71      public SessionBuilderSupplier(RepositorySystem repositorySystem) {
72          this.repositorySystem = requireNonNull(repositorySystem);
73          this.scopeManager = new ScopeManagerImpl(Maven3ScopeManagerConfiguration.INSTANCE);
74      }
75  
76      protected void configureSessionBuilder(SessionBuilder session) {
77          session.setSystemProperties(System.getProperties());
78          boolean caseSensitive = !Os.IS_WINDOWS;
79          System.getenv().forEach((key, value) -> {
80              key = "env." + (caseSensitive ? key : key.toUpperCase(Locale.ENGLISH));
81              session.setSystemProperty(key, value);
82          });
83          session.setScopeManager(scopeManager);
84          session.setDependencyTraverser(getDependencyTraverser());
85          session.setDependencyManager(getDependencyManager());
86          session.setDependencySelector(getDependencySelector());
87          session.setDependencyGraphTransformer(getDependencyGraphTransformer());
88          session.setArtifactTypeRegistry(getArtifactTypeRegistry());
89          session.setArtifactDescriptorPolicy(getArtifactDescriptorPolicy());
90      }
91  
92      protected InternalScopeManager getScopeManager() {
93          return this.scopeManager;
94      }
95  
96      protected DependencyTraverser getDependencyTraverser() {
97          return new FatArtifactTraverser();
98      }
99  
100     protected DependencyManager getDependencyManager() {
101         return new ClassicDependencyManager(getScopeManager());
102     }
103 
104     protected DependencySelector getDependencySelector() {
105         return new AndDependencySelector(
106                 ScopeDependencySelector.legacy(
107                         null,
108                         Arrays.asList(
109                                 Maven3ScopeManagerConfiguration.DS_TEST, Maven3ScopeManagerConfiguration.DS_PROVIDED)),
110                 OptionalDependencySelector.fromDirect(),
111                 new ExclusionDependencySelector());
112     }
113 
114     protected DependencyGraphTransformer getDependencyGraphTransformer() {
115         return new ChainedDependencyGraphTransformer(
116                 new ConflictResolver(
117                         new ConfigurableVersionSelector(),
118                         new ManagedScopeSelector(getScopeManager()),
119                         new SimpleOptionalitySelector(),
120                         new ManagedScopeDeriver(getScopeManager())),
121                 new ManagedDependencyContextRefiner(getScopeManager()));
122     }
123 
124     protected ArtifactTypeRegistry getArtifactTypeRegistry() {
125         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
126         stereotypes.add(new DefaultArtifactType("pom"));
127         stereotypes.add(new DefaultArtifactType("maven-plugin", "jar", "", "java"));
128         stereotypes.add(new DefaultArtifactType("jar", "jar", "", "java"));
129         stereotypes.add(new DefaultArtifactType("ejb", "jar", "", "java"));
130         stereotypes.add(new DefaultArtifactType("ejb-client", "jar", "client", "java"));
131         stereotypes.add(new DefaultArtifactType("test-jar", "jar", "tests", "java"));
132         stereotypes.add(new DefaultArtifactType("javadoc", "jar", "javadoc", "java"));
133         stereotypes.add(new DefaultArtifactType("java-source", "jar", "sources", "java", false, false));
134         stereotypes.add(new DefaultArtifactType("war", "war", "", "java", false, true));
135         stereotypes.add(new DefaultArtifactType("ear", "ear", "", "java", false, true));
136         stereotypes.add(new DefaultArtifactType("rar", "rar", "", "java", false, true));
137         stereotypes.add(new DefaultArtifactType("par", "par", "", "java", false, true));
138         return stereotypes;
139     }
140 
141     protected ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
142         return new SimpleArtifactDescriptorPolicy(true, true);
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         SessionBuilder builder = repositorySystem.createSessionBuilder();
158         configureSessionBuilder(builder);
159         return builder;
160     }
161 }