forked from oras-project/oras-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathContainerRef.java
More file actions
284 lines (253 loc) · 8.36 KB
/
ContainerRef.java
File metadata and controls
284 lines (253 loc) · 8.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/*-
* =LICENSE=
* ORAS Java SDK
* ===
* Copyright (C) 2024 - 2025 ORAS
* ===
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =LICENSEEND=
*/
package land.oras;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import land.oras.exception.OrasException;
import land.oras.utils.Const;
import land.oras.utils.SupportedAlgorithm;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;
/**
* A referer of a container on a {@link Registry}.
*/
@NullMarked
public final class ContainerRef extends Ref {
/**
* The regex pattern to parse the container name including the registry, namespace, repository, tag and digest.
*/
private static final Pattern NAME_REGEX = Pattern.compile(
"(?:([^/@]+[.:][^/@]*)/)?" // registry
+ "((?:[^:@/]+/)+)?" // namespace
+ "([^:@/]+)" // repository
+ "(?::([^:@]+))?" // tag
+ "(?:@(.+))?" // digest
+ "$");
/**
* The registry where the container is stored.
*/
private final String registry;
/**
* The repository where the container is stored.
*/
private final String repository;
/**
* The namespace of the container.
*/
private final @Nullable String namespace;
/**
* The digest of the container.
*/
private final @Nullable String digest;
/**
* Private constructor
* @param registry The registry where the container is stored.
* @param namespace The namespace of the container.
* @param repository The repository where the container is stored
* @param tag The tag of the container.
* @param digest The digest of the container.
*/
private ContainerRef(
String registry, @Nullable String namespace, String repository, String tag, @Nullable String digest) {
super(tag);
this.registry = registry;
this.namespace = namespace;
this.repository = repository;
this.digest = digest;
}
/**
* Create a new container reference
* @return The new container reference
*/
public String getRegistry() {
return registry;
}
/**
* Get the API registry
* @return The API registry
*/
public String getApiRegistry() {
String registry = getRegistry();
if (registry.equals("docker.io")) {
return "registry-1.docker.io";
}
return registry;
}
/**
* Get the namespace
* @return The namespace
*/
public @Nullable String getNamespace() {
String registry = getRegistry();
if (namespace == null && registry.equals("docker.io")) {
return "library";
}
return namespace;
}
/**
* Get the repository
* @return The repository
*/
public String getRepository() {
return repository;
}
/**
* Get the digest
* @return The digest
*/
public @Nullable String getDigest() {
return digest;
}
@Override
public ContainerRef withDigest(String digest) {
return new ContainerRef(registry, getNamespace(), repository, tag, digest);
}
@Override
public SupportedAlgorithm getAlgorithm() {
// Default if not set
if (digest == null) {
return SupportedAlgorithm.getDefault();
}
// See https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests
return SupportedAlgorithm.fromDigest(digest);
}
/**
* Get the API prefix
* @return The API prefix
*/
private String getApiPrefix() {
if (namespace != null) {
return "%s/v2/%s/%s".formatted(getApiRegistry(), getNamespace(), repository);
}
return "%s/v2/%s".formatted(getApiRegistry(), repository);
}
/**
* Return the tag URL
* @return The tag URL
*/
public String getTagsPath() {
return "%s/tags/list".formatted(getApiPrefix());
}
/**
* Return the referrers URL for this container referrer
* @param artifactType The optional artifact type
* @return The referrers URL
*/
public String getReferrersPath(@Nullable ArtifactType artifactType) {
if (artifactType == null) {
return "%s/referrers/%s".formatted(getApiPrefix(), digest);
}
return "%s/referrers/%s?artifactType=%s"
.formatted(getApiPrefix(), digest, URLEncoder.encode(artifactType.toString(), StandardCharsets.UTF_8));
}
/**
* Return the manifests URL
* @return The manifests URL
*/
public String getManifestsPath() {
return "%s/manifests/%s".formatted(getApiPrefix(), digest == null ? tag : digest);
}
/**
* Return the blobs upload URL
* @return The blobs upload URL
*/
public String getBlobsUploadPath() {
return "%s/blobs/uploads/".formatted(getApiPrefix());
}
/**
* Return the blobs upload URL with the digest for single POST upload
* @return The blobs upload URL
*/
public String getBlobsUploadDigestPath() {
if (digest == null) {
throw new OrasException("You are required to include a digest");
}
return "%s/blobs/uploads/?digest=%s".formatted(getApiPrefix(), digest);
}
/**
* Return the blobs URL
* @return The blobs URL
*/
public String getBlobsPath() {
if (digest == null) {
throw new OrasException("You are required to include a digest");
}
return "%s/blobs/%s".formatted(getApiPrefix(), digest);
}
/**
* Parse the container name into registry, repository and tag.
* @param name The full name of the container to parse with any components.
* @return The container object with the registry, repository and tag.
*/
public static ContainerRef parse(String name) {
// Strip prefix http:// or https:// or oci://
name = name.replaceAll("^(http://|https://|oci://)", "");
Matcher matcher = NAME_REGEX.matcher(name);
if (!matcher.matches()) {
throw new IllegalArgumentException("Invalid container name format");
}
// Extract the parts of the container name
String registry = matcher.group(1);
String namespace = matcher.group(2);
String repository = matcher.group(3);
String tag = matcher.group(4);
String digest = matcher.group(5);
if (repository == null) {
throw new IllegalArgumentException("You are minimally required to include a <namespace>/<repository>");
}
if (registry == null) {
registry = Const.DEFAULT_REGISTRY;
}
if (tag == null) {
tag = Const.DEFAULT_TAG;
}
// Strip the trailing slash from the namespace
if (namespace != null) {
namespace = namespace.substring(0, namespace.length() - 1);
}
// Validate digest algorithm
if (digest != null) {
SupportedAlgorithm.fromDigest(digest);
}
return new ContainerRef(registry, namespace, repository, tag, digest);
}
/**
* Return a container reference for a registry
* @param registry The registry
* @return The container reference
*/
public static ContainerRef forRegistry(String registry) {
return new ContainerRef(registry, null, "library", "latest", null);
}
/**
* Return a container reference from URL
* @param url The URL
* @return The container reference
*/
public static ContainerRef fromUrl(String url) {
String registry = url.replaceAll("^(http://|https://)", "");
if (registry.contains("/")) {
registry = registry.substring(0, registry.indexOf("/"));
}
return new ContainerRef(registry, null, "library", "latest", null);
}
}