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.internal.impl.collect;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.Map;
26  
27  import org.eclipse.aether.ConfigurationProperties;
28  import org.eclipse.aether.RepositorySystemSession;
29  import org.eclipse.aether.collection.CollectRequest;
30  import org.eclipse.aether.collection.CollectResult;
31  import org.eclipse.aether.collection.DependencyCollectionException;
32  import org.eclipse.aether.impl.DependencyCollector;
33  import org.eclipse.aether.util.ConfigUtils;
34  
35  import static java.util.Objects.requireNonNull;
36  
37  /**
38   * Default implementation of {@link DependencyCollector} that merely indirect to selected delegate.
39   */
40  @Singleton
41  @Named
42  public class DefaultDependencyCollector implements DependencyCollector {
43  
44      public static final String CONFIG_PROPS_PREFIX = ConfigurationProperties.PREFIX_AETHER + "dependencyCollector.";
45  
46      /**
47       * The name of the dependency collector implementation to use: depth-first (original) named "df", and
48       * breadth-first (new in 1.8.0) named "bf". Both collectors produce equivalent results, but they may differ
49       * performance wise, depending on project being applied to. Our experience shows that existing "df" is well
50       * suited for smaller to medium size projects, while "bf" may perform better on huge projects with many
51       * dependencies. Experiment (and come back to us!) to figure out which one suits you the better.
52       *
53       * @since 1.8.0
54       * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
55       * @configurationType {@link java.lang.String}
56       * @configurationDefaultValue {@link #DEFAULT_COLLECTOR_IMPL}
57       */
58      public static final String CONFIG_PROP_COLLECTOR_IMPL = CONFIG_PROPS_PREFIX + "impl";
59  
60      public static final String DEFAULT_COLLECTOR_IMPL =
61              org.eclipse.aether.internal.impl.collect.bf.BfDependencyCollector.NAME;
62  
63      private final Map<String, DependencyCollectorDelegate> delegates;
64  
65      @Inject
66      public DefaultDependencyCollector(Map<String, DependencyCollectorDelegate> delegates) {
67          this.delegates = requireNonNull(delegates);
68      }
69  
70      @Override
71      public CollectResult collectDependencies(RepositorySystemSession session, CollectRequest request)
72              throws DependencyCollectionException {
73          String delegateName = ConfigUtils.getString(session, DEFAULT_COLLECTOR_IMPL, CONFIG_PROP_COLLECTOR_IMPL);
74          DependencyCollectorDelegate delegate = delegates.get(delegateName);
75          if (delegate == null) {
76              throw new IllegalArgumentException(
77                      "Unknown collector impl: '" + delegateName + "', known implementations are " + delegates.keySet());
78          }
79          return delegate.collectDependencies(session, request);
80      }
81  }