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.impl;
020
021import org.eclipse.aether.RepositorySystem;
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.installation.InstallRequest;
024import org.eclipse.aether.installation.InstallResult;
025import org.eclipse.aether.installation.InstallationException;
026
027/**
028 * Publishes artifacts to the local repository.
029 *
030 * @noimplement This interface is not intended to be implemented by clients.
031 * @noextend This interface is not intended to be extended by clients.
032 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
033 */
034public interface Installer {
035
036    /**
037     * Installs a collection of artifacts and their accompanying metadata to the local repository.
038     *
039     * @param session The repository session, must not be {@code null}.
040     * @param request The installation request, must not be {@code null}.
041     * @return The installation result, never {@code null}.
042     * @throws InstallationException If any artifact/metadata from the request could not be installed.
043     * @see RepositorySystem#install(RepositorySystemSession, InstallRequest)
044     * @see MetadataGeneratorFactory#newInstance(RepositorySystemSession, InstallRequest)
045     */
046    InstallResult install(RepositorySystemSession session, InstallRequest request) throws InstallationException;
047}