001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.connector;
020
021import org.eclipse.aether.RepositorySystemSession;
022import org.eclipse.aether.repository.RemoteRepository;
023import org.eclipse.aether.transfer.NoRepositoryConnectorException;
024
025/**
026 * A factory to create repository connectors. A repository connector is responsible for uploads/downloads to/from a
027 * certain kind of remote repository. When the repository system needs a repository connector for a given remote
028 * repository, it iterates the registered factories in descending order of their priority and calls
029 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first connector returned by a factory
030 * will then be used for the transfer.
031 */
032public interface RepositoryConnectorFactory {
033
034    /**
035     * Tries to create a repository connector for the specified remote repository. Typically, a factory will inspect
036     * {@link RemoteRepository#getProtocol()} and {@link RemoteRepository#getContentType()} to determine whether it can
037     * handle a repository.
038     *
039     * @param session The repository system session from which to configure the connector, must not be {@code null}. In
040     *            particular, a connector must notify any {@link RepositorySystemSession#getTransferListener()} set for
041     *            the session and should obey the timeouts configured for the session.
042     * @param repository The remote repository to create a connector for, must not be {@code null}.
043     * @return The connector for the given repository, never {@code null}.
044     * @throws NoRepositoryConnectorException If the factory cannot create a connector for the specified remote
045     *             repository.
046     */
047    RepositoryConnector newInstance(RepositorySystemSession session, RemoteRepository repository)
048            throws NoRepositoryConnectorException;
049
050    /**
051     * The priority of this factory. When multiple factories can handle a given repository, factories with higher
052     * priority are preferred over those with lower priority.
053     *
054     * @return The priority of this factory.
055     */
056    float getPriority();
057}