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.apache;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023
024import org.eclipse.aether.RepositorySystemSession;
025import org.eclipse.aether.repository.RemoteRepository;
026import org.eclipse.aether.spi.connector.transport.http.ChecksumExtractor;
027import org.eclipse.aether.spi.connector.transport.http.HttpTransporter;
028import org.eclipse.aether.spi.connector.transport.http.HttpTransporterFactory;
029import org.eclipse.aether.spi.io.PathProcessor;
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(ApacheTransporterFactory.NAME)
039public final class ApacheTransporterFactory implements HttpTransporterFactory {
040    public static final String NAME = "apache";
041
042    private float priority = 5.0f;
043
044    private final ChecksumExtractor checksumExtractor;
045
046    private final PathProcessor pathProcessor;
047
048    @Inject
049    public ApacheTransporterFactory(ChecksumExtractor checksumExtractor, PathProcessor pathProcessor) {
050        this.checksumExtractor = requireNonNull(checksumExtractor, "checksumExtractor");
051        this.pathProcessor = requireNonNull(pathProcessor, "pathProcessor");
052    }
053
054    @Override
055    public float getPriority() {
056        return priority;
057    }
058
059    /**
060     * Sets the priority of this component.
061     *
062     * @param priority The priority.
063     * @return This component for chaining, never {@code null}.
064     */
065    public ApacheTransporterFactory setPriority(float priority) {
066        this.priority = priority;
067        return this;
068    }
069
070    @Override
071    public HttpTransporter newInstance(RepositorySystemSession session, RemoteRepository repository)
072            throws NoTransporterException {
073        requireNonNull(session, "session cannot be null");
074        requireNonNull(repository, "repository cannot be null");
075
076        if (!"http".equalsIgnoreCase(repository.getProtocol()) && !"https".equalsIgnoreCase(repository.getProtocol())) {
077            throw new NoTransporterException(repository);
078        }
079
080        return new ApacheTransporter(repository, session, checksumExtractor, pathProcessor);
081    }
082}