001package org.eclipse.aether.spi.connector.layout; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import org.eclipse.aether.RepositorySystemSession; 023import org.eclipse.aether.repository.RemoteRepository; 024import org.eclipse.aether.transfer.NoRepositoryLayoutException; 025 026/** 027 * A factory to obtain repository layouts. A repository layout is responsible to map an artifact or some metadata to a 028 * URI relative to the repository root where the resource resides. When the repository system needs to access a given 029 * remote repository, it iterates the registered factories in descending order of their priority and calls 030 * {@link #newInstance(RepositorySystemSession, RemoteRepository)} on them. The first layout returned by a factory will 031 * then be used for transferring artifacts/metadata. 032 */ 033public interface RepositoryLayoutFactory 034{ 035 036 /** 037 * Tries to create a repository layout for the specified remote repository. Typically, a factory will inspect 038 * {@link RemoteRepository#getContentType()} to determine whether it can handle a repository. 039 * 040 * @param session The repository system session from which to configure the layout, must not be {@code null}. 041 * @param repository The remote repository to create a layout for, must not be {@code null}. 042 * @return The layout for the given repository, never {@code null}. 043 * @throws NoRepositoryLayoutException If the factory cannot create a repository layout for the specified remote 044 * repository. 045 */ 046 RepositoryLayout newInstance( RepositorySystemSession session, RemoteRepository repository ) 047 throws NoRepositoryLayoutException; 048 049 /** 050 * The priority of this factory. When multiple factories can handle a given repository, factories with higher 051 * priority are preferred over those with lower priority. 052 * 053 * @return The priority of this factory. 054 */ 055 float getPriority(); 056 057}