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.apache.maven.repository;
20
21 import java.io.File;
22 import java.util.List;
23
24 import org.apache.maven.artifact.Artifact;
25 import org.apache.maven.artifact.InvalidRepositoryException;
26 import org.apache.maven.artifact.repository.ArtifactRepository;
27 import org.apache.maven.artifact.repository.ArtifactRepositoryPolicy;
28 import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
29 import org.apache.maven.artifact.resolver.ArtifactResolutionRequest;
30 import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
31 import org.apache.maven.model.Dependency;
32 import org.apache.maven.model.Plugin;
33 import org.apache.maven.model.Repository;
34 import org.apache.maven.settings.Mirror;
35 import org.apache.maven.settings.Server;
36 import org.eclipse.aether.RepositorySystemSession;
37
38 /**
39 * @author Jason van Zyl
40 * @since 3.0-alpha
41 */
42 public interface RepositorySystem {
43 String DEFAULT_LOCAL_REPO_ID = "local";
44
45 @SuppressWarnings("checkstyle:constantname")
46 String userHome = System.getProperty("user.home");
47
48 @SuppressWarnings("checkstyle:constantname")
49 File userMavenConfigurationHome = new File(userHome, ".m2");
50
51 @SuppressWarnings("checkstyle:constantname")
52 File defaultUserLocalRepository = new File(userMavenConfigurationHome, "repository");
53
54 String DEFAULT_REMOTE_REPO_ID = "central";
55
56 String DEFAULT_REMOTE_REPO_URL = "https://repo.maven.apache.org/maven2";
57
58 Artifact createArtifact(String groupId, String artifactId, String version, String packaging);
59
60 Artifact createArtifact(String groupId, String artifactId, String version, String scope, String type);
61
62 Artifact createProjectArtifact(String groupId, String artifactId, String version);
63
64 Artifact createArtifactWithClassifier(
65 String groupId, String artifactId, String version, String type, String classifier);
66
67 Artifact createPluginArtifact(Plugin plugin);
68
69 Artifact createDependencyArtifact(Dependency dependency);
70
71 ArtifactRepository buildArtifactRepository(Repository repository) throws InvalidRepositoryException;
72
73 ArtifactRepository createDefaultRemoteRepository() throws InvalidRepositoryException;
74
75 ArtifactRepository createDefaultLocalRepository() throws InvalidRepositoryException;
76
77 ArtifactRepository createLocalRepository(File localRepository) throws InvalidRepositoryException;
78
79 ArtifactRepository createArtifactRepository(
80 String id,
81 String url,
82 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(
157 ArtifactRepository repository, File source, String remotePath, ArtifactTransferListener transferListener)
158 throws ArtifactTransferFailedException;
159
160 void retrieve(
161 ArtifactRepository repository,
162 File destination,
163 String remotePath,
164 ArtifactTransferListener transferListener)
165 throws ArtifactTransferFailedException, ArtifactDoesNotExistException;
166 }