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
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 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.openecomp.sdc.common.datastructure;
import static org.apache.commons.lang3.StringUtils.EMPTY;
import fj.F;
import fj.data.Either;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import org.apache.commons.lang3.math.NumberUtils;
import org.apache.commons.lang3.time.StopWatch;
import org.openecomp.sdc.common.log.enums.EcompErrorSeverity;
import org.openecomp.sdc.common.log.enums.EcompLoggerErrorCode;
import org.openecomp.sdc.common.log.wrappers.Logger;
/**
* Class For Functional interfaces And Functional Methods
*
* @author mshitrit
*/
public class FunctionalInterfaces {
private static final int DEFAULT_REDO_INTERVAL_TIME_MS = 50;
private static final int DEFAULT_MAX_WAIT_TIME_MS = 10000;
private static final Logger LOGGER = Logger.getLogger(FunctionalInterfaces.class.getName());
/**
* This is an interface of a List that implements Serializable
*
* @param <T>
* @author mshitrit
*/
public interface SerializableList<T> extends List<T>, Serializable {
}
/**
* @param <T1>
* @param <T2>
* @author mshitrit Consumer that takes two parameters
*/
public interface ConsumerTwoParam<T1, T2> {
/**
* Same Accept method, but takes two parameters
*
* @param t1
* @param t2
*/
void accept(T1 t1, T2 t2);
}
@FunctionalInterface
public interface ConsumerThreeParam<T1, T2, T3> {
/**
* Same Accept method, but takes three parameters
*
* @param t1
* @param t2
* @param t3
*/
void accept(T1 t1, T2 t2, T3 t3);
}
@FunctionalInterface
public interface ConsumerFourParam<T1, T2, T3, T4> {
/**
* Same Accept method, but takes four parameters
*
* @param t1
* @param t2
* @param t3
* @param t4
*/
void accept(T1 t1, T2 t2, T3 t3, T4 t4);
}
/**
* @param <T1>
* @param <T2>
* @param <R>
* @author mshitrit Function that takes two parameters
*/
public interface FunctionTwoParam<T1, T2, R> {
/**
* Same apply method, but takes two parameters
*
* @param t1
* @param t2
* @return
*/
R apply(T1 t1, T2 t2);
}
/**
* @param <T>
* @param <R>
* @param <E>
* @author mshitrit Function that throws an exception
*/
public interface FunctionThrows<T, R, E extends Exception> {
/**
* Same apply method, but throws an exception
*
* @param t
* @return
*/
R apply(T t) throws E;
}
public interface FunctionTwoParamThrows<T1, T2, R, E extends Exception> {
/**
* Same apply method, but throws an exception
*
* @param t1
* @param t2
* @return
*/
R apply(T1 t1, T2 t2) throws E;
}
/**
* @param <R>
* @param <E>
* @author mshitrit Supplier that throws an exception
*/
public interface SupplierThrows<R, E extends Exception> {
/**
* Same get method, but throws an exception
*
* @return
* @throws E
*/
R get() throws E;
}
/**
* @param <T>
* @param <E>
* @author mshitrit Consumer that throws an exception
*/
public interface ConsumerThrows<T, E extends Exception> {
/**
* Same accept, but throws an exception
*
* @param t
* @throws E
*/
void accept(T t) throws E;
}
/**
* @param <E>
* @author mshitrit Runnable that throws an exception
*/
public interface RunnableThrows<E extends Exception> {
/**
* Same run, but throws an exception
*
* @throws E
*/
void run() throws E;
}
/**
* Runs a method that declares throwing an Exception and has a return value.
* <br>
* In case Exception Occurred replaces it with FunctionalAttException. <br> This is useful for two cases:<br> 1.using methods that throws
* exceptions in streams.<br> 2.replacing declared exception with undeclared exception (Runtime).<br> See below Use Case:<br> Instead of:
* intList.stream().map(e -> fooThrowsAndReturnsBoolean(e)); - does not compile !<br> Use This : intList.stream().map(e -> swallowException( () ->
* fooThrowsAndReturnsBoolean(e))); - compiles !<br>
*
* @param methodToRun
* @return
*/
public static <R, E extends Exception> R swallowException(SupplierThrows<R, E> methodToRun) {
try {
return methodToRun.get();
} catch (Exception e) {
throw new FunctionalAttException(e);
}
}
/**
* Runs a method that declares throwing an Exception without return value.
* <br>
* In case Exception Occurred replaces it with FunctionalAttException. <br> This is useful for two cases:<br> 1.using methods that throws
* exceptions in streams.<br> 2.replacing declared exception with undeclared exception (Runtime).<br> See below Use Case:<br>
*
* @param methodToRun
*/
public static <E extends Exception> void swallowException(RunnableThrows<E> methodToRun) {
SupplierThrows<Boolean, E> runnableWrapper = () -> {
methodToRun.run();
return true;
};
swallowException(runnableWrapper);
}
private static class FunctionalAttException extends RuntimeException {
private static final long serialVersionUID = 1L;
private FunctionalAttException(Exception e) {
super(e);
}
}
/**
* Runs the given method.<br> Verify the method result against the resultVerifier.<br> If verification passed returns the result.<br> If
* Verification failed keeps retrying until it passes or until 10 seconds pass.<br> If Exception Occurred keeps retrying until it passes or until
* 10 seconds pass,<br> If last retry result caused an exception - it is thrown.
*
* @param methodToRun given Method
* @param resultVerifier verifier for the method result
* @return
*/
public static <R> R retryMethodOnResult(Supplier<R> methodToRun, Function<R, Boolean> resultVerifier) {
return retryMethodOnResult(methodToRun, resultVerifier, DEFAULT_MAX_WAIT_TIME_MS, DEFAULT_REDO_INTERVAL_TIME_MS);
}
/**
* Runs the given method.<br> Verify the method result against the resultVerifier.<br> If verification passed returns the result.<br> If
* Verification failed keeps retrying until it passes or until maxWait pass.<br> If Exception Occurred keeps retrying until it passes or until
* maxWait pass,<br> If last retry result caused an exception - it is thrown.
*
* @param methodToRun given Method
* @param resultVerifier verifier for the method result
* @param maxWaitMS
* @param retryIntervalMS
* @return
*/
public static <R> R retryMethodOnResult(Supplier<R> methodToRun, Function<R, Boolean> resultVerifier, long maxWaitMS, long retryIntervalMS) {
boolean stopSearch = false;
R ret = null;
int timeElapsed = 0;
FunctionalAttException functionalExceotion = null;
boolean isExceptionInLastTry = false;
while (!stopSearch) {
try {
ret = methodToRun.get();
stopSearch = resultVerifier.apply(ret);
isExceptionInLastTry = false;
} catch (Exception e) {
functionalExceotion = new FunctionalAttException(e);
isExceptionInLastTry = true;
} finally {
sleep(retryIntervalMS);
timeElapsed += retryIntervalMS;
if (timeElapsed > maxWaitMS) {
stopSearch = true;
}
}
}
if (isExceptionInLastTry) {
throw functionalExceotion;
} else {
return ret;
}
}
/**
* Runs the given method.<br> Verify the method result against the resultVerifier.<br> If verification passed returns the result.<br> If
* Verification failed keeps retrying until maxRetries reached.<br> If Exception Occurred keeps retrying until it passes or until maxRetries
* reached,<br> If last retry result caused an exception - it is thrown.
*
* @param methodToRun given Method
* @param resultVerifier verifier for the method result
* @param maxRetries
* @return
*/
public static <R> R retryMethodOnResult(Supplier<R> methodToRun, Function<R, Boolean> resultVerifier, long maxRetries) {
boolean stopSearch = false;
R ret = null;
int retriesCount = 0;
FunctionalAttException functionalExceotion = null;
boolean isExceptionInLastTry = false;
while (!stopSearch) {
try {
ret = methodToRun.get();
stopSearch = resultVerifier.apply(ret);
isExceptionInLastTry = false;
} catch (Exception e) {
functionalExceotion = new FunctionalAttException(e);
isExceptionInLastTry = true;
} finally {
if (++retriesCount >= maxRetries) {
stopSearch = true;
}
}
}
if (isExceptionInLastTry) {
throw functionalExceotion;
} else {
return ret;
}
}
public static <R> R retryMethodOnException(SupplierThrows<R, Exception> methodToRun, Function<Exception, Boolean> exceptionVerifier,
long maxRetries) throws Exception {
boolean stopSearch = false;
R ret = null;
int retriesCount = 0;
Exception exception = null;
while (!stopSearch) {
try {
exception = null;
ret = methodToRun.get();
stopSearch = true;
} catch (Exception e) {
exception = e;
stopSearch = exceptionVerifier.apply(e);
} finally {
if (++retriesCount >= maxRetries) {
stopSearch = true;
}
}
}
if (exception != null) {
throw exception;
} else {
return ret;
}
}
/**
* Runs the given method.<br> In case exception occurred runs the method again either until succeed or until 10 seconds pass.
*
* @param methodToRun given method
* @return
*/
public static <R> R retryMethodOnException(Supplier<R> methodToRun) {
Function<R, Boolean> dummyVerifier = someResult -> true;
return retryMethodOnResult(methodToRun, dummyVerifier, DEFAULT_MAX_WAIT_TIME_MS, DEFAULT_REDO_INTERVAL_TIME_MS);
}
/**
* Runs the given method.<br> In case exception occurred runs the method again either until succeed or until 10 seconds pass.
*
* @param methodToRun given method
*/
public static void retryMethodOnException(Runnable methodToRun) {
Function<Boolean, Boolean> dummyVerifier = someResult -> true;
Supplier<Boolean> dummySupplier = () -> {
methodToRun.run();
return true;
};
retryMethodOnResult(dummySupplier, dummyVerifier, DEFAULT_MAX_WAIT_TIME_MS, DEFAULT_REDO_INTERVAL_TIME_MS);
}
/**
* Same as Thread.sleep but throws a FunctionalAttException (RuntimeException) instead of InterruptedException.<br>
*
* @param millis
*/
public static void sleep(long millis) {
swallowException(() -> Thread.sleep(millis));
}
/**
* Converts Either containing right value to another either with different type of left value and the same type of right value.
*
* @param eitherToConvert
* @return
*/
public static <T1, T2, T3> Either<T1, T2> convertEitherRight(Either<T3, T2> eitherToConvert) {
if (eitherToConvert.isLeft()) {
throw new UnsupportedOperationException("Can not convert either right value because it has left value");
} else {
return Either.right(eitherToConvert.right().value());
}
}
/**
* Converts Either containing left value to another either with different type of right value and the same type of left value.
*
* @param eitherToConvert
* @return
*/
public static <T1, T2, T3> Either<T1, T2> convertEitherLeft(Either<T1, T3> eitherToConvert) {
if (eitherToConvert.isLeft()) {
throw new UnsupportedOperationException("Can not convert either left value because it has right value");
} else {
return Either.left(eitherToConvert.left().value());
}
}
/**
* Returns enum value for a field <br>
*
* @param fieldValue
* @param values
* @param enumValueGetter
* @return
*/
public static <T extends Enum<T>> T getEnumValueByFieldValue(String fieldValue, T[] values, Function<T, String> enumValueGetter, T defaultValue) {
return getEnumValueByFieldValue(fieldValue, values, enumValueGetter, defaultValue, true);
}
public static <T extends Enum<T>> T getEnumValueByFieldValue(String fieldValue, T[] values, Function<T, String> enumValueGetter, T defaultValue,
boolean isCaseSensetive) {
final Predicate<? super T> predicate;
if (isCaseSensetive) {
predicate = e -> fieldValue.equals(enumValueGetter.apply(e));
} else {
predicate = e -> fieldValue.equalsIgnoreCase(enumValueGetter.apply(e));
}
Optional<T> optionalFound =
// Stream of values of enum
Arrays.asList(values).stream().
// Filter in the one that match the field
filter(predicate).
// collect
findAny();
T ret;
ret = optionalFound.isPresent() ? optionalFound.get() : defaultValue;
return ret;
}
/**
* This method runs the given method.<br> In case given method finished running within timeoutInMs limit it returns Either which left value is the
* result of the method that ran.<br> In case given method did not finish running within timeoutInMs limit it returns Either which right value is
* false. <br>
*
* @param supplier
* @param timeoutInMs - if 0 or lower no timeout is used
* @return
*/
public static <T> Either<T, Boolean> runMethodWithTimeOut(Supplier<T> supplier, long timeoutInMs) {
Either<T, Boolean> result;
if (timeoutInMs <= NumberUtils.LONG_ZERO) {
result = Either.left(supplier.get());
} else {
ExecutorService pool = Executors.newSingleThreadExecutor();
Future<T> future = pool.submit(supplier::get);
try {
T calcValue = future.get(timeoutInMs, TimeUnit.MILLISECONDS);
result = Either.left(calcValue);
} catch (InterruptedException e) {
LOGGER.debug("InterruptedException in runMethodWithTimeOut", e);
Thread.currentThread().interrupt();
result = Either.right(false);
} catch (ExecutionException | TimeoutException e) {
LOGGER.debug("method run was canceled because it has passed its time limit of {} MS", timeoutInMs, e);
result = Either.right(false);
} finally {
pool.shutdownNow();
}
}
return result;
}
public static <T> F<T, Boolean> convertToFunction(Consumer<T> consumer) {
return t -> {
try {
consumer.accept(t);
return true;
} catch (Exception e) {
return false;
}
};
}
/**
* Wraps the execution of the Runnable with try catch.<br> In case exception occurred returns Optional containing the resultOnException.<br>
* Otherwise returns an Empty optional.
*
* @param runnable
* @param resultOnException
* @return
*/
public static <T, E extends Exception> Optional<T> wrapWithTryCatch(RunnableThrows<E> runnable, T resultOnException) {
Optional<T> optionalError;
try {
runnable.run();
optionalError = Optional.empty();
} catch (Exception e) {
logException(e);
optionalError = Optional.of(resultOnException);
}
return optionalError;
}
/**
* Runs the given method.<br> In case the method passes without any Assertion Errors finishes.<br> In case there is an assertion error keeps
* running the method every retryIntervalMS.<br> until there is no Errors or maxWaitTimeMs has passed. <br> If there are still Assertion Errors
* in the last Run they are returned to the user.<br>
*
* @param methodToRun
* @param maxWaitTimeMs
* @param retryIntervalMS
*/
public static <T extends Throwable> void retryMethodOnException(Runnable methodToRun, long maxWaitTimeMs, long retryIntervalMS) {
if (maxWaitTimeMs <= 0) {
throw new UnsupportedOperationException("Number maxWaitTimeMs be greater than 0");
}
StopWatch watch = new StopWatch();
watch.start();
boolean isLastTry = false;
while (!isLastTry) {
isLastTry = watch.getTime() + retryIntervalMS > maxWaitTimeMs;
if (isLastTry) {
methodToRun.run();
} else {
try {
methodToRun.run();
break;
} catch (Exception e) {
wrapWithTryCatch(() -> Thread.sleep(retryIntervalMS));
}
}
}
}
/**
* Wraps the execution of the Runnable with try catch.<br> In case exception occurred logs the Exception.<br> resultOnException.<br> Otherwise
* returns an Empty optional.
*
* @param runnable
* @return
*/
public static <E extends Exception> void wrapWithTryCatch(RunnableThrows<E> runnable) {
wrapWithTryCatch(runnable, null);
}
private static void logException(Exception e) {
LOGGER.error(EcompErrorSeverity.ERROR, EcompLoggerErrorCode.BUSINESS_PROCESS_ERROR, EMPTY, EMPTY, EMPTY, EMPTY);
LOGGER.debug("Error was caught ", e);
}
}
|