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
210 lines (185 loc) · 5.71 KB
/
ContainerRef.java
File metadata and controls
210 lines (185 loc) · 5.71 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
package land.oras;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import land.oras.utils.Const;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;
/**
* A OCI artifact
*/
@NullMarked
public final class ContainerRef {
/**
* 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 tag of the container.
*/
private final String tag;
/**
* 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) {
this.registry = registry;
this.namespace = namespace;
this.repository = repository;
this.tag = tag;
this.digest = digest;
}
/**
* Create a new container reference
* @return The new container reference
*/
public String getRegistry() {
return registry;
}
/**
* Get the namespace
* @return The namespace
*/
public @Nullable String getNamespace() {
return namespace;
}
/**
* Get the repository
* @return The repository
*/
public String getRepository() {
return repository;
}
/**
* Get the tag
* @return The tag
*/
public String getTag() {
return tag;
}
/**
* Get the digest
* @return The digest
*/
public @Nullable String getDigest() {
return digest;
}
/**
* Create a new container reference with the digest
* @param digest The digest
* @return The new container reference
*/
public ContainerRef withDigest(String digest) {
return new ContainerRef(registry, namespace, repository, tag, digest);
}
/**
* Get the API prefix
* @return The API prefix
*/
private String getApiPrefix() {
if (namespace != null) {
return "%s/v2/%s/%s".formatted(registry, namespace, repository);
}
return "%s/v2/%s".formatted(registry, repository);
}
/**
* Return the tag URL
* @return The tag URL
*/
public String getTagsPath() {
return "%s/tags/list".formatted(getApiPrefix());
}
/**
* 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);
}
return new ContainerRef(registry, namespace, repository, tag, digest);
}
}