forked from oras-project/oras-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathManifest.java
More file actions
301 lines (276 loc) · 7.82 KB
/
Manifest.java
File metadata and controls
301 lines (276 loc) · 7.82 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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/*-
* =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.nio.file.Path;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import land.oras.utils.Const;
import land.oras.utils.JsonUtils;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.NullUnmarked;
import org.jspecify.annotations.Nullable;
/**
* Class for manifest
*/
@NullUnmarked
public final class Manifest extends Descriptor {
private final int schemaVersion;
private final Config config;
private final Subject subject;
private final List<Layer> layers;
/**
* The manifest descriptor
*/
private final transient ManifestDescriptor descriptor;
/**
* Original json
*/
private transient String json;
private Manifest(
int schemaVersion,
String mediaType,
ArtifactType artifactType,
ManifestDescriptor descriptor,
Config config,
Subject subject,
List<Layer> layers,
Annotations annotations,
String json) {
super(
null,
null,
mediaType,
Map.copyOf(annotations.manifestAnnotations()),
artifactType != null ? artifactType.getMediaType() : null);
this.schemaVersion = schemaVersion;
this.descriptor = descriptor;
this.config = config;
this.subject = subject;
this.layers = layers;
this.json = json;
}
/**
* Get the schema version
* @return The schema version
*/
public int getSchemaVersion() {
return schemaVersion;
}
@Override
public @NonNull ArtifactType getArtifactType() {
if (artifactType != null) {
return ArtifactType.from(artifactType);
}
if (config != null) {
return ArtifactType.from(
config.getMediaType() != null ? config.getMediaType() : Const.DEFAULT_ARTIFACT_MEDIA_TYPE);
}
return ArtifactType.unknown();
}
/**
* Get the descriptor
* @return The descriptor
*/
public ManifestDescriptor getDescriptor() {
return descriptor;
}
/**
* Get the config
* @return The config
*/
public Config getConfig() {
return config;
}
/**
* Get the subject
* @return The subject
*/
public Subject getSubject() {
return subject;
}
/**
* Get the layers
* @return The layers
*/
public List<Layer> getLayers() {
return layers != null ? Collections.unmodifiableList(layers) : List.of();
}
/**
* Return a new manifest with the given artifact type
* @param artifactType The artifact type
* @return The manifest
*/
public Manifest withArtifactType(ArtifactType artifactType) {
return new Manifest(
schemaVersion,
mediaType,
artifactType,
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return a new manifest with the given layers
* @param layers The layers
* @return The manifest
*/
public Manifest withLayers(List<Layer> layers) {
return new Manifest(
schemaVersion,
mediaType,
getTopLevelArtifactType(),
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return a new manifest with the given config
* @param config The config
* @return The manifest
*/
public Manifest withConfig(Config config) {
return new Manifest(
schemaVersion,
mediaType,
getTopLevelArtifactType(),
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return a new manifest with the given config
* @param subject The subject
* @return The manifest
*/
public Manifest withSubject(Subject subject) {
return new Manifest(
schemaVersion,
mediaType,
getTopLevelArtifactType(),
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return a new manifest with the given annotations
* @param annotations The annotations
* @return The manifest
*/
public Manifest withAnnotations(Map<String, String> annotations) {
return new Manifest(
schemaVersion,
mediaType,
getTopLevelArtifactType(),
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return a new manifest with the given descriptor
* @param descriptor The descriptor
* @return The manifest
*/
public Manifest withDescriptor(ManifestDescriptor descriptor) {
return new Manifest(
schemaVersion,
mediaType,
getTopLevelArtifactType(),
descriptor,
config,
subject,
layers,
Annotations.ofManifest(annotations),
json);
}
/**
* Return same instance but with original JSON
* @param json The original JSON
* @return The index
*/
private Manifest withJson(String json) {
this.json = json;
return this;
}
/**
* Create a manifest from a JSON string
* @param json The JSON string
* @return The manifest
*/
public static Manifest fromJson(String json) {
return JsonUtils.fromJson(json, Manifest.class).withJson(json);
}
/**
* Create a manifest from a path
* @param path The path
* @return The manifest
*/
public static Manifest fromPath(Path path) {
return fromJson(JsonUtils.readFile(path));
}
/**
* Return the original JSON
* @return The original JSON
*/
public String getJson() {
return json;
}
private @Nullable ArtifactType getTopLevelArtifactType() {
if (artifactType != null) {
return ArtifactType.from(artifactType);
}
return null;
}
/**
* Return a copy of an empty manifest
* @return The empty manifest
*/
public static Manifest empty() {
ManifestDescriptor descriptor = ManifestDescriptor.of(
Const.DEFAULT_EMPTY_MEDIA_TYPE,
"sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
2);
return new Manifest(
2,
Const.DEFAULT_MANIFEST_MEDIA_TYPE,
null,
descriptor,
Config.empty(),
null,
List.of(),
Annotations.empty(),
null);
}
}