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.transport.http;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023
024import java.util.Map;
025
026import org.eclipse.aether.RepositorySystemSession;
027import org.eclipse.aether.repository.RemoteRepository;
028import org.eclipse.aether.spi.connector.transport.Transporter;
029import org.eclipse.aether.spi.connector.transport.TransporterFactory;
030import org.eclipse.aether.transfer.NoTransporterException;
031
032import static java.util.Objects.requireNonNull;
033
034/**
035 * A transporter factory for repositories using the {@code http:} or {@code https:} protocol. The provided transporters
036 * support uploads to WebDAV servers and resumable downloads.
037 */
038@Named(HttpTransporterFactory.NAME)
039public final class HttpTransporterFactory implements TransporterFactory {
040    public static final String NAME = "http";
041
042    private float priority = 5.0f;
043
044    private final Map<String, ChecksumExtractor> extractors;
045
046    /**
047     * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
048     * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
049     * will occur.
050     */
051    @Inject
052    public HttpTransporterFactory(Map<String, ChecksumExtractor> extractors) {
053        this.extractors = requireNonNull(extractors);
054    }
055
056    @Override
057    public float getPriority() {
058        return priority;
059    }
060
061    /**
062     * Sets the priority of this component.
063     *
064     * @param priority The priority.
065     * @return This component for chaining, never {@code null}.
066     */
067    public HttpTransporterFactory setPriority(float priority) {
068        this.priority = priority;
069        return this;
070    }
071
072    @Override
073    public Transporter newInstance(RepositorySystemSession session, RemoteRepository repository)
074            throws NoTransporterException {
075        requireNonNull(session, "session cannot be null");
076        requireNonNull(repository, "repository cannot be null");
077
078        return new HttpTransporter(extractors, repository, session);
079    }
080}