View Javadoc
1   package org.apache.maven.repository.internal;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Properties;
23  
24  import org.eclipse.aether.DefaultRepositorySystemSession;
25  import org.eclipse.aether.artifact.DefaultArtifactType;
26  import org.eclipse.aether.collection.DependencyGraphTransformer;
27  import org.eclipse.aether.collection.DependencyManager;
28  import org.eclipse.aether.collection.DependencySelector;
29  import org.eclipse.aether.collection.DependencyTraverser;
30  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
31  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
32  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
33  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
34  import org.eclipse.aether.util.graph.selector.OptionalDependencySelector;
35  import org.eclipse.aether.util.graph.selector.ScopeDependencySelector;
36  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
37  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
38  import org.eclipse.aether.util.graph.transformer.JavaDependencyContextRefiner;
39  import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver;
40  import org.eclipse.aether.util.graph.transformer.JavaScopeSelector;
41  import org.eclipse.aether.util.graph.transformer.NearestVersionSelector;
42  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
43  import org.eclipse.aether.util.graph.traverser.FatArtifactTraverser;
44  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
45  
46  /**
47   * A utility class to assist in setting up a Maven-like repository system. <em>Note:</em> This component is meant to
48   * assist those clients that employ the repository system outside of an IoC container, Maven plugins should instead
49   * always use regular dependency injection to acquire the repository system.
50   *
51   * @author Benjamin Bentmann
52   */
53  public final class MavenRepositorySystemUtils
54  {
55  
56      private MavenRepositorySystemUtils()
57      {
58          // hide constructor
59      }
60  
61      /**
62       * Creates a new Maven-like repository system session by initializing the session with values typical for
63       * Maven-based resolution. In more detail, this method configures settings relevant for the processing of dependency
64       * graphs, most other settings remain at their generic default value. Use the various setters to further configure
65       * the session with authentication, mirror, proxy and other information required for your environment.
66       *
67       * @return The new repository system session, never {@code null}.
68       */
69      public static DefaultRepositorySystemSession newSession()
70      {
71          DefaultRepositorySystemSession session = new DefaultRepositorySystemSession();
72  
73          DependencyTraverser depTraverser = new FatArtifactTraverser();
74          session.setDependencyTraverser( depTraverser );
75  
76          DependencyManager depManager = new ClassicDependencyManager();
77          session.setDependencyManager( depManager );
78  
79          DependencySelector depFilter =
80              new AndDependencySelector( new ScopeDependencySelector( "test", "provided" ),
81                                         new OptionalDependencySelector(), new ExclusionDependencySelector() );
82          session.setDependencySelector( depFilter );
83  
84          DependencyGraphTransformer transformer =
85              new ConflictResolver( new NearestVersionSelector(), new JavaScopeSelector(),
86                                    new SimpleOptionalitySelector(), new JavaScopeDeriver() );
87          transformer = new ChainedDependencyGraphTransformer( transformer, new JavaDependencyContextRefiner() );
88          session.setDependencyGraphTransformer( transformer );
89  
90          DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
91          stereotypes.add( new DefaultArtifactType( "pom" ) );
92          stereotypes.add( new DefaultArtifactType( "maven-plugin", "jar", "", "java" ) );
93          stereotypes.add( new DefaultArtifactType( "jar", "jar", "", "java" ) );
94          stereotypes.add( new DefaultArtifactType( "ejb", "jar", "", "java" ) );
95          stereotypes.add( new DefaultArtifactType( "ejb-client", "jar", "client", "java" ) );
96          stereotypes.add( new DefaultArtifactType( "test-jar", "jar", "tests", "java" ) );
97          stereotypes.add( new DefaultArtifactType( "javadoc", "jar", "javadoc", "java" ) );
98          stereotypes.add( new DefaultArtifactType( "java-source", "jar", "sources", "java", false, false ) );
99          stereotypes.add( new DefaultArtifactType( "war", "war", "", "java", false, true ) );
100         stereotypes.add( new DefaultArtifactType( "ear", "ear", "", "java", false, true ) );
101         stereotypes.add( new DefaultArtifactType( "rar", "rar", "", "java", false, true ) );
102         stereotypes.add( new DefaultArtifactType( "par", "par", "", "java", false, true ) );
103         session.setArtifactTypeRegistry( stereotypes );
104 
105         session.setArtifactDescriptorPolicy( new SimpleArtifactDescriptorPolicy( true, true ) );
106 
107         final Properties systemProperties = new Properties();
108 
109         // MNG-5670 guard against ConcurrentModificationException
110         // MNG-6053 guard against key without value
111         Properties sysProp = System.getProperties();
112         synchronized ( sysProp )
113         {
114             systemProperties.putAll( sysProp );
115         }
116 
117         session.setSystemProperties( systemProperties );
118         session.setConfigProperties( systemProperties );
119 
120         return session;
121     }
122 
123 }