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