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.Objects;
24  import java.util.function.Supplier;
25  
26  import org.apache.maven.api.DependencyScope;
27  import org.apache.maven.repository.internal.artifact.FatArtifactTraverser;
28  import org.apache.maven.repository.internal.scopes.Maven4ScopeManagerConfiguration;
29  import org.apache.maven.repository.internal.type.DefaultTypeProvider;
30  import org.apache.maven.utils.Os;
31  import org.eclipse.aether.RepositorySystem;
32  import org.eclipse.aether.RepositorySystemSession;
33  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
34  import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
35  import org.eclipse.aether.artifact.ArtifactTypeRegistry;
36  import org.eclipse.aether.collection.DependencyGraphTransformer;
37  import org.eclipse.aether.collection.DependencyManager;
38  import org.eclipse.aether.collection.DependencySelector;
39  import org.eclipse.aether.collection.DependencyTraverser;
40  import org.eclipse.aether.impl.scope.InternalScopeManager;
41  import org.eclipse.aether.internal.impl.scope.ManagedDependencyContextRefiner;
42  import org.eclipse.aether.internal.impl.scope.ManagedScopeDeriver;
43  import org.eclipse.aether.internal.impl.scope.ManagedScopeSelector;
44  import org.eclipse.aether.internal.impl.scope.OptionalDependencySelector;
45  import org.eclipse.aether.internal.impl.scope.ScopeDependencySelector;
46  import org.eclipse.aether.internal.impl.scope.ScopeManagerImpl;
47  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
48  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
49  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
50  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
51  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
52  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
53  import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
54  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
55  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
56  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
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 2.0.0
66   */
67  public class SessionBuilderSupplier {
68      protected final RepositorySystem repositorySystem;
69      protected final InternalScopeManager scopeManager;
70  
71      public SessionBuilderSupplier(RepositorySystem repositorySystem) {
72          this.repositorySystem = (RepositorySystem) Objects.requireNonNull(repositorySystem);
73          this.scopeManager = new ScopeManagerImpl(Maven4ScopeManagerConfiguration.INSTANCE);
74      }
75  
76      /** @deprecated */
77      @Deprecated
78      public SessionBuilderSupplier() {
79          this.repositorySystem = null;
80          this.scopeManager = new ScopeManagerImpl(Maven4ScopeManagerConfiguration.INSTANCE);
81      }
82  
83      protected InternalScopeManager getScopeManager() {
84          return this.scopeManager;
85      }
86  
87      protected DependencyTraverser getDependencyTraverser() {
88          return new FatArtifactTraverser();
89      }
90  
91      protected DependencyManager getDependencyManager() {
92          return this.getDependencyManager(true);
93      }
94  
95      public DependencyManager getDependencyManager(boolean transitive) {
96          return new ClassicDependencyManager(transitive, this.getScopeManager());
97      }
98  
99      protected DependencySelector getDependencySelector() {
100         return new AndDependencySelector(new DependencySelector[] {
101             ScopeDependencySelector.legacy(
102                     null, Arrays.asList(DependencyScope.TEST.id(), DependencyScope.PROVIDED.id())),
103             OptionalDependencySelector.fromDirect(),
104             new ExclusionDependencySelector()
105         });
106     }
107 
108     protected DependencyGraphTransformer getDependencyGraphTransformer() {
109         return new ChainedDependencyGraphTransformer(
110                 new ConflictResolver(
111                         new ConfigurableVersionSelector(),
112                         new ManagedScopeSelector(this.getScopeManager()),
113                         new SimpleOptionalitySelector(),
114                         new ManagedScopeDeriver(this.getScopeManager())),
115                 new ManagedDependencyContextRefiner(this.getScopeManager()));
116     }
117 
118     protected ArtifactTypeRegistry getArtifactTypeRegistry() {
119         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
120         new DefaultTypeProvider().types().forEach(stereotypes::add);
121         return stereotypes;
122     }
123 
124     protected ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
125         return new SimpleArtifactDescriptorPolicy(true, true);
126     }
127 
128     protected void configureSessionBuilder(RepositorySystemSession.SessionBuilder session) {
129         session.setDependencyTraverser(this.getDependencyTraverser());
130         session.setDependencyManager(this.getDependencyManager());
131         session.setDependencySelector(this.getDependencySelector());
132         session.setDependencyGraphTransformer(this.getDependencyGraphTransformer());
133         session.setArtifactTypeRegistry(this.getArtifactTypeRegistry());
134         session.setArtifactDescriptorPolicy(this.getArtifactDescriptorPolicy());
135         session.setScopeManager(this.getScopeManager());
136 
137         session.setSystemProperties(System.getProperties());
138         boolean caseSensitive = !Os.IS_WINDOWS;
139         System.getenv().forEach((key, value) -> {
140             key = "env." + (caseSensitive ? key : key.toUpperCase(Locale.ENGLISH));
141             session.setSystemProperty(key, value);
142         });
143     }
144 
145     public RepositorySystemSession.SessionBuilder get() {
146         Objects.requireNonNull(this.repositorySystem, "repositorySystem");
147         RepositorySystemSession.SessionBuilder builder = this.repositorySystem.createSessionBuilder();
148         this.configureSessionBuilder(builder);
149         return builder;
150     }
151 }