tomee-9.0/examples/mp-faulttolerance-retry.html - tomee-site-pub - Git at Google

 <!DOCTYPE html>
 <html lang="en">

 <head>
 	<meta charset="UTF-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<title>Apache TomEE</title>
 	<meta name="description"
 		  content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
 	<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
 	<meta name="author" content="Luka Cvetinovic for Codrops" />
 	<link rel="icon" href="../../favicon.ico">
 	<link rel="icon"  type="image/png" href="../../favicon.png">
 	<meta name="msapplication-TileColor" content="#80287a">
 	<meta name="theme-color" content="#80287a">
 	<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
 	<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
 	<link rel="stylesheet" type="text/css" href="../../css/owl.css">
 	<link rel="stylesheet" type="text/css" href="../../css/animate.css">
 	<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
 	<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
 	<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
 	<link rel="stylesheet" type="text/css" href="../../css/idea.css">
 	<link rel="stylesheet" type="text/css" href="../../css/cardio.css">

 	<script type="text/javascript">

       var _gaq = _gaq || [];
       _gaq.push(['_setAccount', 'UA-2717626-1']);
       _gaq.push(['_setDomainName', 'apache.org']);
       _gaq.push(['_trackPageview']);

       (function() {
         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
       })();

     </script>
 </head>

 <body>
     <div class="preloader">
 		<img src="../../img/loader.gif" alt="Preloader image">
 	</div>
 	    <nav class="navbar">
 		<div class="container">
 		  <div class="row">          <div class="col-md-12">

 			<!-- Brand and toggle get grouped for better mobile display -->
 			<div class="navbar-header">
 				<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
 					<span class="sr-only">Toggle navigation</span>
 					<span class="icon-bar"></span>
 					<span class="icon-bar"></span>
 					<span class="icon-bar"></span>
 				</button>
 				<a class="navbar-brand" href="/">
 				    <span>


                         <img src="../../img/logo-active.png">


                     </span>
 				    Apache TomEE
                 </a>
 			</div>
 			<!-- Collect the nav links, forms, and other content for toggling -->
 			<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
 				<ul class="nav navbar-nav navbar-right main-nav">
 					<li><a href="../../docs.html">Documentation</a></li>
 					<li><a href="../../community/index.html">Community</a></li>
 					<li><a href="../../security/security.html">Security</a></li>
 					<li><a href="../../download-ng.html">Downloads</a></li>
 				</ul>
 			</div>
 			<!-- /.navbar-collapse -->
 		   </div></div>
 		</div>
 		<!-- /.container-fluid -->
 	</nav>


     <div id="main-block" class="container main-block">
         <div class="row title">
           <div class="col-md-12">
             <div class='page-header'>

               <h1>MicroProfile Fault Tolerance - Retry Policy</h1>
             </div>
           </div>
         </div>
         <div class="row">

             <div class="col-md-12">
                 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>This is an example of how to use
 Microprofile @Retry in TomEE.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_retry_feature">Retry Feature</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Microprofile Fault Tolerance has a feature called Retry that can be used
 to recover an operation from failure, invoking the same operation again
 until it reaches its stopping criteria.</p>
 </div>
 <div class="paragraph">
 <p>The Retry policy allows to configure :</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p><strong>maxRetries</strong>: the maximum retries</p>
 </li>
 <li>
 <p><strong>delay</strong>: delays between each retry</p>
 </li>
 <li>
 <p><strong>delayUnit</strong>: the delay unit</p>
 </li>
 <li>
 <p><strong>maxDuration</strong>: maximum duration to perform the retry for.</p>
 </li>
 <li>
 <p><strong>durationUnit</strong>: duration unit</p>
 </li>
 <li>
 <p><strong>jitter:</strong> the random vary of retry delays</p>
 </li>
 <li>
 <p><strong>jitterDelayUnit:</strong> the jitter unit</p>
 </li>
 <li>
 <p><strong>retryOn:</strong> specify the failures to retry on</p>
 </li>
 <li>
 <p><strong>abortOn:</strong> specify the failures to abort on</p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>To use this feature you can annotate a class and/or a method with the
 @Retry annotation. Check the
 <a href="http://download.eclipse.org/microprofile/microprofile-fault-tolerance-1.1/microprofile-fault-tolerance-spec.html">specification</a>
 for more details.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_examples">Examples</h2>
 <div class="sectionbody">
 <div class="sect2">
 <h3 id="_run_the_application">Run the application</h3>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">mvn clean install tomee:run</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_example_1">Example 1</h3>
 <div class="paragraph">
 <p>The method statusOfDay will fail three times, each time, throwing a
 <code>WeatherGatewayTimeoutException</code> and as the @Retry annotation is
 configured to <code>retryOn</code> in case of failure, the FailSafe library will
 take the <code>maxRetry</code> value and retry the same operation until it reaches
 the number maximum of attempts, which is 3 (default value).</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@RequestScoped
 public class WeatherGateway{
    ...
    @Retry(maxRetry=3, retryOn = WeatherGatewayTimeoutException.class)
    public String statusOfDay(){
        if(counterStatusOfDay.addAndGet(1) &lt;= DEFAULT_MAX_RETRY){
            LOGGER.warning(String.format(FORECAST_TIMEOUT_MESSAGE, DEFAULT_MAX_RETRY, counterStatusOfDay.get()));
            throw new WeatherGatewayTimeoutException();
        }
        return "Today is a sunny day!";
    }
    ...
  }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Day status call</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/day/status</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Server log</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (1)
 WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (2)
 WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (3)</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Response</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">Today is a sunny day!</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_example_2">Example 2</h3>
 <div class="paragraph">
 <p>The method weekStatus will fail two times, each time, throwing a
 <code>WeatherGatewayTimeoutException</code> because <code>retryOn</code> is configured and
 instead of returning a response to the caller, the logic states that at
 the third attempt, a <code>WeatherGatewayBusyServiceException</code> will be
 thrown. As the <code>@Retry</code> annotation is configured to <code>abortOn</code> in case of
 <code>WeatherGatewayTimeoutException</code> happens, the remaining attempt won’t be
 executed and the caller must handle the exception.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Retry(maxRetries = 3, retryOn = WeatherGatewayTimeoutException.class, abortOn = WeatherGatewayBusyServiceException.class)
 public String statusOfWeek(){
     if(counterStatusOfWeek.addAndGet(1) &lt;= DEFAULT_MAX_RETRY){
         LOGGER.warning(String.format(FORECAST_TIMEOUT_MESSAGE_ATTEMPTS, DEFAULT_MAX_RETRY, counterStatusOfWeek.get()));
         throw new WeatherGatewayTimeoutException();
     }
     LOGGER.log(Level.SEVERE, String.format(FORECAST_BUSY_MESSAGE, counterStatusOfWeek.get()));
     throw new WeatherGatewayBusyServiceException();
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Week status call</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/week/status</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Server log</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (1)
 WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (2)
 WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (3)
 SEVERE  - Error AccuWeather Forecast Service is busy. Number of Attempts: (4)</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Response</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WeatherGateway Service is Busy. Retry later</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_example_3">Example 3</h3>
 <div class="paragraph">
 <p>The <code>@Retry</code> annotation allows to configure a delay for each new attempt
 be executed giving a chance to service requested to recover itself and
 answerer the request properly. For each new retry follow the delay
 configure, is needed to set <code>jitter</code> to zero (0). Otherwise the delay of
 each new attempt will be randomized.</p>
 </div>
 <div class="paragraph">
 <p>Analysing the logged messages, is possible to see that all attempts took
 the pretty much the same time to execute.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Retry(retryOn = WeatherGatewayTimeoutException.class, maxRetries = 5, delay = 500, jitter = 0)
 public String statusOfWeekend() {
     if (counterStatusOfWeekend.addAndGet(1) &lt;= 5) {
         logTimeoutMessage(statusOfWeekendInstant);
         statusOfWeekendInstant = Instant.now();
         throw new WeatherGatewayTimeoutException();
     }
     return "The Forecast for the Weekend is Scattered Showers.";
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Weekend status call</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/weekend/status</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Server log</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (500) millis</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_example_4">Example 4</h3>
 <div class="paragraph">
 <p>Basically with the same behaviour of the <code>Example 3</code>, this example sets
 the <code>delay</code> and <code>jitter</code> with 500 millis to randomly create a new delay
 for each new attempt after the first failure.
 <a href="https://github.com/jhalterman/failsafe/blob/master/src/main/java/net/jodah/failsafe/AbstractExecution.java">AbstractExecution#randomDelay(delay,jitter,random)</a>
 can give a hit of how the new delay is calculated.</p>
 </div>
 <div class="paragraph">
 <p>Analysing the logged messages, is possible to see how long each attempt
 had to wait until its execution.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Retry(retryOn = WeatherGatewayTimeoutException.class, delay = 500, jitter = 500)
 public String statusOfMonth() {
     if (counterStatusOfWeekend.addAndGet(1) &lt;= DEFAULT_MAX_RETRY) {
         logTimeoutMessage(statusOfMonthInstant);
         statusOfMonthInstant = Instant.now();
         throw new WeatherGatewayTimeoutException();
     }
     return "The Forecast for the Weekend is Scattered Showers.";
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Month status call</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/month/status</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Server log</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (417) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (90) millis</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_example_5">Example 5</h3>
 <div class="paragraph">
 <p>If a condition for an operation be re-executed is not set as in the
 previous examples using the parameter <code>retryOn</code>, the operation is
 executed again for <em>any</em> exception that is thrown.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">@Retry(maxDuration = 1000)
 public String statusOfYear(){
     if (counterStatusOfWeekend.addAndGet(1) &lt;= 5) {
         logTimeoutMessage(statusOfYearInstant);
         statusOfYearInstant = Instant.now();
         throw new RuntimeException();
     }
     return "WeatherGateway Service Error";
 }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Year status call</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/year/statusk</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>Server log</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (666) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (266) millis
 WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (66) millis</code></pre>
 </div>
 </div>
 </div>
 <div class="sect2">
 <h3 id="_run_the_tests">Run the tests</h3>
 <div class="paragraph">
 <p>You can also try it out using the
 <a href="src/test/java/org/superbiz/rest/WeatherServiceTest.java">WeatherServiceTest.java</a>
 available in the project.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">mvn clean test</code></pre>
 </div>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight"><code class="language-java" data-lang="java">[INFO] Results:
 [INFO]
 [INFO] Tests run: 5, Failures: 0, Errors: 0, Skipped: 0</code></pre>
 </div>
 </div>
 </div>
 </div>
 </div>
             </div>

         </div>
     </div>
 <footer>
 		<div class="container">
 			<div class="row">
 				<div class="col-sm-6 text-center-mobile">
 					<h3 class="white">Be simple.  Be certified. Be Tomcat.</h3>
 					<h5 class="light regular light-white">"A good application in a good server"</h5>
 					<ul class="social-footer">
 						<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
 						<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
 						<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
 					</ul>
 				</div>
 				<div class="col-sm-6 text-center-mobile">
 					<div class="row opening-hours">
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../latest/docs/" class="white">Documentation</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
 								<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
 								<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
 								<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
 								<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
 								<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
 								<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../community/index.html" class="white">Community</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
 								<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
 								<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
 							</ul>
 						</div>
 						<div class="col-sm-3 text-center-mobile">
 							<h5><a href="../../security/index.html" class="white">Security</a></h5>
 							<ul class="list-unstyled">
 								<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
 								<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
 								<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
 							</ul>
 						</div>
 					</div>
 				</div>
 			</div>
 			<div class="row bottom-footer text-center-mobile">
 				<div class="col-sm-12 light-white">
 					<p>Copyright &copy; 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
 				</div>
 			</div>
 		</div>
 	</footer>
 	<!-- Holder for mobile navigation -->
 	<div class="mobile-nav">
         <ul>
           <li><a hef="../../latest/docs/admin/index.html">Administrators</a>
           <li><a hef="../../latest/docs/developer/index.html">Developers</a>
           <li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
           <li><a hef="../../community/index.html">Community</a>
         </ul>
 		<a href="#" class="close-link"><i class="arrow_up"></i></a>
 	</div>
 	<!-- Scripts -->
 	<script src="../../js/jquery-1.11.1.min.js"></script>
 	<script src="../../js/owl.carousel.min.js"></script>
 	<script src="../../js/bootstrap.min.js"></script>
 	<script src="../../js/wow.min.js"></script>
 	<script src="../../js/typewriter.js"></script>
 	<script src="../../js/jquery.onepagenav.js"></script>
 	<script src="../../js/tree.jquery.js"></script>
 	<script src="../../js/highlight.pack.js"></script>
     <script src="../../js/main.js"></script>
 		</body>

 </html>
	<!DOCTYPE html>
	<html lang="en">

	<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Apache TomEE</title>
	<meta name="description"
	content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
	<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
	<meta name="author" content="Luka Cvetinovic for Codrops" />
	<link rel="icon" href="../../favicon.ico">
	<link rel="icon" type="image/png" href="../../favicon.png">
	<meta name="msapplication-TileColor" content="#80287a">
	<meta name="theme-color" content="#80287a">
	<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
	<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
	<link rel="stylesheet" type="text/css" href="../../css/owl.css">
	<link rel="stylesheet" type="text/css" href="../../css/animate.css">
	<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
	<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
	<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
	<link rel="stylesheet" type="text/css" href="../../css/idea.css">
	<link rel="stylesheet" type="text/css" href="../../css/cardio.css">

	<script type="text/javascript">

	var _gaq = _gaq \|\| [];
	_gaq.push(['_setAccount', 'UA-2717626-1']);
	_gaq.push(['_setDomainName', 'apache.org']);
	_gaq.push(['_trackPageview']);

	(function() {
	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	})();

	</script>
	</head>

	<body>
	<div class="preloader">
	<img src="../../img/loader.gif" alt="Preloader image">
	</div>
	<nav class="navbar">
	<div class="container">
	<div class="row"> <div class="col-md-12">

	<!-- Brand and toggle get grouped for better mobile display -->
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="navbar-brand" href="/">
	<span>


	<img src="../../img/logo-active.png">


	</span>
	Apache TomEE
	</a>
	</div>
	<!-- Collect the nav links, forms, and other content for toggling -->
	<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
	<ul class="nav navbar-nav navbar-right main-nav">
	<li><a href="../../docs.html">Documentation</a></li>
	<li><a href="../../community/index.html">Community</a></li>
	<li><a href="../../security/security.html">Security</a></li>
	<li><a href="../../download-ng.html">Downloads</a></li>
	</ul>
	</div>
	<!-- /.navbar-collapse -->
	</div></div>
	</div>
	<!-- /.container-fluid -->
	</nav>


	<div id="main-block" class="container main-block">
	<div class="row title">
	<div class="col-md-12">
	<div class='page-header'>

	<h1>MicroProfile Fault Tolerance - Retry Policy</h1>
	</div>
	</div>
	</div>
	<div class="row">

	<div class="col-md-12">
	<div id="preamble">
	<div class="sectionbody">
	<div class="paragraph">
	<p>This is an example of how to use
	Microprofile @Retry in TomEE.</p>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_retry_feature">Retry Feature</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>Microprofile Fault Tolerance has a feature called Retry that can be used
	to recover an operation from failure, invoking the same operation again
	until it reaches its stopping criteria.</p>
	</div>
	<div class="paragraph">
	<p>The Retry policy allows to configure :</p>
	</div>
	<div class="ulist">
	<ul>
	<li>
	<p><strong>maxRetries</strong>: the maximum retries</p>
	</li>
	<li>
	<p><strong>delay</strong>: delays between each retry</p>
	</li>
	<li>
	<p><strong>delayUnit</strong>: the delay unit</p>
	</li>
	<li>
	<p><strong>maxDuration</strong>: maximum duration to perform the retry for.</p>
	</li>
	<li>
	<p><strong>durationUnit</strong>: duration unit</p>
	</li>
	<li>
	<p><strong>jitter:</strong> the random vary of retry delays</p>
	</li>
	<li>
	<p><strong>jitterDelayUnit:</strong> the jitter unit</p>
	</li>
	<li>
	<p><strong>retryOn:</strong> specify the failures to retry on</p>
	</li>
	<li>
	<p><strong>abortOn:</strong> specify the failures to abort on</p>
	</li>
	</ul>
	</div>
	<div class="paragraph">
	<p>To use this feature you can annotate a class and/or a method with the
	@Retry annotation. Check the
	<a href="http://download.eclipse.org/microprofile/microprofile-fault-tolerance-1.1/microprofile-fault-tolerance-spec.html">specification</a>
	for more details.</p>
	</div>
	</div>
	</div>
	<div class="sect1">
	<h2 id="_examples">Examples</h2>
	<div class="sectionbody">
	<div class="sect2">
	<h3 id="_run_the_application">Run the application</h3>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">mvn clean install tomee:run</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_example_1">Example 1</h3>
	<div class="paragraph">
	<p>The method statusOfDay will fail three times, each time, throwing a
	<code>WeatherGatewayTimeoutException</code> and as the @Retry annotation is
	configured to <code>retryOn</code> in case of failure, the FailSafe library will
	take the <code>maxRetry</code> value and retry the same operation until it reaches
	the number maximum of attempts, which is 3 (default value).</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@RequestScoped
	public class WeatherGateway{
	...
	@Retry(maxRetry=3, retryOn = WeatherGatewayTimeoutException.class)
	public String statusOfDay(){
	if(counterStatusOfDay.addAndGet(1) <= DEFAULT_MAX_RETRY){
	LOGGER.warning(String.format(FORECAST_TIMEOUT_MESSAGE, DEFAULT_MAX_RETRY, counterStatusOfDay.get()));
	throw new WeatherGatewayTimeoutException();
	}
	return "Today is a sunny day!";
	}
	...
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Day status call</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/day/status</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Server log</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (1)
	WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (2)
	WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (3)</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Response</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">Today is a sunny day!</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_example_2">Example 2</h3>
	<div class="paragraph">
	<p>The method weekStatus will fail two times, each time, throwing a
	<code>WeatherGatewayTimeoutException</code> because <code>retryOn</code> is configured and
	instead of returning a response to the caller, the logic states that at
	the third attempt, a <code>WeatherGatewayBusyServiceException</code> will be
	thrown. As the <code>@Retry</code> annotation is configured to <code>abortOn</code> in case of
	<code>WeatherGatewayTimeoutException</code> happens, the remaining attempt won’t be
	executed and the caller must handle the exception.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Retry(maxRetries = 3, retryOn = WeatherGatewayTimeoutException.class, abortOn = WeatherGatewayBusyServiceException.class)
	public String statusOfWeek(){
	if(counterStatusOfWeek.addAndGet(1) <= DEFAULT_MAX_RETRY){
	LOGGER.warning(String.format(FORECAST_TIMEOUT_MESSAGE_ATTEMPTS, DEFAULT_MAX_RETRY, counterStatusOfWeek.get()));
	throw new WeatherGatewayTimeoutException();
	}
	LOGGER.log(Level.SEVERE, String.format(FORECAST_BUSY_MESSAGE, counterStatusOfWeek.get()));
	throw new WeatherGatewayBusyServiceException();
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Week status call</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/week/status</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Server log</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (1)
	WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (2)
	WARNING - Timeout when accessing AccuWeather Forecast Service. Max of Attempts: (3), Attempts: (3)
	SEVERE - Error AccuWeather Forecast Service is busy. Number of Attempts: (4)</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Response</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WeatherGateway Service is Busy. Retry later</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_example_3">Example 3</h3>
	<div class="paragraph">
	<p>The <code>@Retry</code> annotation allows to configure a delay for each new attempt
	be executed giving a chance to service requested to recover itself and
	answerer the request properly. For each new retry follow the delay
	configure, is needed to set <code>jitter</code> to zero (0). Otherwise the delay of
	each new attempt will be randomized.</p>
	</div>
	<div class="paragraph">
	<p>Analysing the logged messages, is possible to see that all attempts took
	the pretty much the same time to execute.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Retry(retryOn = WeatherGatewayTimeoutException.class, maxRetries = 5, delay = 500, jitter = 0)
	public String statusOfWeekend() {
	if (counterStatusOfWeekend.addAndGet(1) <= 5) {
	logTimeoutMessage(statusOfWeekendInstant);
	statusOfWeekendInstant = Instant.now();
	throw new WeatherGatewayTimeoutException();
	}
	return "The Forecast for the Weekend is Scattered Showers.";
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Weekend status call</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/weekend/status</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Server log</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (501) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (500) millis</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_example_4">Example 4</h3>
	<div class="paragraph">
	<p>Basically with the same behaviour of the <code>Example 3</code>, this example sets
	the <code>delay</code> and <code>jitter</code> with 500 millis to randomly create a new delay
	for each new attempt after the first failure.
	<a href="https://github.com/jhalterman/failsafe/blob/master/src/main/java/net/jodah/failsafe/AbstractExecution.java">AbstractExecution#randomDelay(delay,jitter,random)</a>
	can give a hit of how the new delay is calculated.</p>
	</div>
	<div class="paragraph">
	<p>Analysing the logged messages, is possible to see how long each attempt
	had to wait until its execution.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Retry(retryOn = WeatherGatewayTimeoutException.class, delay = 500, jitter = 500)
	public String statusOfMonth() {
	if (counterStatusOfWeekend.addAndGet(1) <= DEFAULT_MAX_RETRY) {
	logTimeoutMessage(statusOfMonthInstant);
	statusOfMonthInstant = Instant.now();
	throw new WeatherGatewayTimeoutException();
	}
	return "The Forecast for the Weekend is Scattered Showers.";
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Month status call</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/month/status</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Server log</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (417) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (90) millis</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_example_5">Example 5</h3>
	<div class="paragraph">
	<p>If a condition for an operation be re-executed is not set as in the
	previous examples using the parameter <code>retryOn</code>, the operation is
	executed again for <em>any</em> exception that is thrown.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">@Retry(maxDuration = 1000)
	public String statusOfYear(){
	if (counterStatusOfWeekend.addAndGet(1) <= 5) {
	logTimeoutMessage(statusOfYearInstant);
	statusOfYearInstant = Instant.now();
	throw new RuntimeException();
	}
	return "WeatherGateway Service Error";
	}</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Year status call</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">GET http://localhost:8080/mp-faulttolerance-retry/weather/year/statusk</code></pre>
	</div>
	</div>
	<div class="paragraph">
	<p>Server log</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">WARNING - Timeout when accessing AccuWeather Forecast Service.
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (666) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (266) millis
	WARNING - Timeout when accessing AccuWeather Forecast Service. Delay before this attempt: (66) millis</code></pre>
	</div>
	</div>
	</div>
	<div class="sect2">
	<h3 id="_run_the_tests">Run the tests</h3>
	<div class="paragraph">
	<p>You can also try it out using the
	<a href="src/test/java/org/superbiz/rest/WeatherServiceTest.java">WeatherServiceTest.java</a>
	available in the project.</p>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">mvn clean test</code></pre>
	</div>
	</div>
	<div class="listingblock">
	<div class="content">
	<pre class="highlight"><code class="language-java" data-lang="java">[INFO] Results:
	[INFO]
	[INFO] Tests run: 5, Failures: 0, Errors: 0, Skipped: 0</code></pre>
	</div>
	</div>
	</div>
	</div>
	</div>
	</div>

	</div>
	</div>
	<footer>
	<div class="container">
	<div class="row">
	<div class="col-sm-6 text-center-mobile">
	<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
	<h5 class="light regular light-white">"A good application in a good server"</h5>
	<ul class="social-footer">
	<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
	<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
	<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
	</ul>
	</div>
	<div class="col-sm-6 text-center-mobile">
	<div class="row opening-hours">
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../latest/docs/" class="white">Documentation</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
	<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
	<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
	<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
	<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
	<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
	<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../community/index.html" class="white">Community</a></h5>
	<ul class="list-unstyled">
	<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
	<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
	<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
	</ul>
	</div>
	<div class="col-sm-3 text-center-mobile">
	<h5><a href="../../security/index.html" class="white">Security</a></h5>
	<ul class="list-unstyled">
	<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
	<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
	<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
	</ul>
	</div>
	</div>
	</div>
	</div>
	<div class="row bottom-footer text-center-mobile">
	<div class="col-sm-12 light-white">
	<p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
	</div>
	</div>
	</div>
	</footer>
	<!-- Holder for mobile navigation -->
	<div class="mobile-nav">
	<ul>
	<li><a hef="../../latest/docs/admin/index.html">Administrators</a>
	<li><a hef="../../latest/docs/developer/index.html">Developers</a>
	<li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
	<li><a hef="../../community/index.html">Community</a>
	</ul>
	<a href="#" class="close-link"><i class="arrow_up"></i></a>
	</div>
	<!-- Scripts -->
	<script src="../../js/jquery-1.11.1.min.js"></script>
	<script src="../../js/owl.carousel.min.js"></script>
	<script src="../../js/bootstrap.min.js"></script>
	<script src="../../js/wow.min.js"></script>
	<script src="../../js/typewriter.js"></script>
	<script src="../../js/jquery.onepagenav.js"></script>
	<script src="../../js/tree.jquery.js"></script>
	<script src="../../js/highlight.pack.js"></script>
	<script src="../../js/main.js"></script>
	</body>

	</html>