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 org.eclipse.aether.RepositorySystemSession;
025import org.eclipse.aether.repository.RemoteRepository;
026import org.eclipse.aether.spi.connector.transport.Transporter;
027import org.eclipse.aether.spi.connector.transport.TransporterFactory;
028import org.eclipse.aether.transfer.NoTransporterException;
029
030/**
031 * A transporter factory for repositories using the {@code file:} protocol.
032 */
033@Named( "file" )
034public final class FileTransporterFactory
035    implements TransporterFactory
036{
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    {
047        // enables default constructor
048    }
049
050    public float getPriority()
051    {
052        return priority;
053    }
054
055    /**
056     * Sets the priority of this component.
057     * 
058     * @param priority The priority.
059     * @return This component for chaining, never {@code null}.
060     */
061    public FileTransporterFactory setPriority( float priority )
062    {
063        this.priority = priority;
064        return this;
065    }
066
067    public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
068        throws NoTransporterException
069    {
070        return new FileTransporter( repository );
071    }
072
073}