-
-
Notifications
You must be signed in to change notification settings - Fork 468
Expand file tree
/
Copy pathIScope.java
More file actions
475 lines (403 loc) · 10.5 KB
/
IScope.java
File metadata and controls
475 lines (403 loc) · 10.5 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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
package io.sentry;
import io.sentry.featureflags.IFeatureFlagBuffer;
import io.sentry.internal.eventprocessor.EventProcessorAndOrder;
import io.sentry.protocol.Contexts;
import io.sentry.protocol.FeatureFlags;
import io.sentry.protocol.Request;
import io.sentry.protocol.SentryId;
import io.sentry.protocol.User;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
public interface IScope {
@Nullable
SentryLevel getLevel();
/**
* Sets the Scope's SentryLevel Level from scope exceptionally take precedence over the event
*
* @param level the SentryLevel
*/
void setLevel(final @Nullable SentryLevel level);
/**
* Returns the Scope's transaction name.
*
* @return the transaction
*/
@Nullable
String getTransactionName();
/**
* Sets the Scope's transaction.
*
* @param transaction the transaction
*/
void setTransaction(final @NotNull String transaction);
/**
* Returns current active Span or Transaction.
*
* @return current active Span or Transaction or null if transaction has not been set.
*/
@Nullable
ISpan getSpan();
@ApiStatus.Internal
void setActiveSpan(@Nullable ISpan span);
/**
* Sets the current active transaction
*
* @param transaction the transaction
*/
void setTransaction(final @Nullable ITransaction transaction);
/**
* Returns the Scope's user
*
* @return the user
*/
@Nullable
User getUser();
/**
* Sets the Scope's user
*
* @param user the user
*/
void setUser(final @Nullable User user);
/**
* Returns the Scope's current screen, previously set by {@link IScope#setScreen(String)}
*
* @return the name of the screen
*/
@ApiStatus.Internal
@Nullable
String getScreen();
/**
* Sets the Scope's current screen
*
* @param screen the name of the screen
*/
@ApiStatus.Internal
void setScreen(final @Nullable String screen);
/**
* Returns the Scope's current replay_id, previously set by {@link IScope#setReplayId(SentryId)}
*
* @return the id of the current session replay
*/
@ApiStatus.Internal
@NotNull
SentryId getReplayId();
/**
* Sets the Scope's current replay_id
*
* @param replayId the id of the current session replay
*/
@ApiStatus.Internal
void setReplayId(final @NotNull SentryId replayId);
/**
* Returns the Scope's request
*
* @return the request
*/
@Nullable
Request getRequest();
/**
* Sets the Scope's request
*
* @param request the request
*/
void setRequest(final @Nullable Request request);
/**
* Returns the Scope's fingerprint list
*
* @return the fingerprint list
*/
@ApiStatus.Internal
@NotNull
List<String> getFingerprint();
/**
* Sets the Scope's fingerprint list
*
* @param fingerprint the fingerprint list
*/
void setFingerprint(final @NotNull List<String> fingerprint);
/**
* Returns the Scope's breadcrumbs queue
*
* @return the breadcrumbs queue
*/
@ApiStatus.Internal
@NotNull
Queue<Breadcrumb> getBreadcrumbs();
/**
* Adds a breadcrumb to the breadcrumbs queue. It also executes the BeforeBreadcrumb callback if
* set
*
* @param breadcrumb the breadcrumb
* @param hint the hint
*/
void addBreadcrumb(@NotNull Breadcrumb breadcrumb, @Nullable Hint hint);
/**
* Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if
* set
*
* @param breadcrumb the breadcrumb
*/
void addBreadcrumb(final @NotNull Breadcrumb breadcrumb);
/** Clear all the breadcrumbs */
void clearBreadcrumbs();
/** Clears the transaction. */
void clearTransaction();
/**
* Returns active transaction or null if there is no active transaction.
*
* @return the transaction
*/
@Nullable
ITransaction getTransaction();
/** Resets the Scope to its default state */
void clear();
/**
* Returns the Scope's tags
*
* @return the tags map
*/
@ApiStatus.Internal
@SuppressWarnings("NullAway") // tags are never null
@NotNull
Map<String, String> getTags();
/**
* Sets a tag to Scope's tags
*
* @param key the key
* @param value the value
*/
void setTag(final @Nullable String key, final @Nullable String value);
/**
* Removes a tag from the Scope's tags
*
* @param key the key
*/
void removeTag(final @Nullable String key);
/**
* Returns the Scope's extra map
*
* @return the extra map
*/
@ApiStatus.Internal
@NotNull
Map<String, Object> getExtras();
/**
* Sets an extra to the Scope's extra map
*
* @param key the key
* @param value the value
*/
void setExtra(final @Nullable String key, final @Nullable String value);
/**
* Removes an extra from the Scope's extras
*
* @param key the key
*/
void removeExtra(final @Nullable String key);
/**
* Returns the Scope's contexts
*
* @return the contexts
*/
@NotNull
Contexts getContexts();
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Object value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Boolean value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable String value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Number value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Collection<?> value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Object[] value);
/**
* Sets the Scope's contexts
*
* @param key the context key
* @param value the context value
*/
void setContexts(final @Nullable String key, final @Nullable Character value);
/**
* Removes a value from the Scope's contexts
*
* @param key the Key
*/
void removeContexts(final @Nullable String key);
/**
* Returns the Scopes's attachments
*
* @return the attachments
*/
@NotNull
List<Attachment> getAttachments();
/**
* Adds an attachment to the Scope's list of attachments. The SDK adds the attachment to every
* event and transaction sent to Sentry.
*
* @param attachment The attachment to add to the Scope's list of attachments.
*/
void addAttachment(final @NotNull Attachment attachment);
/** Clear all attachments. */
void clearAttachments();
/**
* Returns the Scope's event processors
*
* @return the event processors list
*/
@ApiStatus.Internal
@NotNull
List<EventProcessor> getEventProcessors();
@ApiStatus.Internal
@NotNull
List<EventProcessorAndOrder> getEventProcessorsWithOrder();
/**
* Adds an event processor to the Scope's event processors list
*
* @param eventProcessor the event processor
*/
void addEventProcessor(final @NotNull EventProcessor eventProcessor);
/**
* Callback to do atomic operations on session
*
* @param sessionCallback the IWithSession callback
* @return a clone of the Session after executing the callback and mutating the session
*/
@Nullable
Session withSession(final @NotNull Scope.IWithSession sessionCallback);
/**
* Returns a previous session (now closed) bound to this scope together with the newly created one
*
* @return the SessionPair with the previous closed session if exists and the current session
*/
@Nullable
Scope.SessionPair startSession();
/**
* Ends a session, unbinds it from the scope and returns it.
*
* @return the previous session
*/
@Nullable
Session endSession();
/**
* Mutates the current transaction atomically
*
* @param callback the IWithTransaction callback
*/
@ApiStatus.Internal
void withTransaction(final @NotNull Scope.IWithTransaction callback);
@NotNull
SentryOptions getOptions();
@ApiStatus.Internal
@Nullable
Session getSession();
@ApiStatus.Internal
void clearSession();
@ApiStatus.Internal
void setPropagationContext(final @NotNull PropagationContext propagationContext);
@ApiStatus.Internal
@NotNull
PropagationContext getPropagationContext();
@ApiStatus.Internal
@NotNull
PropagationContext withPropagationContext(final @NotNull Scope.IWithPropagationContext callback);
/**
* Clones the Scope
*
* @return the cloned Scope
*/
@NotNull
IScope clone();
void setLastEventId(final @NotNull SentryId lastEventId);
@NotNull
SentryId getLastEventId();
void bindClient(final @NotNull ISentryClient client);
@NotNull
ISentryClient getClient();
@ApiStatus.Internal
void assignTraceContext(final @NotNull SentryEvent event);
@ApiStatus.Internal
void setSpanContext(
final @NotNull Throwable throwable,
final @NotNull ISpan span,
final @NotNull String transactionName);
@ApiStatus.Internal
void replaceOptions(final @NotNull SentryOptions options);
/**
* Sets an attribute on the Scope.
*
* @param key the key
* @param value the value
*/
void setAttribute(final @Nullable String key, final @Nullable Object value);
/**
* Sets an attribute on the Scope.
*
* @param attribute the attribute
*/
void setAttribute(final @Nullable SentryAttribute attribute);
/**
* Sets multiple attributes on the Scope.
*
* @param attributes the attributes
*/
void setAttributes(final @Nullable SentryAttributes attributes);
/**
* Removes an attribute from the Scope.
*
* @param key the key
*/
void removeAttribute(final @Nullable String key);
/**
* Returns the Scope's attributes
*
* @return the attributes map
*/
@ApiStatus.Internal
@NotNull
Map<String, SentryAttribute> getAttributes();
void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result);
@ApiStatus.Internal
@Nullable
FeatureFlags getFeatureFlags();
@ApiStatus.Internal
@NotNull
IFeatureFlagBuffer getFeatureFlagBuffer();
}