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