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.impl;
020
021import org.eclipse.aether.RepositorySystem;
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.repository.LocalRepository;
024import org.eclipse.aether.repository.LocalRepositoryManager;
025import org.eclipse.aether.repository.NoLocalRepositoryManagerException;
026
027/**
028 * Retrieves a local repository manager from the installed local repository manager factories.
029 *
030 * @noimplement This interface is not intended to be implemented by clients.
031 * @noextend This interface is not intended to be extended by clients.
032 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
033 */
034public interface LocalRepositoryProvider {
035
036    /**
037     * Creates a new manager for the specified local repository. If the specified local repository has no type, the
038     * default local repository type of the system will be used. <em>Note:</em> It is expected that this method
039     * invocation is one of the last steps of setting up a new session, in particular any configuration properties
040     * should have been set already.
041     *
042     * @param session The repository system session from which to configure the manager, must not be {@code null}.
043     * @param localRepository The local repository to create a manager for, must not be {@code null}.
044     * @return The local repository manager, never {@code null}.
045     * @throws NoLocalRepositoryManagerException If the specified repository type is not recognized or no base directory
046     *             is given.
047     * @see RepositorySystem#newLocalRepositoryManager(RepositorySystemSession, LocalRepository)
048     */
049    LocalRepositoryManager newLocalRepositoryManager(RepositorySystemSession session, LocalRepository localRepository)
050            throws NoLocalRepositoryManagerException;
051}