001package org.eclipse.aether.spi.connector; 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 org.eclipse.aether.RepositorySystemSession; 023import org.eclipse.aether.repository.RemoteRepository; 024import org.eclipse.aether.transfer.NoRepositoryConnectorException; 025 026/** 027 * A factory to create repository connectors. A repository connector is responsible for uploads/downloads to/from a 028 * certain kind of remote repository. When the repository system needs a repository connector for a given remote 029 * repository, it iterates the registered factories in descending order of their priority and calls 030 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first connector returned by a factory 031 * will then be used for the transfer. 032 */ 033public interface RepositoryConnectorFactory 034{ 035 036 /** 037 * Tries to create a repository connector for the specified remote repository. Typically, a factory will inspect 038 * {@link RemoteRepository#getProtocol()} and {@link RemoteRepository#getContentType()} to determine whether it can 039 * handle a repository. 040 * 041 * @param session The repository system session from which to configure the connector, must not be {@code null}. In 042 * particular, a connector must notify any {@link RepositorySystemSession#getTransferListener()} set for 043 * the session and should obey the timeouts configured for the session. 044 * @param repository The remote repository to create a connector for, must not be {@code null}. 045 * @return The connector for the given repository, never {@code null}. 046 * @throws NoRepositoryConnectorException If the factory cannot create a connector for the specified remote 047 * repository. 048 */ 049 RepositoryConnector newInstance( RepositorySystemSession session, RemoteRepository repository ) 050 throws NoRepositoryConnectorException; 051 052 /** 053 * The priority of this factory. When multiple factories can handle a given repository, factories with higher 054 * priority are preferred over those with lower priority. 055 * 056 * @return The priority of this factory. 057 */ 058 float getPriority(); 059 060}