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