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