View Javadoc
1   package org.apache.maven.repository;
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 java.io.File;
23  import java.util.List;
24  
25  import org.apache.maven.artifact.Artifact;
26  import org.apache.maven.artifact.InvalidRepositoryException;
27  import org.apache.maven.artifact.repository.ArtifactRepository;
28  import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
29  import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
30  import org.apache.maven.artifact.resolver.ArtifactResolutionRequest;
31  import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
32  import org.apache.maven.model.Dependency;
33  import org.apache.maven.model.Plugin;
34  import org.apache.maven.model.Repository;
35  import org.apache.maven.settings.Mirror;
36  import org.apache.maven.settings.Server;
37  import org.eclipse.aether.RepositorySystemSession;
38  
39  /**
40   * @author Jason van Zyl
41   * @since 3.0-alpha
42   */
43  public interface RepositorySystem
44  {
45      String DEFAULT_LOCAL_REPO_ID = "local";
46  
47      String userHome = System.getProperty( "user.home" );
48  
49      File userMavenConfigurationHome = new File( userHome, ".m2" );
50  
51      File defaultUserLocalRepository = new File( userMavenConfigurationHome, "repository" );
52  
53      String DEFAULT_REMOTE_REPO_ID = "central";
54  
55      String DEFAULT_REMOTE_REPO_URL = "https://repo.maven.apache.org/maven2";
56  
57      Artifact createArtifact( String groupId, String artifactId, String version, String packaging );
58  
59      Artifact createArtifact( String groupId, String artifactId, String version, String scope, String type );
60  
61      Artifact createProjectArtifact( String groupId, String artifactId, String version );
62  
63      Artifact createArtifactWithClassifier( String groupId, String artifactId, String version, String type,
64                                             String classifier );
65  
66      Artifact createPluginArtifact( Plugin plugin );
67  
68      Artifact createDependencyArtifact( Dependency dependency );
69  
70      ArtifactRepository buildArtifactRepository( Repository repository )
71          throws InvalidRepositoryException;
72  
73      ArtifactRepository createDefaultRemoteRepository()
74          throws InvalidRepositoryException;
75  
76      ArtifactRepository createDefaultLocalRepository()
77          throws InvalidRepositoryException;
78  
79      ArtifactRepository createLocalRepository( File localRepository )
80          throws InvalidRepositoryException;
81  
82      ArtifactRepository createArtifactRepository( String id, String url, ArtifactRepositoryLayout repositoryLayout,
83                                                   ArtifactRepositoryPolicy snapshots,
84                                                   ArtifactRepositoryPolicy releases );
85  
86      /**
87       * Calculates the effective repositories for the given input repositories which are assumed to be already mirrored
88       * (if applicable). This process will essentially remove duplicate repositories by merging them into one equivalent
89       * repository. It is worth to point out that merging does not simply choose one of the input repositories and
90       * discards the others but actually combines their possibly different policies.
91       *
92       * @param repositories The original repositories, may be {@code null}.
93       * @return The effective repositories or {@code null} if the input was {@code null}.
94       */
95      List<ArtifactRepository> getEffectiveRepositories( List<ArtifactRepository> repositories );
96  
97      /**
98       * Determines the mirror for the specified repository.
99       *
100      * @param repository The repository to determine the mirror for, must not be {@code null}.
101      * @param mirrors The available mirrors, may be {@code null}.
102      * @return The mirror specification for the repository or {@code null} if no mirror matched.
103      */
104     Mirror getMirror( ArtifactRepository repository, List<Mirror> mirrors );
105 
106     /**
107      * Injects the mirroring information into the specified repositories. For each repository that is matched by a
108      * mirror, its URL and ID will be updated to match the values from the mirror specification. Repositories without a
109      * matching mirror will pass through unchanged. <em>Note:</em> This method must be called before
110      * {@link #injectAuthentication(List, List)} or the repositories will end up with the wrong credentials.
111      *
112      * @param repositories The repositories into which to inject the mirror information, may be {@code null}.
113      * @param mirrors The available mirrors, may be {@code null}.
114      */
115     void injectMirror( List<ArtifactRepository> repositories, List<Mirror> mirrors );
116 
117     /**
118      * Injects the proxy information into the specified repositories. For each repository that is matched by a proxy,
119      * its proxy data will be set accordingly. Repositories without a matching proxy will have their proxy cleared.
120      * <em>Note:</em> This method must be called after {@link #injectMirror(List, List)} or the repositories will end up
121      * with the wrong proxies.
122      *
123      * @param repositories The repositories into which to inject the proxy information, may be {@code null}.
124      * @param proxies The available proxies, may be {@code null}.
125      */
126     void injectProxy( List<ArtifactRepository> repositories, List<org.apache.maven.settings.Proxy> proxies );
127 
128     /**
129      * Injects the authentication information into the specified repositories. For each repository that is matched by a
130      * server, its credentials will be updated to match the values from the server specification. Repositories without a
131      * matching server will have their credentials cleared. <em>Note:</em> This method must be called after
132      * {@link #injectMirror(List, List)} or the repositories will end up with the wrong credentials.
133      *
134      * @param repositories The repositories into which to inject the authentication information, may be {@code null}.
135      * @param servers The available servers, may be {@code null}.
136      */
137     void injectAuthentication( List<ArtifactRepository> repositories, List<Server> servers );
138 
139     void injectMirror( RepositorySystemSession session, List<ArtifactRepository> repositories );
140 
141     void injectProxy( RepositorySystemSession session, List<ArtifactRepository> repositories );
142 
143     void injectAuthentication( RepositorySystemSession session, List<ArtifactRepository> repositories );
144 
145     ArtifactResolutionResult resolve( ArtifactResolutionRequest request );
146 
147     // Install
148 
149     // Deploy
150 
151     // Map types of artifacts
152 
153     //
154     // Raw file transfers
155     //
156     void publish( ArtifactRepository repository, File source, String remotePath,
157                   ArtifactTransferListener transferListener )
158         throws ArtifactTransferFailedException;
159 
160     void retrieve( ArtifactRepository repository, File destination, String remotePath,
161                    ArtifactTransferListener transferListener )
162         throws ArtifactTransferFailedException, ArtifactDoesNotExistException;
163 
164 }