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