001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.spi.connector.layout;
020
021import org.eclipse.aether.RepositorySystemSession;
022import org.eclipse.aether.repository.RemoteRepository;
023import org.eclipse.aether.transfer.NoRepositoryLayoutException;
024
025/**
026 * Retrieves a repository layout from the installed layout factories.
027 *
028 * @noimplement This interface is not intended to be implemented by clients.
029 * @noextend This interface is not intended to be extended by clients.
030 */
031public interface RepositoryLayoutProvider {
032
033    /**
034     * Tries to retrieve a repository layout for the specified remote repository.
035     *
036     * @param session The repository system session from which to configure the layout, must not be {@code null}.
037     * @param repository The remote repository to create a layout for, must not be {@code null}.
038     * @return The layout for the given repository, never {@code null}.
039     * @throws NoRepositoryLayoutException If none of the installed layout factories can provide a repository layout for
040     *             the specified remote repository.
041     */
042    RepositoryLayout newRepositoryLayout(RepositorySystemSession session, RemoteRepository repository)
043            throws NoRepositoryLayoutException;
044}