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.artifact.repository;
20
21 import java.util.List;
22
23 import org.apache.maven.artifact.Artifact;
24 import org.apache.maven.artifact.metadata.ArtifactMetadata;
25 import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
26 import org.apache.maven.repository.Proxy;
27
28 /**
29 * Abstraction of an artifact repository. Artifact repositories can be remote, local, or even build reactor or
30 * IDE workspace.
31 *
32 * @deprecated Avoid use of this type, if you need access to local repository use repository system classes instead.
33 */
34 @Deprecated
35 public interface ArtifactRepository {
36 String pathOf(Artifact artifact);
37
38 String pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata);
39
40 String pathOfLocalRepositoryMetadata(ArtifactMetadata metadata, ArtifactRepository repository);
41
42 String getUrl();
43
44 void setUrl(String url);
45
46 String getBasedir();
47
48 String getProtocol();
49
50 String getId();
51
52 void setId(String id);
53
54 ArtifactRepositoryPolicy getSnapshots();
55
56 void setSnapshotUpdatePolicy(ArtifactRepositoryPolicy policy);
57
58 ArtifactRepositoryPolicy getReleases();
59
60 void setReleaseUpdatePolicy(ArtifactRepositoryPolicy policy);
61
62 ArtifactRepositoryLayout getLayout();
63
64 void setLayout(ArtifactRepositoryLayout layout);
65
66 String getKey();
67
68 @Deprecated
69 boolean isUniqueVersion();
70
71 @Deprecated
72 boolean isBlacklisted();
73
74 @Deprecated
75 void setBlacklisted(boolean blackListed);
76
77 /**
78 * @return whether the repository is blocked
79 * @since 3.8.1
80 **/
81 boolean isBlocked();
82
83 /**
84 * @param blocked block the repository?
85 * @since 3.8.1
86 **/
87 void setBlocked(boolean blocked);
88
89 //
90 // New interface methods for the repository system.
91 //
92 /**
93 *
94 * @param artifact an artifact
95 * @return found artifact
96 * @since 3.0-alpha-3
97 */
98 Artifact find(Artifact artifact);
99
100 /**
101 * Finds the versions of the specified artifact that are available in this repository.
102 *
103 * @param artifact The artifact whose available versions should be determined, must not be {@code null}.
104 * @return The available versions of the artifact or an empty list if none, never {@code null}.
105 * @since 3.0-alpha-3
106 */
107 List<String> findVersions(Artifact artifact);
108
109 /**
110 * Indicates whether this repository is backed by actual projects. For instance, the build reactor or IDE workspace
111 * are examples of such repositories.
112 *
113 * @return {@code true} if the repository is backed by actual projects, {@code false} otherwise.
114 * @since 3.0-beta-1
115 */
116 boolean isProjectAware();
117
118 /**
119 * @param authentication authentication
120 * @since 3.0-alpha-3
121 */
122 void setAuthentication(Authentication authentication);
123
124 /**
125 * @return repository authentication
126 * @since 3.0-alpha-3
127 */
128 Authentication getAuthentication();
129
130 /**
131 * @param proxy proxy
132 * @since 3.0-alpha-3
133 */
134 void setProxy(Proxy proxy);
135
136 /**
137 * @since 3.0-alpha-3
138 * @return repository proxy
139 */
140 Proxy getProxy();
141
142 /**
143 * @since 3.0.3
144 * @return the repositories mirrored by the actual one
145 */
146 List<ArtifactRepository> getMirroredRepositories();
147
148 /**
149 * @since 3.0.3
150 * @param mirroredRepositories the repositories that the actual one mirrors
151 */
152 void setMirroredRepositories(List<ArtifactRepository> mirroredRepositories);
153 }