forked from oras-project/oras-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLayer.java
More file actions
253 lines (227 loc) · 6.32 KB
/
Layer.java
File metadata and controls
253 lines (227 loc) · 6.32 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
package land.oras;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Base64;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import land.oras.utils.Const;
import land.oras.utils.DigestUtils;
import land.oras.utils.JsonUtils;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;
/**
* Class for layer
*/
@NullMarked
public final class Layer {
/**
* The media type of the layer
*/
private final String mediaType;
/**
* The digest of the layer
*/
private final String digest;
/**
* The size of the layer
*/
private final long size;
/**
* The base 64 encoded data. Might be null if path is set
*/
private final @Nullable String data;
/**
* The path to the blob. Might be null if data is set
*/
private final transient @Nullable Path blobPath;
/**
* Annotations for the layer
*/
private final @Nullable Map<String, String> annotations;
/**
* Constructor that can directly set the data
* Not adapted for large blob due to memory usage but convenient for small data
* @param mediaType The media type
* @param digest The digest
* @param size The size
*/
private Layer(
String mediaType,
String digest,
long size,
@Nullable String data,
@Nullable Map<String, String> annotations) {
this.mediaType = mediaType;
this.digest = digest;
this.size = size;
this.data = data;
this.blobPath = null;
this.annotations = annotations;
}
/**
* Constructor that set the data from a file
* @param mediaType The media type
* @param digest The digest
* @param size The size
* @param blobPath The path to the blob
*/
private Layer(String mediaType, String digest, long size, Path blobPath, Map<String, String> annotations) {
this.mediaType = mediaType;
this.digest = digest;
this.size = size;
this.data = null;
this.blobPath = blobPath;
this.annotations = annotations;
}
/**
* Get the media type
* @return The media type
*/
public String getMediaType() {
return mediaType;
}
/**
* Get the digest
* @return The digest
*/
public String getDigest() {
return digest;
}
/**
* Get the size
* @return The size
*/
public long getSize() {
return size;
}
/**
* Get the data
* @return The data
*/
public @Nullable String getData() {
return data;
}
/**
* Get the blob path
* @return The blob path
*/
public @Nullable Path getBlobPath() {
return blobPath;
}
/**
* Get the annotations
* @return The annotations
*/
public Map<String, String> getAnnotations() {
if (annotations == null) {
return Map.of();
}
return Collections.unmodifiableMap(annotations);
}
/**
* Create a new layer with annotations
* @param annotations The annotations
* @return The new layer
*/
public Layer withAnnotations(Map<String, String> annotations) {
return new Layer(mediaType, digest, size, data, annotations);
}
/**
* Create a new layer with media type
* @param mediaType The media type
* @return The new layer
*/
public Layer withMediaType(String mediaType) {
return new Layer(mediaType, digest, size, data, annotations);
}
/**
* Get the data as bytes
* @return The data as bytes
*/
public byte[] getDataBytes() {
if (data != null) {
return Base64.getDecoder().decode(data);
} else if (blobPath != null) {
try {
return Files.readAllBytes(blobPath);
} catch (IOException e) {
throw new OrasException("Failed to read layer data", e);
}
}
throw new OrasException("No data or blob path set");
}
/**
* Return the JSON representation of the manifest
* @return The JSON string
*/
public String toJson() {
return JsonUtils.toJson(this);
}
/**
* Create a layer from a JSON string
* @param json The JSON string
* @return The manifest
*/
public static Layer fromJson(String json) {
return JsonUtils.fromJson(json, Layer.class);
}
/**
* Create a layer from a file
* @param file The file
* @return The layer
*/
public static Layer fromFile(Path file) {
Map<String, String> annotations =
Map.of(Const.ANNOTATION_TITLE, file.getFileName().toString());
String mediaType = getContentType(file);
return new Layer(mediaType, DigestUtils.sha256(file), file.toFile().length(), file, annotations);
}
/**
* Create a layer from data
* @param data The data
* @return The layer
*/
public static Layer fromData(byte[] data) {
return new Layer(
Const.DEFAULT_BLOB_MEDIA_TYPE,
DigestUtils.sha256(data),
data.length,
Base64.getEncoder().encodeToString(data),
Map.of());
}
/**
* Get the content-type file or the default content type
* @param path The path
* @return The content type
*/
private static String getContentType(Path path) {
try {
return Objects.requireNonNullElse(Files.probeContentType(path), Const.DEFAULT_DESCRIPTOR_MEDIA_TYPE);
} catch (Exception e) {
return Const.DEFAULT_DESCRIPTOR_MEDIA_TYPE;
}
}
/**
* Create a layer from a digest
* @param digest The digest
* @param size The size
* @return The layer
*/
public static Layer fromDigest(String digest, long size) {
return new Layer(Const.DEFAULT_EMPTY_MEDIA_TYPE, digest, size, (String) null, Map.of());
}
/**
* An empty config
* @return The empty config
*/
public static Layer empty() {
return new Layer(
Const.DEFAULT_EMPTY_MEDIA_TYPE,
"sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
2,
"e30=",
Map.of());
}
}