001package org.eclipse.aether.transport.file;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import javax.inject.Named;
023
024import java.util.Objects;
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
032/**
033 * A transporter factory for repositories using the {@code file:} protocol.
034 */
035@Named( "file" )
036public final class FileTransporterFactory
037    implements TransporterFactory
038{
039
040    private float priority;
041
042    /**
043     * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
044     * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
045     * will occur.
046     */
047    public FileTransporterFactory()
048    {
049        // enables default constructor
050    }
051
052    public float getPriority()
053    {
054        return priority;
055    }
056
057    /**
058     * Sets the priority of this component.
059     *
060     * @param priority The priority.
061     * @return This component for chaining, never {@code null}.
062     */
063    public FileTransporterFactory setPriority( float priority )
064    {
065        this.priority = priority;
066        return this;
067    }
068
069    public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
070        throws NoTransporterException
071    {
072        Objects.requireNonNull( session, "session cannot be null" );
073        Objects.requireNonNull( repository, "repository cannot be null" );
074
075        return new FileTransporter( repository );
076    }
077
078}