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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actorserviceprovider.impl;
import java.time.Instant;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Function;
import lombok.Getter;
import org.onap.policy.controlloop.ControlLoopOperation;
import org.onap.policy.controlloop.actorserviceprovider.Operator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.policy.Policy;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Partial implementation of an operator. Subclasses can choose to simply implement
* {@link #doOperation(ControlLoopOperationParams)}, or they may choose to override
* {@link #doOperationAsFuture(ControlLoopOperationParams)}.
*/
public abstract class OperatorPartial extends StartConfigPartial<Map<String, Object>> implements Operator {
private static final Logger logger = LoggerFactory.getLogger(OperatorPartial.class);
private static final String OUTCOME_SUCCESS = PolicyResult.SUCCESS.toString();
private static final String OUTCOME_FAILURE = PolicyResult.FAILURE.toString();
private static final String OUTCOME_RETRIES = PolicyResult.FAILURE_RETRIES.toString();
@Getter
private final String actorName;
@Getter
private final String name;
/**
* Constructs the object.
*
* @param actorName name of the actor with which this operator is associated
* @param name operation name
*/
public OperatorPartial(String actorName, String name) {
super(actorName + "." + name);
this.actorName = actorName;
this.name = name;
}
/**
* This method does nothing.
*/
@Override
protected void doConfigure(Map<String, Object> parameters) {
// do nothing
}
/**
* This method does nothing.
*/
@Override
protected void doStart() {
// do nothing
}
/**
* This method does nothing.
*/
@Override
protected void doStop() {
// do nothing
}
/**
* This method does nothing.
*/
@Override
protected void doShutdown() {
// do nothing
}
@Override
public final CompletableFuture<ControlLoopOperation> startOperation(ControlLoopOperationParams params) {
if (!isAlive()) {
throw new IllegalStateException("operation is not running: " + getFullName());
}
final Executor executor = params.getExecutor();
// allocate a controller for the entire operation
final PipelineControllerFuture<ControlLoopOperation> controller = new PipelineControllerFuture<>();
CompletableFuture<ControlLoopOperation> preproc = startPreprocessor(params);
if (preproc == null) {
// no preprocessor required - just start the operation
return startOperationAttempt(params, controller, 1);
}
// propagate "stop" to the preprocessor
controller.add(preproc);
/*
* Do preprocessor first and then, if successful, start the operation. Note:
* operations create their own outcome, ignoring the outcome from any previous
* steps.
*/
preproc.whenCompleteAsync(controller.delayedRemove(preproc), executor)
.thenComposeAsync(handleFailure(params, controller), executor)
.thenComposeAsync(onSuccess(params, unused -> startOperationAttempt(params, controller, 1)),
executor);
return controller;
}
/**
* Starts an operation's preprocessor step(s). If the preprocessor fails, then it
* invokes the started and completed call-backs.
*
* @param params operation parameters
* @return a future that will return the preprocessor outcome, or {@code null} if this
* operation needs no preprocessor
*/
protected CompletableFuture<ControlLoopOperation> startPreprocessor(ControlLoopOperationParams params) {
logger.info("{}: start low-level operation preprocessor for {}", getFullName(), params.getRequestId());
final Executor executor = params.getExecutor();
final ControlLoopOperation operation = params.makeOutcome();
final Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> preproc =
doPreprocessorAsFuture(params);
if (preproc == null) {
// no preprocessor required
return null;
}
// allocate a controller for the preprocessor steps
final PipelineControllerFuture<ControlLoopOperation> controller = new PipelineControllerFuture<>();
/*
* Don't mark it complete until we've built the whole pipeline. This will prevent
* the operation from starting until after it has been successfully built (i.e.,
* without generating any exceptions).
*/
final CompletableFuture<ControlLoopOperation> firstFuture = new CompletableFuture<>();
// @formatter:off
firstFuture
.thenComposeAsync(controller.add(preproc), executor)
.exceptionally(fromException(params, operation))
.whenCompleteAsync(controller.delayedComplete(), executor);
// @formatter:on
// start the pipeline
firstFuture.complete(operation);
return controller;
}
/**
* Handles a failure in the preprocessor pipeline. If a failure occurred, then it
* invokes the call-backs and returns a failed outcome. Otherwise, it returns the
* outcome that it received.
*
* @param params operation parameters
* @param controller pipeline controller
* @return a function that checks the outcome status and continues, if successful, or
* indicates a failure otherwise
*/
private Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> handleFailure(
ControlLoopOperationParams params, PipelineControllerFuture<ControlLoopOperation> controller) {
return outcome -> {
if (outcome != null && isSuccess(outcome)) {
logger.trace("{}: preprocessor succeeded for {}", getFullName(), params.getRequestId());
return CompletableFuture.completedFuture(outcome);
}
logger.warn("preprocessor failed, discontinuing operation {} for {}", getFullName(), params.getRequestId());
final Executor executor = params.getExecutor();
final CallbackManager callbacks = new CallbackManager();
// propagate "stop" to the callbacks
controller.add(callbacks);
final ControlLoopOperation outcome2 = params.makeOutcome();
// TODO need a FAILURE_MISSING_DATA (e.g., A&AI)
outcome2.setOutcome(PolicyResult.FAILURE_GUARD.toString());
outcome2.setMessage(outcome != null ? outcome.getMessage() : null);
CompletableFuture.completedFuture(outcome2).thenApplyAsync(callbackStarted(params, callbacks), executor)
.thenApplyAsync(callbackCompleted(params, callbacks), executor)
.whenCompleteAsync(controller.delayedRemove(callbacks), executor)
.whenCompleteAsync(controller.delayedComplete(), executor);
return controller;
};
}
/**
* Invokes the operation's preprocessor step(s) as a "future". This method simply
* returns {@code null}.
* <p/>
* This method assumes the following:
* <ul>
* <li>the operator is alive</li>
* <li>exceptions generated within the pipeline will be handled by the invoker</li>
* </ul>
*
* @param params operation parameters
* @return a function that will start the preprocessor and returns its outcome, or
* {@code null} if this operation needs no preprocessor
*/
protected Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> doPreprocessorAsFuture(
ControlLoopOperationParams params) {
return null;
}
/**
* Starts the operation attempt, with no preprocessor. When all retries complete, it
* will complete the controller.
*
* @param params operation parameters
* @param controller controller for all operation attempts
* @param attempt attempt number, typically starting with 1
* @return a future that will return the final result of all attempts
*/
private CompletableFuture<ControlLoopOperation> startOperationAttempt(ControlLoopOperationParams params,
PipelineControllerFuture<ControlLoopOperation> controller, int attempt) {
final Executor executor = params.getExecutor();
CompletableFuture<ControlLoopOperation> future = startAttemptWithoutRetries(params, attempt);
// propagate "stop" to the operation attempt
controller.add(future);
// detach when complete
future.whenCompleteAsync(controller.delayedRemove(future), executor)
.thenComposeAsync(retryOnFailure(params, controller, attempt), params.getExecutor())
.whenCompleteAsync(controller.delayedComplete(), executor);
return controller;
}
/**
* Starts the operation attempt, without doing any retries.
*
* @param params operation parameters
* @param attempt attempt number, typically starting with 1
* @return a future that will return the result of a single operation attempt
*/
private CompletableFuture<ControlLoopOperation> startAttemptWithoutRetries(ControlLoopOperationParams params,
int attempt) {
logger.info("{}: start operation attempt {} for {}", getFullName(), attempt, params.getRequestId());
final Executor executor = params.getExecutor();
final ControlLoopOperation outcome = params.makeOutcome();
final CallbackManager callbacks = new CallbackManager();
// this operation attempt gets its own controller
final PipelineControllerFuture<ControlLoopOperation> controller = new PipelineControllerFuture<>();
// propagate "stop" to the callbacks
controller.add(callbacks);
/*
* Don't mark it complete until we've built the whole pipeline. This will prevent
* the operation from starting until after it has been successfully built (i.e.,
* without generating any exceptions).
*/
final CompletableFuture<ControlLoopOperation> firstFuture = new CompletableFuture<>();
// @formatter:off
CompletableFuture<ControlLoopOperation> future2 =
firstFuture.thenComposeAsync(verifyRunning(controller, params), executor)
.thenApplyAsync(callbackStarted(params, callbacks), executor)
.thenComposeAsync(controller.add(doOperationAsFuture(params, attempt)), executor);
// @formatter:on
// handle timeouts, if specified
long timeoutMillis = getTimeOutMillis(params.getPolicy());
if (timeoutMillis > 0) {
logger.info("{}: set timeout to {}ms for {}", getFullName(), timeoutMillis, params.getRequestId());
future2 = future2.orTimeout(timeoutMillis, TimeUnit.MILLISECONDS);
}
/*
* Note: we re-invoke callbackStarted() just to be sure the callback is invoked
* before callbackCompleted() is invoked.
*
* Note: no need to remove "callbacks" from the pipeline, as we're going to stop
* the pipeline as the last step anyway.
*/
// @formatter:off
future2.exceptionally(fromException(params, outcome))
.thenApplyAsync(setRetryFlag(params, attempt), executor)
.thenApplyAsync(callbackStarted(params, callbacks), executor)
.thenApplyAsync(callbackCompleted(params, callbacks), executor)
.whenCompleteAsync(controller.delayedComplete(), executor);
// @formatter:on
// start the pipeline
firstFuture.complete(outcome);
return controller;
}
/**
* Determines if the outcome was successful.
*
* @param outcome outcome to examine
* @return {@code true} if the outcome was successful
*/
protected boolean isSuccess(ControlLoopOperation outcome) {
return OUTCOME_SUCCESS.equals(outcome.getOutcome());
}
/**
* Determines if the outcome was a failure for this operator.
*
* @param outcome outcome to examine, or {@code null}
* @return {@code true} if the outcome is not {@code null} and was a failure
* <i>and</i> was associated with this operator, {@code false} otherwise
*/
protected boolean isActorFailed(ControlLoopOperation outcome) {
return OUTCOME_FAILURE.equals(getActorOutcome(outcome));
}
/**
* Invokes the operation as a "future". This method simply invokes
* {@link #doOperation(ControlLoopOperationParams)} turning it into a "future".
* <p/>
* This method assumes the following:
* <ul>
* <li>the operator is alive</li>
* <li>verifyRunning() has been invoked</li>
* <li>callbackStarted() has been invoked</li>
* <li>the invoker will perform appropriate timeout checks</li>
* <li>exceptions generated within the pipeline will be handled by the invoker</li>
* </ul>
*
* @param params operation parameters
* @param attempt attempt number, typically starting with 1
* @return a function that will start the operation and return its result when
* complete
*/
protected Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> doOperationAsFuture(
ControlLoopOperationParams params, int attempt) {
/*
* TODO As doOperation() may perform blocking I/O, this should be launched in its
* own thread to prevent the ForkJoinPool from being tied up. Should probably
* provide a method to make that easy.
*/
return operation -> CompletableFuture.supplyAsync(() -> doOperation(params, attempt, operation),
params.getExecutor());
}
/**
* Low-level method that performs the operation. This can make the same assumptions
* that are made by {@link #doOperationAsFuture(ControlLoopOperationParams)}. This
* method throws an {@link UnsupportedOperationException}.
*
* @param params operation parameters
* @param attempt attempt number, typically starting with 1
* @param operation the operation being performed
* @return the outcome of the operation
*/
protected ControlLoopOperation doOperation(ControlLoopOperationParams params, int attempt,
ControlLoopOperation operation) {
throw new UnsupportedOperationException("start operation " + getFullName());
}
/**
* Sets the outcome status to FAILURE_RETRIES, if the current operation outcome is
* FAILURE, assuming the policy specifies retries and the retry count has been
* exhausted.
*
* @param params operation parameters
* @param attempt latest attempt number, starting with 1
* @return a function to get the next future to execute
*/
private Function<ControlLoopOperation, ControlLoopOperation> setRetryFlag(ControlLoopOperationParams params,
int attempt) {
return operation -> {
if (operation != null && !isActorFailed(operation)) {
/*
* wrong type or wrong operation - just leave it as is. No need to log
* anything here, as retryOnFailure() will log a message
*/
return operation;
}
// get a non-null operation
ControlLoopOperation oper2;
if (operation != null) {
oper2 = operation;
} else {
oper2 = params.makeOutcome();
oper2.setOutcome(OUTCOME_FAILURE);
}
if (params.getPolicy().getRetry() != null && params.getPolicy().getRetry() > 0
&& attempt > params.getPolicy().getRetry()) {
/*
* retries were specified and we've already tried them all - change to
* FAILURE_RETRIES
*/
logger.info("operation {} retries exhausted for {}", getFullName(), params.getRequestId());
oper2.setOutcome(OUTCOME_RETRIES);
}
return oper2;
};
}
/**
* Restarts the operation if it was a FAILURE. Assumes that
* {@link #setRetryFlag(ControlLoopOperationParams, int)} was previously invoked, and
* thus that the "operation" is not {@code null}.
*
* @param params operation parameters
* @param controller controller for all of the retries
* @param attempt latest attempt number, starting with 1
* @return a function to get the next future to execute
*/
private Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> retryOnFailure(
ControlLoopOperationParams params, PipelineControllerFuture<ControlLoopOperation> controller,
int attempt) {
return operation -> {
if (!isActorFailed(operation)) {
// wrong type or wrong operation - just leave it as is
logger.trace("not retrying operation {} for {}", getFullName(), params.getRequestId());
return CompletableFuture.completedFuture(operation);
}
if (params.getPolicy().getRetry() == null || params.getPolicy().getRetry() <= 0) {
// no retries - already marked as FAILURE, so just return it
logger.info("operation {} no retries for {}", getFullName(), params.getRequestId());
return CompletableFuture.completedFuture(operation);
}
/*
* Retry the operation.
*/
logger.info("retry operation {} for {}", getFullName(), params.getRequestId());
return startOperationAttempt(params, controller, attempt + 1);
};
}
/**
* Gets the outcome of an operation for this operation.
*
* @param operation operation whose outcome is to be extracted
* @return the outcome of the given operation, if it's for this operator, {@code null}
* otherwise
*/
protected String getActorOutcome(ControlLoopOperation operation) {
if (operation == null) {
return null;
}
if (!getActorName().equals(operation.getActor())) {
return null;
}
if (!getName().equals(operation.getOperation())) {
return null;
}
return operation.getOutcome();
}
/**
* Gets a function that will start the next step, if the current operation was
* successful, or just return the current operation, otherwise.
*
* @param params operation parameters
* @param nextStep function that will invoke the next step, passing it the operation
* @return a function that will start the next step
*/
protected Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> onSuccess(
ControlLoopOperationParams params,
Function<ControlLoopOperation, CompletableFuture<ControlLoopOperation>> nextStep) {
return operation -> {
if (operation == null) {
logger.trace("{}: null outcome - discarding next task for {}", getFullName(), params.getRequestId());
ControlLoopOperation outcome = params.makeOutcome();
outcome.setOutcome(OUTCOME_FAILURE);
return CompletableFuture.completedFuture(outcome);
} else if (isSuccess(operation)) {
logger.trace("{}: success - starting next task for {}", getFullName(), params.getRequestId());
return nextStep.apply(operation);
} else {
logger.trace("{}: failure - discarding next task for {}", getFullName(), params.getRequestId());
return CompletableFuture.completedFuture(operation);
}
};
}
/**
* Converts an exception into an operation outcome, returning a copy of the outcome to
* prevent background jobs from changing it.
*
* @param params operation parameters
* @param operation current operation
* @return a function that will convert an exception into an operation outcome
*/
private Function<Throwable, ControlLoopOperation> fromException(ControlLoopOperationParams params,
ControlLoopOperation operation) {
return thrown -> {
logger.warn("exception throw by operation {}.{} for {}", operation.getActor(), operation.getOperation(),
params.getRequestId(), thrown);
/*
* Must make a copy of the operation, as the original could be changed by
* background jobs that might still be running.
*/
return setOutcome(params, new ControlLoopOperation(operation), thrown);
};
}
/**
* Gets a function to verify that the operation is still running. If the pipeline is
* not running, then it returns an incomplete future, which will effectively halt
* subsequent operations in the pipeline. This method is intended to be used with one
* of the {@link CompletableFuture}'s <i>thenCompose()</i> methods.
*
* @param controller pipeline controller
* @param params operation parameters
* @return a function to verify that the operation is still running
*/
protected <T> Function<T, CompletableFuture<T>> verifyRunning(
PipelineControllerFuture<ControlLoopOperation> controller, ControlLoopOperationParams params) {
return value -> {
boolean running = controller.isRunning();
logger.trace("{}: verify running {} for {}", getFullName(), running, params.getRequestId());
return (running ? CompletableFuture.completedFuture(value) : new CompletableFuture<>());
};
}
/**
* Sets the start time of the operation and invokes the callback to indicate that the
* operation has started. Does nothing if the pipeline has been stopped.
* <p/>
* This assumes that the "outcome" is not {@code null}.
*
* @param params operation parameters
* @param callbacks used to determine if the start callback can be invoked
* @return a function that sets the start time and invokes the callback
*/
private Function<ControlLoopOperation, ControlLoopOperation> callbackStarted(ControlLoopOperationParams params,
CallbackManager callbacks) {
return outcome -> {
if (callbacks.canStart()) {
// haven't invoked "start" callback yet
outcome.setStart(callbacks.getStartTime());
outcome.setEnd(null);
params.callbackStarted(outcome);
}
return outcome;
};
}
/**
* Sets the end time of the operation and invokes the callback to indicate that the
* operation has completed. Does nothing if the pipeline has been stopped.
* <p/>
* This assumes that the "outcome" is not {@code null}.
* <p/>
* Note: the start time must be a reference rather than a plain value, because it's
* value must be gotten on-demand, when the returned function is executed at a later
* time.
*
* @param params operation parameters
* @param callbacks used to determine if the end callback can be invoked
* @return a function that sets the end time and invokes the callback
*/
private Function<ControlLoopOperation, ControlLoopOperation> callbackCompleted(ControlLoopOperationParams params,
CallbackManager callbacks) {
return operation -> {
if (callbacks.canEnd()) {
operation.setStart(callbacks.getStartTime());
operation.setEnd(callbacks.getEndTime());
params.callbackCompleted(operation);
}
return operation;
};
}
/**
* Sets an operation's outcome and message, based on a throwable.
*
* @param params operation parameters
* @param operation operation to be updated
* @return the updated operation
*/
protected ControlLoopOperation setOutcome(ControlLoopOperationParams params, ControlLoopOperation operation,
Throwable thrown) {
PolicyResult result = (isTimeout(thrown) ? PolicyResult.FAILURE_TIMEOUT : PolicyResult.FAILURE_EXCEPTION);
return setOutcome(params, operation, result);
}
/**
* Sets an operation's outcome and default message based on the result.
*
* @param params operation parameters
* @param operation operation to be updated
* @param result result of the operation
* @return the updated operation
*/
protected ControlLoopOperation setOutcome(ControlLoopOperationParams params, ControlLoopOperation operation,
PolicyResult result) {
logger.trace("{}: set outcome {} for {}", getFullName(), result, params.getRequestId());
operation.setOutcome(result.toString());
operation.setMessage(result == PolicyResult.SUCCESS ? ControlLoopOperation.SUCCESS_MSG
: ControlLoopOperation.FAILED_MSG);
return operation;
}
/**
* Determines if a throwable is due to a timeout.
*
* @param thrown throwable of interest
* @return {@code true} if the throwable is due to a timeout, {@code false} otherwise
*/
protected boolean isTimeout(Throwable thrown) {
if (thrown instanceof CompletionException) {
thrown = thrown.getCause();
}
return (thrown instanceof TimeoutException);
}
// these may be overridden by junit tests
/**
* Gets the operation timeout. Subclasses may override this method to obtain the
* timeout in some other way (e.g., through configuration properties).
*
* @param policy policy from which to extract the timeout
* @return the operation timeout, in milliseconds
*/
protected long getTimeOutMillis(Policy policy) {
Integer timeoutSec = policy.getTimeout();
return (timeoutSec == null ? 0 : TimeUnit.MILLISECONDS.convert(timeoutSec, TimeUnit.SECONDS));
}
/**
* Manager for "start" and "end" callbacks.
*/
private static class CallbackManager implements Runnable {
private final AtomicReference<Instant> startTime = new AtomicReference<>();
private final AtomicReference<Instant> endTime = new AtomicReference<>();
/**
* Determines if the "start" callback can be invoked. If so, it sets the
* {@link #startTime} to the current time.
*
* @return {@code true} if the "start" callback can be invoked, {@code false}
* otherwise
*/
public boolean canStart() {
return startTime.compareAndSet(null, Instant.now());
}
/**
* Determines if the "end" callback can be invoked. If so, it sets the
* {@link #endTime} to the current time.
*
* @return {@code true} if the "end" callback can be invoked, {@code false}
* otherwise
*/
public boolean canEnd() {
return endTime.compareAndSet(null, Instant.now());
}
/**
* Gets the start time.
*
* @return the start time, or {@code null} if {@link #canStart()} has not been
* invoked yet.
*/
public Instant getStartTime() {
return startTime.get();
}
/**
* Gets the end time.
*
* @return the end time, or {@code null} if {@link #canEnd()} has not been invoked
* yet.
*/
public Instant getEndTime() {
return endTime.get();
}
/**
* Prevents further callbacks from being executed by setting {@link #startTime}
* and {@link #endTime}.
*/
@Override
public void run() {
canStart();
canEnd();
}
}
}
|