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 * Retrieves a repository layout from the installed layout factories. 028 * 029 * @noimplement This interface is not intended to be implemented by clients. 030 * @noextend This interface is not intended to be extended by clients. 031 */ 032public interface RepositoryLayoutProvider 033{ 034 035 /** 036 * Tries to retrieve a repository layout for the specified remote repository. 037 * 038 * @param session The repository system session from which to configure the layout, must not be {@code null}. 039 * @param repository The remote repository to create a layout for, must not be {@code null}. 040 * @return The layout for the given repository, never {@code null}. 041 * @throws NoRepositoryLayoutException If none of the installed layout factories can provide a repository layout for 042 * the specified remote repository. 043 */ 044 RepositoryLayout newRepositoryLayout( RepositorySystemSession session, RemoteRepository repository ) 045 throws NoRepositoryLayoutException; 046 047}