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 * A factory to obtain repository layouts. A repository layout is responsible to map an artifact or some metadata to a
28 * URI relative to the repository root where the resource resides. When the repository system needs to access a given
29 * remote repository, it iterates the registered factories in descending order of their priority and calls
30 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first layout returned by a factory will
31 * then be used for transferring artifacts/metadata.
32 */
33 public interface RepositoryLayoutFactory
34 {
35
36 /**
37 * Tries to create a repository layout for the specified remote repository. Typically, a factory will inspect
38 * {@link RemoteRepository#getContentType()} to determine whether it can handle a repository.
39 *
40 * @param session The repository system session from which to configure the layout, must not be {@code null}.
41 * @param repository The remote repository to create a layout for, must not be {@code null}.
42 * @return The layout for the given repository, never {@code null}.
43 * @throws NoRepositoryLayoutException If the factory cannot create a repository layout for the specified remote
44 * repository.
45 */
46 RepositoryLayout newInstance( RepositorySystemSession session, RemoteRepository repository )
47 throws NoRepositoryLayoutException;
48
49 /**
50 * The priority of this factory. When multiple factories can handle a given repository, factories with higher
51 * priority are preferred over those with lower priority.
52 *
53 * @return The priority of this factory.
54 */
55 float getPriority();
56
57 }