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.connector.basic;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023
024import java.util.Collections;
025import java.util.Map;
026
027import org.eclipse.aether.RepositorySystemSession;
028import org.eclipse.aether.repository.RemoteRepository;
029import org.eclipse.aether.spi.checksums.ProvidedChecksumsSource;
030import org.eclipse.aether.spi.connector.RepositoryConnector;
031import org.eclipse.aether.spi.connector.RepositoryConnectorFactory;
032import org.eclipse.aether.spi.connector.checksum.ChecksumPolicyProvider;
033import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider;
034import org.eclipse.aether.spi.connector.transport.TransporterProvider;
035import org.eclipse.aether.spi.io.FileProcessor;
036import org.eclipse.aether.spi.locator.Service;
037import org.eclipse.aether.spi.locator.ServiceLocator;
038import org.eclipse.aether.transfer.NoRepositoryConnectorException;
039
040import static java.util.Objects.requireNonNull;
041
042/**
043 * A repository connector factory that employs pluggable
044 * {@link org.eclipse.aether.spi.connector.transport.TransporterFactory transporters} and
045 * {@link org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory repository layouts} for the transfers.
046 */
047@Named("basic")
048public final class BasicRepositoryConnectorFactory implements RepositoryConnectorFactory, Service {
049    private TransporterProvider transporterProvider;
050
051    private RepositoryLayoutProvider layoutProvider;
052
053    private ChecksumPolicyProvider checksumPolicyProvider;
054
055    private FileProcessor fileProcessor;
056
057    private Map<String, ProvidedChecksumsSource> providedChecksumsSources;
058
059    private float priority;
060
061    /**
062     * Creates an (uninitialized) instance of this connector factory. <em>Note:</em> In case of manual instantiation by
063     * clients, the new factory needs to be configured via its various mutators before first use or runtime errors will
064     * occur.
065     */
066    @Deprecated
067    public BasicRepositoryConnectorFactory() {
068        // enables default constructor
069    }
070
071    @Inject
072    public BasicRepositoryConnectorFactory(
073            TransporterProvider transporterProvider,
074            RepositoryLayoutProvider layoutProvider,
075            ChecksumPolicyProvider checksumPolicyProvider,
076            FileProcessor fileProcessor,
077            Map<String, ProvidedChecksumsSource> providedChecksumsSources) {
078        setTransporterProvider(transporterProvider);
079        setRepositoryLayoutProvider(layoutProvider);
080        setChecksumPolicyProvider(checksumPolicyProvider);
081        setFileProcessor(fileProcessor);
082        setProvidedChecksumSources(providedChecksumsSources);
083    }
084
085    public void initService(ServiceLocator locator) {
086        setTransporterProvider(locator.getService(TransporterProvider.class));
087        setRepositoryLayoutProvider(locator.getService(RepositoryLayoutProvider.class));
088        setChecksumPolicyProvider(locator.getService(ChecksumPolicyProvider.class));
089        setFileProcessor(locator.getService(FileProcessor.class));
090        setProvidedChecksumSources(Collections.emptyMap());
091    }
092
093    /**
094     * Sets the transporter provider to use for this component.
095     *
096     * @param transporterProvider The transporter provider to use, must not be {@code null}.
097     * @return This component for chaining, never {@code null}.
098     */
099    public BasicRepositoryConnectorFactory setTransporterProvider(TransporterProvider transporterProvider) {
100        this.transporterProvider = requireNonNull(transporterProvider, "transporter provider cannot be null");
101        return this;
102    }
103
104    /**
105     * Sets the repository layout provider to use for this component.
106     *
107     * @param layoutProvider The repository layout provider to use, must not be {@code null}.
108     * @return This component for chaining, never {@code null}.
109     */
110    public BasicRepositoryConnectorFactory setRepositoryLayoutProvider(RepositoryLayoutProvider layoutProvider) {
111        this.layoutProvider = requireNonNull(layoutProvider, "repository layout provider cannot be null");
112        return this;
113    }
114
115    /**
116     * Sets the checksum policy provider to use for this component.
117     *
118     * @param checksumPolicyProvider The checksum policy provider to use, must not be {@code null}.
119     * @return This component for chaining, never {@code null}.
120     */
121    public BasicRepositoryConnectorFactory setChecksumPolicyProvider(ChecksumPolicyProvider checksumPolicyProvider) {
122        this.checksumPolicyProvider = requireNonNull(checksumPolicyProvider, "checksum policy provider cannot be null");
123        return this;
124    }
125
126    /**
127     * Sets the file processor to use for this component.
128     *
129     * @param fileProcessor The file processor to use, must not be {@code null}.
130     * @return This component for chaining, never {@code null}.
131     */
132    public BasicRepositoryConnectorFactory setFileProcessor(FileProcessor fileProcessor) {
133        this.fileProcessor = requireNonNull(fileProcessor, "file processor cannot be null");
134        return this;
135    }
136
137    /**
138     * Sets the provided checksum sources to use for this component.
139     *
140     * @param providedChecksumsSources The provided checksum sources to use, must not be {@code null}.
141     * @return This component for chaining, never {@code null}.
142     * @since 1.8.0
143     */
144    public BasicRepositoryConnectorFactory setProvidedChecksumSources(
145            Map<String, ProvidedChecksumsSource> providedChecksumsSources) {
146        this.providedChecksumsSources =
147                requireNonNull(providedChecksumsSources, "provided checksum sources cannot be null");
148        return this;
149    }
150
151    public float getPriority() {
152        return priority;
153    }
154
155    /**
156     * Sets the priority of this component.
157     *
158     * @param priority The priority.
159     * @return This component for chaining, never {@code null}.
160     */
161    public BasicRepositoryConnectorFactory setPriority(float priority) {
162        this.priority = priority;
163        return this;
164    }
165
166    public RepositoryConnector newInstance(RepositorySystemSession session, RemoteRepository repository)
167            throws NoRepositoryConnectorException {
168        requireNonNull(session, "session cannot be null");
169        requireNonNull(repository, "repository cannot be null");
170
171        return new BasicRepositoryConnector(
172                session,
173                repository,
174                transporterProvider,
175                layoutProvider,
176                checksumPolicyProvider,
177                fileProcessor,
178                providedChecksumsSources);
179    }
180}