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