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.impl;
20
21 import org.eclipse.aether.RepositorySystem;
22 import org.eclipse.aether.RepositorySystemSession;
23 import org.eclipse.aether.repository.LocalRepository;
24 import org.eclipse.aether.repository.LocalRepositoryManager;
25 import org.eclipse.aether.repository.NoLocalRepositoryManagerException;
26
27 /**
28 * Retrieves a local repository manager from the installed local repository manager factories.
29 *
30 * @noimplement This interface is not intended to be implemented by clients.
31 * @noextend This interface is not intended to be extended by clients.
32 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
33 */
34 public interface LocalRepositoryProvider {
35
36 /**
37 * Creates a new manager for the specified local repository. If the specified local repository has no type, the
38 * default local repository type of the system will be used. <em>Note:</em> It is expected that this method
39 * invocation is one of the last steps of setting up a new session, in particular any configuration properties
40 * should have been set already.
41 *
42 * @param session The repository system session from which to configure the manager, must not be {@code null}.
43 * @param localRepository The local repository to create a manager for, must not be {@code null}.
44 * @return The local repository manager, never {@code null}.
45 * @throws NoLocalRepositoryManagerException If the specified repository type is not recognized or no base directory
46 * is given.
47 * @see RepositorySystem#newLocalRepositoryManager(RepositorySystemSession, LocalRepository)
48 */
49 LocalRepositoryManager newLocalRepositoryManager(RepositorySystemSession session, LocalRepository localRepository)
50 throws NoLocalRepositoryManagerException;
51 }