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