View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.impl;
20  
21  import org.eclipse.aether.RepositorySystem;
22  import org.eclipse.aether.RepositorySystemSession;
23  import org.eclipse.aether.installation.InstallRequest;
24  import org.eclipse.aether.installation.InstallResult;
25  import org.eclipse.aether.installation.InstallationException;
26  
27  /**
28   * Publishes artifacts to the local repository.
29   *
30   * @noimplement This interface is not intended to be implemented by clients.
31   * @noextend This interface is not intended to be extended by clients.
32   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
33   */
34  public interface Installer {
35  
36      /**
37       * Installs a collection of artifacts and their accompanying metadata to the local repository.
38       *
39       * @param session The repository session, must not be {@code null}.
40       * @param request The installation request, must not be {@code null}.
41       * @return The installation result, never {@code null}.
42       * @throws InstallationException If any artifact/metadata from the request could not be installed.
43       * @see RepositorySystem#install(RepositorySystemSession, InstallRequest)
44       * @see MetadataGeneratorFactory#newInstance(RepositorySystemSession, InstallRequest)
45       */
46      InstallResult install(RepositorySystemSession session, InstallRequest request) throws InstallationException;
47  }