| 1 |
/** |
| 2 |
* Copyright (c) 2012-2017, jcabi.com |
| 3 |
* All rights reserved. |
| 4 |
* |
| 5 |
* Redistribution and use in source and binary forms, with or without |
| 6 |
* modification, are permitted provided that the following conditions |
| 7 |
* are met: 1) Redistributions of source code must retain the above |
| 8 |
* copyright notice, this list of conditions and the following |
| 9 |
* disclaimer. 2) Redistributions in binary form must reproduce the above |
| 10 |
* copyright notice, this list of conditions and the following |
| 11 |
* disclaimer in the documentation and/or other materials provided |
| 12 |
* with the distribution. 3) Neither the name of the jcabi.com nor |
| 13 |
* the names of its contributors may be used to endorse or promote |
| 14 |
* products derived from this software without specific prior written |
| 15 |
* permission. |
| 16 |
* |
| 17 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 18 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT |
| 19 |
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND |
| 20 |
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL |
| 21 |
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, |
| 22 |
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| 23 |
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| 24 |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 25 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 26 |
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 27 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 28 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
| 29 |
*/ |
| 30 |
package com.jcabi.aspects; |
| 31 |
|
| 32 |
import java.lang.annotation.Documented; |
| 33 |
import java.lang.annotation.ElementType; |
| 34 |
import java.lang.annotation.Retention; |
| 35 |
import java.lang.annotation.RetentionPolicy; |
| 36 |
import java.lang.annotation.Target; |
| 37 |
import java.util.concurrent.TimeUnit; |
| 38 |
|
| 39 |
/** |
| 40 |
* Retry the method in case of exception. |
| 41 |
* |
| 42 |
* <p>For example, this {@code load()} method will retry to load the URL |
| 43 |
* content if it fails at the first attempts: |
| 44 |
* |
| 45 |
* <pre> @RetryOnFailure(attempts = 2) |
| 46 |
* String load(URL url) throws IOException { |
| 47 |
* return url.getContent().toString(); |
| 48 |
* }</pre> |
| 49 |
* |
| 50 |
* @author Yegor Bugayenko ([email protected]) |
| 51 |
* @version $Id: 65f12bbf5ae83a722a1c651ef0ac0ba0abd6f4c1 $ |
| 52 |
* @since 0.1.10 |
| 53 |
* @see <a href="http://aspects.jcabi.com">http://aspects.jcabi.com/</a> |
| 54 |
*/ |
| 55 |
@Documented |
| 56 |
@Retention(RetentionPolicy.RUNTIME) |
| 57 |
@Target(ElementType.METHOD) |
| 58 |
public @interface RetryOnFailure { |
| 59 |
|
| 60 |
/** |
| 61 |
* How many times to retry. |
| 62 |
* @checkstyle MagicNumber (2 lines) |
| 63 |
*/ |
| 64 |
int attempts() default 3; |
| 65 |
|
| 66 |
/** |
| 67 |
* Delay between attempts, in time units. |
| 68 |
* @checkstyle MagicNumber (2 lines) |
| 69 |
*/ |
| 70 |
long delay() default 50; |
| 71 |
|
| 72 |
/** |
| 73 |
* Time units. |
| 74 |
*/ |
| 75 |
TimeUnit unit() default TimeUnit.MILLISECONDS; |
| 76 |
|
| 77 |
/** |
| 78 |
* When to retry (in case of what exception types). |
| 79 |
*/ |
| 80 |
Class<? extends Throwable>[] types() default { Throwable.class }; |
| 81 |
|
| 82 |
/** |
| 83 |
* Exception types to ignore. |
| 84 |
*/ |
| 85 |
Class<? extends Throwable>[] ignore() default { }; |
| 86 |
|
| 87 |
/** |
| 88 |
* Shall it be fully verbose (show full exception trace) or just |
| 89 |
* exception message? |
| 90 |
*/ |
| 91 |
boolean verbose() default true; |
| 92 |
|
| 93 |
/** |
| 94 |
* Shall the time between retries by randomized. |
| 95 |
*/ |
| 96 |
boolean randomize() default true; |
| 97 |
|
| 98 |
} |