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;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.ArrayList;
26  import java.util.Collection;
27  import java.util.List;
28  import java.util.Set;
29  
30  import org.eclipse.aether.RepositorySystemSession;
31  import org.eclipse.aether.repository.RemoteRepository;
32  import org.eclipse.aether.spi.connector.layout.RepositoryLayout;
33  import org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory;
34  import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider;
35  import org.eclipse.aether.spi.locator.Service;
36  import org.eclipse.aether.spi.locator.ServiceLocator;
37  import org.eclipse.aether.transfer.NoRepositoryLayoutException;
38  import org.slf4j.Logger;
39  import org.slf4j.LoggerFactory;
40  
41  import static java.util.Objects.requireNonNull;
42  
43  /**
44   */
45  @Singleton
46  @Named
47  public final class DefaultRepositoryLayoutProvider implements RepositoryLayoutProvider, Service {
48  
49      private static final Logger LOGGER = LoggerFactory.getLogger(DefaultRepositoryLayoutProvider.class);
50  
51      private Collection<RepositoryLayoutFactory> factories = new ArrayList<>();
52  
53      @Deprecated
54      public DefaultRepositoryLayoutProvider() {
55          // enables default constructor
56      }
57  
58      @Inject
59      public DefaultRepositoryLayoutProvider(Set<RepositoryLayoutFactory> layoutFactories) {
60          setRepositoryLayoutFactories(layoutFactories);
61      }
62  
63      public void initService(ServiceLocator locator) {
64          setRepositoryLayoutFactories(locator.getServices(RepositoryLayoutFactory.class));
65      }
66  
67      public DefaultRepositoryLayoutProvider addRepositoryLayoutFactory(RepositoryLayoutFactory factory) {
68          factories.add(requireNonNull(factory, "layout factory cannot be null"));
69          return this;
70      }
71  
72      public DefaultRepositoryLayoutProvider setRepositoryLayoutFactories(Collection<RepositoryLayoutFactory> factories) {
73          if (factories == null) {
74              this.factories = new ArrayList<>();
75          } else {
76              this.factories = factories;
77          }
78          return this;
79      }
80  
81      public RepositoryLayout newRepositoryLayout(RepositorySystemSession session, RemoteRepository repository)
82              throws NoRepositoryLayoutException {
83          requireNonNull(session, "session cannot be null");
84          requireNonNull(repository, "remote repository cannot be null");
85  
86          PrioritizedComponents<RepositoryLayoutFactory> factories = new PrioritizedComponents<>(session);
87          for (RepositoryLayoutFactory factory : this.factories) {
88              factories.add(factory, factory.getPriority());
89          }
90  
91          List<NoRepositoryLayoutException> errors = new ArrayList<>();
92          for (PrioritizedComponent<RepositoryLayoutFactory> factory : factories.getEnabled()) {
93              try {
94                  return factory.getComponent().newInstance(session, repository);
95              } catch (NoRepositoryLayoutException e) {
96                  // continue and try next factory
97                  errors.add(e);
98              }
99          }
100         if (LOGGER.isDebugEnabled() && errors.size() > 1) {
101             for (Exception e : errors) {
102                 LOGGER.debug("Could not obtain layout factory for {}", repository, e);
103             }
104         }
105 
106         StringBuilder buffer = new StringBuilder(256);
107         if (factories.isEmpty()) {
108             buffer.append("No layout factories registered");
109         } else {
110             buffer.append("Cannot access ").append(repository.getUrl());
111             buffer.append(" with type ").append(repository.getContentType());
112             buffer.append(" using the available layout factories: ");
113             factories.list(buffer);
114         }
115 
116         throw new NoRepositoryLayoutException(repository, buffer.toString(), errors.size() == 1 ? errors.get(0) : null);
117     }
118 }