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