-
-
Notifications
You must be signed in to change notification settings - Fork 468
Expand file tree
/
Copy pathAttachment.java
More file actions
399 lines (369 loc) · 14 KB
/
Attachment.java
File metadata and controls
399 lines (369 loc) · 14 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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
package io.sentry;
import io.sentry.protocol.ViewHierarchy;
import java.io.File;
import java.util.concurrent.Callable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** You can use an attachment to store additional files alongside an event or transaction. */
public final class Attachment {
private @Nullable byte[] bytes;
private final @Nullable JsonSerializable serializable;
private final @Nullable Callable<byte[]> byteProvider;
private @Nullable String pathname;
private final @NotNull String filename;
private final @Nullable String contentType;
private final boolean addToTransactions;
/** The special type of this attachment */
private @Nullable String attachmentType = DEFAULT_ATTACHMENT_TYPE;
/** A standard attachment without special meaning */
private static final String DEFAULT_ATTACHMENT_TYPE = "event.attachment";
private static final String VIEW_HIERARCHY_ATTACHMENT_TYPE = "event.view_hierarchy";
/**
* Initializes an Attachment with bytes and a filename. Sets addToTransaction to <code>false
* </code>.
*
* @param bytes The bytes of file.
* @param filename The name of the attachment to display in Sentry.
*/
public Attachment(final @NotNull byte[] bytes, final @NotNull String filename) {
this(bytes, filename, null);
}
/**
* Initializes an Attachment with bytes, a filename, and a content type. Sets addToTransaction to
* <code>false</code>.
*
* @param bytes The bytes of file.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
*/
public Attachment(
final @NotNull byte[] bytes,
final @NotNull String filename,
final @Nullable String contentType) {
this(bytes, filename, contentType, false);
}
/**
* Initializes an Attachment with bytes, a filename, a content type, and addToTransactions.
*
* @param bytes The bytes of file.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull byte[] bytes,
final @NotNull String filename,
final @Nullable String contentType,
final boolean addToTransactions) {
this(bytes, filename, contentType, DEFAULT_ATTACHMENT_TYPE, addToTransactions);
}
/**
* Initializes an Attachment with bytes, a filename, a content type, and addToTransactions.
*
* @param bytes The bytes of file.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param attachmentType the attachment type.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull byte[] bytes,
final @NotNull String filename,
final @Nullable String contentType,
final @Nullable String attachmentType,
final boolean addToTransactions) {
this.bytes = bytes;
this.serializable = null;
this.byteProvider = null;
this.filename = filename;
this.contentType = contentType;
this.attachmentType = attachmentType;
this.addToTransactions = addToTransactions;
}
/**
* Initializes an Attachment with bytes factory, a filename, a content type, and
* addToTransactions.
*
* @param serializable A json serializable holding the attachment payload
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param attachmentType the attachment type.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull JsonSerializable serializable,
final @NotNull String filename,
final @Nullable String contentType,
final @Nullable String attachmentType,
final boolean addToTransactions) {
this.bytes = null;
this.serializable = serializable;
this.byteProvider = null;
this.filename = filename;
this.contentType = contentType;
this.attachmentType = attachmentType;
this.addToTransactions = addToTransactions;
}
/**
* Initializes an Attachment with bytes factory, a filename, a content type, and
* addToTransactions.
*
* @param byteProvider A provider holding the attachment payload
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param attachmentType the attachment type.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull Callable<byte[]> byteProvider,
final @NotNull String filename,
final @Nullable String contentType,
final @Nullable String attachmentType,
final boolean addToTransactions) {
this.bytes = null;
this.serializable = null;
this.byteProvider = byteProvider;
this.filename = filename;
this.contentType = contentType;
this.attachmentType = attachmentType;
this.addToTransactions = addToTransactions;
}
/**
* Initializes an Attachment with a path. The filename of the file located at the path is used.
* Sets addToTransaction to <code>false</code>.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
*/
public Attachment(final @NotNull String pathname) {
this(pathname, new File(pathname).getName());
}
/**
* Initializes an Attachment with a path and a filename. Sets addToTransaction to <code>false
* </code>.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
* @param filename The name of the attachment to display in Sentry.
*/
public Attachment(final @NotNull String pathname, final @NotNull String filename) {
this(pathname, filename, null);
}
/**
* Initializes an Attachment with a path, a filename, and a content type. Sets addToTransaction to
* <code>false</code>.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
*/
public Attachment(
final @NotNull String pathname,
final @NotNull String filename,
final @Nullable String contentType) {
this(pathname, filename, contentType, DEFAULT_ATTACHMENT_TYPE, false);
}
/**
* Initializes an Attachment with a path, a filename, a content type, and addToTransactions.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param attachmentType The attachment type.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull String pathname,
final @NotNull String filename,
final @Nullable String contentType,
final @Nullable String attachmentType,
final boolean addToTransactions) {
this.pathname = pathname;
this.filename = filename;
this.serializable = null;
this.byteProvider = null;
this.contentType = contentType;
this.attachmentType = attachmentType;
this.addToTransactions = addToTransactions;
}
/**
* Initializes an Attachment with a path, a filename, a content type, and addToTransactions.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
*/
public Attachment(
final @NotNull String pathname,
final @NotNull String filename,
final @Nullable String contentType,
final boolean addToTransactions) {
this.pathname = pathname;
this.filename = filename;
this.serializable = null;
this.byteProvider = null;
this.contentType = contentType;
this.addToTransactions = addToTransactions;
}
/**
* Initializes an Attachment with a path, a filename, a content type, addToTransactions, and
* attachmentType.
*
* <p>The file located at the pathname is read lazily when the SDK captures an event or
* transaction not when the attachment is initialized. The pathname string is converted into an
* abstract pathname before reading the file.
*
* @param pathname The pathname string of the file to upload as an attachment.
* @param filename The name of the attachment to display in Sentry.
* @param contentType The content type of the attachment.
* @param addToTransactions <code>true</code> if the SDK should add this attachment to every
* {@link ITransaction} or set to <code>false</code> if it shouldn't.
* @param attachmentType The content type of the attachment.
*/
public Attachment(
final @NotNull String pathname,
final @NotNull String filename,
final @Nullable String contentType,
final boolean addToTransactions,
final @Nullable String attachmentType) {
this.pathname = pathname;
this.filename = filename;
this.serializable = null;
this.byteProvider = null;
this.contentType = contentType;
this.addToTransactions = addToTransactions;
this.attachmentType = attachmentType;
}
/**
* Gets the bytes of the attachment.
*
* @return the bytes.
*/
public @Nullable byte[] getBytes() {
return bytes;
}
/**
* Provides the bytes of the attachment.
*
* @return the bytes factory responsible for providing the bytes.
*/
public @Nullable JsonSerializable getSerializable() {
return serializable;
}
/**
* Gets the pathname string of the attachment.
*
* @return the pathname string.
*/
public @Nullable String getPathname() {
return pathname;
}
/**
* Gets the name of the attachment to display in Sentry.
*
* @return the filename.
*/
public @NotNull String getFilename() {
return filename;
}
/**
* Gets the content type of the attachment. The server infers "application/octet-stream" if not
* set.
*
* @return the content type or null if not set.
*/
public @Nullable String getContentType() {
return contentType;
}
/**
* Returns <code>true</code> if the SDK should add this attachment to every {@link ITransaction}
* and <code>false</code> if it shouldn't. Default is <code>false</code>.
*
* @return <code>true</code> if attachment should be added to every {@link ITransaction}.
*/
boolean isAddToTransactions() {
return addToTransactions;
}
/**
* Returns the attachmentType type
*
* @return the attachmentType
*/
public @Nullable String getAttachmentType() {
return attachmentType;
}
public @Nullable Callable<byte[]> getByteProvider() {
return byteProvider;
}
/**
* Creates a new Screenshot Attachment
*
* @param screenshotBytes the array bytes of the PNG screenshot
* @return the Attachment
*/
public static @NotNull Attachment fromScreenshot(final byte[] screenshotBytes) {
return new Attachment(screenshotBytes, "screenshot.png", "image/png", false);
}
/**
* Creates a new Screenshot Attachment
*
* @param provider the mechanism providing the screenshot payload
* @return the Attachment
*/
public static @NotNull Attachment fromByteProvider(
final @NotNull Callable<byte[]> provider,
final @NotNull String filename,
final @Nullable String contentType,
final boolean addToTransactions) {
return new Attachment(
provider, filename, contentType, DEFAULT_ATTACHMENT_TYPE, addToTransactions);
}
/**
* Creates a new View Hierarchy Attachment
*
* @param viewHierarchy the View Hierarchy
* @return the Attachment
*/
public static @NotNull Attachment fromViewHierarchy(final ViewHierarchy viewHierarchy) {
return new Attachment(
viewHierarchy,
"view-hierarchy.json",
"application/json",
VIEW_HIERARCHY_ATTACHMENT_TYPE,
false);
}
/**
* Creates a new Thread Dump Attachment
*
* @param bytes the array bytes
* @return the Attachment
*/
public static @NotNull Attachment fromThreadDump(final byte[] bytes) {
return new Attachment(bytes, "thread-dump.txt", "text/plain", false);
}
}