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