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