1 package org.eclipse.aether.spi.connector.transport; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.eclipse.aether.RepositorySystemSession; 23 import org.eclipse.aether.repository.RemoteRepository; 24 import org.eclipse.aether.transfer.NoTransporterException; 25 26 /** 27 * A factory to create transporters. A transporter is responsible for uploads/downloads to/from a remote repository 28 * using a particular transport protocol. When the repository system needs a transporter for a given remote repository, 29 * it iterates the registered factories in descending order of their priority and calls 30 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first transporter returned by a factory 31 * will then be used for the transfer. 32 */ 33 public interface TransporterFactory 34 { 35 36 /** 37 * Tries to create a transporter for the specified remote repository. Typically, a factory will inspect 38 * {@link RemoteRepository#getProtocol()} to determine whether it can handle a repository. 39 * 40 * @param session The repository system session from which to configure the transporter, must not be {@code null}. 41 * In particular, a transporter should obey the timeouts configured for the session. 42 * @param repository The remote repository to create a transporter for, must not be {@code null}. 43 * @return The transporter for the given repository, never {@code null}. 44 * @throws NoTransporterException If the factory cannot create a transporter for the specified remote repository. 45 */ 46 Transporter newInstance( RepositorySystemSession session, RemoteRepository repository ) 47 throws NoTransporterException; 48 49 /** 50 * The priority of this factory. When multiple factories can handle a given repository, factories with higher 51 * priority are preferred over those with lower priority. 52 * 53 * @return The priority of this factory. 54 */ 55 float getPriority(); 56 57 }