1 package org.eclipse.aether.spi.connector.layout;
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.RepositorySystemSession;
23 import org.eclipse.aether.repository.RemoteRepository;
24 import org.eclipse.aether.transfer.NoRepositoryLayoutException;
25
26 /**
27 * Retrieves a repository layout from the installed layout factories.
28 *
29 * @noimplement This interface is not intended to be implemented by clients.
30 * @noextend This interface is not intended to be extended by clients.
31 */
32 public interface RepositoryLayoutProvider
33 {
34
35 /**
36 * Tries to retrieve a repository layout for the specified remote repository.
37 *
38 * @param session The repository system session from which to configure the layout, must not be {@code null}.
39 * @param repository The remote repository to create a layout for, must not be {@code null}.
40 * @return The layout for the given repository, never {@code null}.
41 * @throws NoRepositoryLayoutException If none of the installed layout factories can provide a repository layout for
42 * the specified remote repository.
43 */
44 RepositoryLayout newRepositoryLayout( RepositorySystemSession session, RemoteRepository repository )
45 throws NoRepositoryLayoutException;
46
47 }