1 package org.eclipse.aether.spi.connector;
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.NoRepositoryConnectorException;
25
26 /**
27 * A factory to create repository connectors. A repository connector is responsible for uploads/downloads to/from a
28 * certain kind of remote repository. When the repository system needs a repository connector for a given remote
29 * repository, it iterates the registered factories in descending order of their priority and calls
30 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first connector returned by a factory
31 * will then be used for the transfer.
32 */
33 public interface RepositoryConnectorFactory
34 {
35
36 /**
37 * Tries to create a repository connector for the specified remote repository. Typically, a factory will inspect
38 * {@link RemoteRepository#getProtocol()} and {@link RemoteRepository#getContentType()} to determine whether it can
39 * handle a repository.
40 *
41 * @param session The repository system session from which to configure the connector, must not be {@code null}. In
42 * particular, a connector must notify any {@link RepositorySystemSession#getTransferListener()} set for
43 * the session and should obey the timeouts configured for the session.
44 * @param repository The remote repository to create a connector for, must not be {@code null}.
45 * @return The connector for the given repository, never {@code null}.
46 * @throws NoRepositoryConnectorException If the factory cannot create a connector for the specified remote
47 * repository.
48 */
49 RepositoryConnector newInstance( RepositorySystemSession session, RemoteRepository repository )
50 throws NoRepositoryConnectorException;
51
52 /**
53 * The priority of this factory. When multiple factories can handle a given repository, factories with higher
54 * priority are preferred over those with lower priority.
55 *
56 * @return The priority of this factory.
57 */
58 float getPriority();
59
60 }