001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.internal.impl;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023import javax.inject.Singleton;
024
025import java.util.ArrayList;
026import java.util.Collections;
027import java.util.List;
028import java.util.Map;
029
030import org.eclipse.aether.RepositorySystemSession;
031import org.eclipse.aether.repository.RemoteRepository;
032import org.eclipse.aether.spi.connector.layout.RepositoryLayout;
033import org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory;
034import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider;
035import org.eclipse.aether.transfer.NoRepositoryLayoutException;
036import org.slf4j.Logger;
037import org.slf4j.LoggerFactory;
038
039import static java.util.Objects.requireNonNull;
040
041/**
042 */
043@Singleton
044@Named
045public final class DefaultRepositoryLayoutProvider implements RepositoryLayoutProvider {
046
047    private static final Logger LOGGER = LoggerFactory.getLogger(DefaultRepositoryLayoutProvider.class);
048
049    private final Map<String, RepositoryLayoutFactory> layoutFactories;
050
051    @Inject
052    public DefaultRepositoryLayoutProvider(Map<String, RepositoryLayoutFactory> layoutFactories) {
053        this.layoutFactories = Collections.unmodifiableMap(layoutFactories);
054    }
055
056    @Override
057    public RepositoryLayout newRepositoryLayout(RepositorySystemSession session, RemoteRepository repository)
058            throws NoRepositoryLayoutException {
059        requireNonNull(session, "session cannot be null");
060        requireNonNull(repository, "remote repository cannot be null");
061
062        PrioritizedComponents<RepositoryLayoutFactory> factories = PrioritizedComponents.reuseOrCreate(
063                session, RepositoryLayoutFactory.class, layoutFactories, RepositoryLayoutFactory::getPriority);
064
065        LOGGER.debug("Selecting RepositoryLayout for {}", repository);
066
067        List<NoRepositoryLayoutException> errors = new ArrayList<>();
068        for (PrioritizedComponent<RepositoryLayoutFactory> factory : factories.getEnabled()) {
069            try {
070                RepositoryLayout repositoryLayout = factory.getComponent().newInstance(session, repository);
071
072                if (LOGGER.isDebugEnabled()) {
073                    StringBuilder buffer = new StringBuilder(256);
074                    buffer.append("Using layout ")
075                            .append(repositoryLayout.getClass().getSimpleName());
076                    Utils.appendClassLoader(buffer, repositoryLayout);
077                    buffer.append(" with priority ").append(factory.getPriority());
078                    buffer.append(" for ").append(repository.getUrl());
079                    LOGGER.debug(buffer.toString());
080                }
081
082                return repositoryLayout;
083            } catch (NoRepositoryLayoutException e) {
084                // continue and try next factory
085                if (LOGGER.isTraceEnabled()) {
086                    LOGGER.trace(
087                            "Layout factory {} did not provide layout for {}",
088                            factory.getComponent().getClass(),
089                            repository,
090                            e);
091                } else {
092                    LOGGER.debug(
093                            "Layout factory {} did not provide layout for {}: {}",
094                            factory.getComponent().getClass(),
095                            repository,
096                            e.getMessage());
097                }
098                errors.add(e);
099            }
100        }
101
102        StringBuilder buffer = new StringBuilder(256);
103        if (factories.isEmpty()) {
104            buffer.append("No layout factories registered");
105        } else {
106            buffer.append("Cannot access ").append(repository.getUrl());
107            buffer.append(" with type ").append(repository.getContentType());
108            buffer.append(" using the available layout factories: ");
109            factories.list(buffer);
110        }
111
112        // create exception: if one error, make it cause
113        NoRepositoryLayoutException ex = new NoRepositoryLayoutException(
114                repository, buffer.toString(), errors.size() == 1 ? errors.get(0) : null);
115        // if more errors, make them all suppressed
116        if (errors.size() > 1) {
117            errors.forEach(ex::addSuppressed);
118        }
119        throw ex;
120    }
121}