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.Collection;
027import java.util.List;
028import java.util.Set;
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.spi.locator.Service;
036import org.eclipse.aether.spi.locator.ServiceLocator;
037import org.eclipse.aether.transfer.NoRepositoryLayoutException;
038import org.slf4j.Logger;
039import org.slf4j.LoggerFactory;
040
041import static java.util.Objects.requireNonNull;
042
043/**
044 */
045@Singleton
046@Named
047public final class DefaultRepositoryLayoutProvider implements RepositoryLayoutProvider, Service {
048
049    private static final Logger LOGGER = LoggerFactory.getLogger(DefaultRepositoryLayoutProvider.class);
050
051    private Collection<RepositoryLayoutFactory> factories = new ArrayList<>();
052
053    public DefaultRepositoryLayoutProvider() {
054        // enables default constructor
055    }
056
057    @Inject
058    DefaultRepositoryLayoutProvider(Set<RepositoryLayoutFactory> layoutFactories) {
059        setRepositoryLayoutFactories(layoutFactories);
060    }
061
062    public void initService(ServiceLocator locator) {
063        setRepositoryLayoutFactories(locator.getServices(RepositoryLayoutFactory.class));
064    }
065
066    public DefaultRepositoryLayoutProvider addRepositoryLayoutFactory(RepositoryLayoutFactory factory) {
067        factories.add(requireNonNull(factory, "layout factory cannot be null"));
068        return this;
069    }
070
071    public DefaultRepositoryLayoutProvider setRepositoryLayoutFactories(Collection<RepositoryLayoutFactory> factories) {
072        if (factories == null) {
073            this.factories = new ArrayList<>();
074        } else {
075            this.factories = factories;
076        }
077        return this;
078    }
079
080    public RepositoryLayout newRepositoryLayout(RepositorySystemSession session, RemoteRepository repository)
081            throws NoRepositoryLayoutException {
082        requireNonNull(session, "session cannot be null");
083        requireNonNull(repository, "remote repository cannot be null");
084
085        PrioritizedComponents<RepositoryLayoutFactory> factories = new PrioritizedComponents<>(session);
086        for (RepositoryLayoutFactory factory : this.factories) {
087            factories.add(factory, factory.getPriority());
088        }
089
090        List<NoRepositoryLayoutException> errors = new ArrayList<>();
091        for (PrioritizedComponent<RepositoryLayoutFactory> factory : factories.getEnabled()) {
092            try {
093                return factory.getComponent().newInstance(session, repository);
094            } catch (NoRepositoryLayoutException e) {
095                // continue and try next factory
096                errors.add(e);
097            }
098        }
099        if (LOGGER.isDebugEnabled() && errors.size() > 1) {
100            for (Exception e : errors) {
101                LOGGER.debug("Could not obtain layout factory for {}", repository, e);
102            }
103        }
104
105        StringBuilder buffer = new StringBuilder(256);
106        if (factories.isEmpty()) {
107            buffer.append("No layout factories registered");
108        } else {
109            buffer.append("Cannot access ").append(repository.getUrl());
110            buffer.append(" with type ").append(repository.getContentType());
111            buffer.append(" using the available layout factories: ");
112            factories.list(buffer);
113        }
114
115        throw new NoRepositoryLayoutException(repository, buffer.toString(), errors.size() == 1 ? errors.get(0) : null);
116    }
117}