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, ArtifactRepositoryPolicy releases );
84  
85      /**
86       * Calculates the effective repositories for the given input repositories which are assumed to be already mirrored
87       * (if applicable). This process will essentially remove duplicate repositories by merging them into one equivalent
88       * repository. It is worth to point out that merging does not simply choose one of the input repositories and
89       * discards the others but actually combines their possibly different policies.
90       *
91       * @param repositories The original repositories, may be {@code null}.
92       * @return The effective repositories or {@code null} if the input was {@code null}.
93       */
94      List<ArtifactRepository> getEffectiveRepositories( List<ArtifactRepository> repositories );
95  
96      /**
97       * Determines the mirror for the specified repository.
98       *
99       * @param repository The repository to determine the mirror for, must not be {@code null}.
100      * @param mirrors The available mirrors, may be {@code null}.
101      * @return The mirror specification for the repository or {@code null} if no mirror matched.
102      */
103     Mirror getMirror( ArtifactRepository repository, List<Mirror> mirrors );
104 
105     /**
106      * Injects the mirroring information into the specified repositories. For each repository that is matched by a
107      * mirror, its URL and ID will be updated to match the values from the mirror specification. Repositories without a
108      * matching mirror will pass through unchanged. <em>Note:</em> This method must be called before
109      * {@link #injectAuthentication(List, List)} or the repositories will end up with the wrong credentials.
110      *
111      * @param repositories The repositories into which to inject the mirror information, may be {@code null}.
112      * @param mirrors The available mirrors, may be {@code null}.
113      */
114     void injectMirror( List<ArtifactRepository> repositories, List<Mirror> mirrors );
115 
116     /**
117      * Injects the proxy information into the specified repositories. For each repository that is matched by a proxy,
118      * its proxy data will be set accordingly. Repositories without a matching proxy will have their proxy cleared.
119      * <em>Note:</em> This method must be called after {@link #injectMirror(List, List)} or the repositories will end up
120      * with the wrong proxies.
121      *
122      * @param repositories The repositories into which to inject the proxy information, may be {@code null}.
123      * @param proxies The available proxies, may be {@code null}.
124      */
125     void injectProxy( List<ArtifactRepository> repositories, List<org.apache.maven.settings.Proxy> proxies );
126 
127     /**
128      * Injects the authentication information into the specified repositories. For each repository that is matched by a
129      * server, its credentials will be updated to match the values from the server specification. Repositories without a
130      * matching server will have their credentials cleared. <em>Note:</em> This method must be called after
131      * {@link #injectMirror(List, List)} or the repositories will end up with the wrong credentials.
132      *
133      * @param repositories The repositories into which to inject the authentication information, may be {@code null}.
134      * @param servers The available servers, may be {@code null}.
135      */
136     void injectAuthentication( List<ArtifactRepository> repositories, List<Server> servers );
137 
138     void injectMirror( RepositorySystemSession session, List<ArtifactRepository> repositories );
139 
140     void injectProxy( RepositorySystemSession session, List<ArtifactRepository> repositories );
141 
142     void injectAuthentication( RepositorySystemSession session, List<ArtifactRepository> repositories );
143     
144     ArtifactResolutionResult resolve( ArtifactResolutionRequest request );
145 
146     // Install
147 
148     // Deploy
149 
150     // Map types of artifacts
151 
152     //
153     // Raw file transfers
154     //
155     void publish( ArtifactRepository repository, File source, String remotePath,
156                   ArtifactTransferListener transferListener )
157         throws ArtifactTransferFailedException;
158 
159     void retrieve( ArtifactRepository repository, File destination, String remotePath,
160                    ArtifactTransferListener transferListener )
161         throws ArtifactTransferFailedException, ArtifactDoesNotExistException;
162 
163 }