1 package org.eclipse.aether.impl;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.eclipse.aether.RepositorySystem;
23 import org.eclipse.aether.RepositorySystemSession;
24 import org.eclipse.aether.repository.LocalRepository;
25 import org.eclipse.aether.repository.LocalRepositoryManager;
26 import org.eclipse.aether.repository.NoLocalRepositoryManagerException;
27
28 /**
29 * Retrieves a local repository manager from the installed local repository manager factories.
30 *
31 * @noimplement This interface is not intended to be implemented by clients.
32 * @noextend This interface is not intended to be extended by clients.
33 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
34 */
35 public interface LocalRepositoryProvider
36 {
37
38 /**
39 * Creates a new manager for the specified local repository. If the specified local repository has no type, the
40 * default local repository type of the system will be used. <em>Note:</em> It is expected that this method
41 * invocation is one of the last steps of setting up a new session, in particular any configuration properties
42 * should have been set already.
43 *
44 * @param session The repository system session from which to configure the manager, must not be {@code null}.
45 * @param localRepository The local repository to create a manager for, must not be {@code null}.
46 * @return The local repository manager, never {@code null}.
47 * @throws NoLocalRepositoryManagerException If the specified repository type is not recognized or no base directory
48 * is given.
49 * @see RepositorySystem#newLocalRepositoryManager(RepositorySystemSession, LocalRepository)
50 */
51 LocalRepositoryManager newLocalRepositoryManager( RepositorySystemSession session, LocalRepository localRepository )
52 throws NoLocalRepositoryManagerException;
53
54 }