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