| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You 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. |
| --> |
| <html> |
| <head> |
| |
| <link type="text/css" rel="stylesheet" href="/resources/site.css"> |
| <script src='/resources/space.js'></script> |
| |
| <meta http-equiv="Content-type" content="text/html;charset=UTF-8"> |
| <meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source"> |
| <meta name="description" content="Apache CXF, Services Framework - FailoverFeature"> |
| |
| |
| <link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shCoreCXF.css"> |
| <link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shThemeCXF.css"> |
| |
| <script src='/resources/highlighter/scripts/shCore.js'></script> |
| <script src='/resources/highlighter/scripts/shBrushXml.js'></script> |
| <script src='/resources/highlighter/scripts/shBrushJava.js'></script> |
| <script> |
| SyntaxHighlighter.defaults['toolbar'] = false; |
| SyntaxHighlighter.all(); |
| </script> |
| |
| |
| <title> |
| Apache CXF -- FailoverFeature |
| </title> |
| </head> |
| <body onload="init()"> |
| |
| |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr> |
| <td id="cell-0-0" colspan="2"> </td> |
| <td id="cell-0-1"> </td> |
| <td id="cell-0-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-1-0"> </td> |
| <td id="cell-1-1"> </td> |
| <td id="cell-1-2"> |
| <!-- Banner --> |
| <div class="banner" id="banner"><div><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap> |
| <a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a> |
| </td><td align="right" colspan="1" nowrap> |
| <a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a> |
| </td></tr></table></div></div> |
| <!-- Banner --> |
| <div id="top-menu"> |
| <table border="0" cellpadding="1" cellspacing="0" width="100%"> |
| <tr> |
| <td> |
| <div align="left"> |
| <!-- Breadcrumbs --> |
| <a href="index.html">Index</a> > <a href="configuration.html">Configuration</a> > <a href="featureslist.html">FeaturesList</a> > <a href="failoverfeature.html">FailoverFeature</a> |
| <!-- Breadcrumbs --> |
| </div> |
| </td> |
| <td> |
| <div align="right"> |
| <!-- Quicklinks --> |
| <div id="quicklinks"><p><a shape="rect" href="http://cxf.apache.org/download.html">Download</a> | <a shape="rect" href="http://cxf.apache.org/docs/index.html">Documentation</a></p></div> |
| <!-- Quicklinks --> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </td> |
| <td id="cell-1-3"> </td> |
| <td id="cell-1-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-2-0" colspan="2"> </td> |
| <td id="cell-2-1"> |
| <table> |
| <tr valign="top"> |
| <td height="100%"> |
| <div id="wrapper-menu-page-right"> |
| <div id="wrapper-menu-page-top"> |
| <div id="wrapper-menu-page-bottom"> |
| <div id="menu-page"> |
| <!-- NavigationBar --> |
| <div id="navigation"><ul class="alternate"><li><a shape="rect" href="overview.html">Overview</a></li><li><a shape="rect" href="how-tos.html">How-Tos</a></li><li><a shape="rect" href="frontends.html">Frontends</a></li><li><a shape="rect" href="databindings.html">DataBindings</a></li><li><a shape="rect" href="transports.html">Transports</a></li><li><a shape="rect" href="configuration.html">Configuration</a></li><li><a shape="rect" href="debugging-and-logging.html">Debugging and Logging</a></li><li><a shape="rect" href="tools.html">Tools</a></li><li><a shape="rect" href="restful-services.html">RESTful Services</a></li><li><a shape="rect" href="wsdl-bindings.html">WSDL Bindings</a></li><li><a shape="rect" href="service-routing.html">Service Routing</a></li><li><a shape="rect" href="dynamic-languages.html">Dynamic Languages</a></li><li><a shape="rect" href="ws-support.html">WS-* Support</a></li><li><a shape="rect" href="advanced-integration.html">Advanced Integration</a></li><li><a shape="rect" href="deployment.html">Deployment</a></li><li><a shape="rect" href="schemas-and-namespaces.html">Use of Schemas and Namespaces</a></li></ul><hr><ul class="alternate"><li><p>Search</p></li></ul><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse"> |
| <div> |
| <input type="hidden" name="cx" value="002890367768291051730:o99qiwa09y4"> |
| <input type="hidden" name="ie" value="UTF-8"> |
| <input type="text" name="q" size="21"> |
| <input type="submit" name="sa" value="Search"> |
| </div> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/cse/brand?form=cse-search-box&lang=en"></script><hr><ul class="alternate"><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest/">API 3.2.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest-3.1.x/">API 3.1.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/">CXF Website</a></li></ul><p> </p><p><a shape="rect" class="external-link" href="http://www.apache.org/events/current-event.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://www.apache.org/events/current-event-125x125.png" data-image-src="http://www.apache.org/events/current-event-125x125.png"></span></a></p></div> |
| <!-- NavigationBar --> |
| </div> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td height="100%"> |
| <!-- Content --> |
| <div class="wiki-content"> |
| <div id="ConfluenceContent"><h1 id="FailoverFeature-FailoverandLoadDistributorFeature">Failover and Load Distributor Feature</h1><p><style type="text/css">/*<![CDATA[*/ |
| div.rbtoc1636141599179 {padding: 0px;} |
| div.rbtoc1636141599179 ul {list-style: disc;margin-left: 0px;} |
| div.rbtoc1636141599179 li {margin-left: 0px;padding-left: 0px;} |
| |
| /*]]>*/</style></p><div class="toc-macro rbtoc1636141599179"> |
| <ul class="toc-indentation"><li><a shape="rect" href="#FailoverFeature-FailoverandLoadDistributorFeature">Failover and Load Distributor Feature</a></li><li><a shape="rect" href="#FailoverFeature-Failover">Failover</a></li><li><a shape="rect" href="#FailoverFeature-CircuitBreakersFailover">Circuit Breakers Failover</a></li><li><a shape="rect" href="#FailoverFeature-LoadDistribution">Load Distribution</a></li><li><a shape="rect" href="#FailoverFeature-ConfiguringJAX-RSclients">Configuring JAX-RS clients</a></li></ul> |
| </div><h1 id="FailoverFeature-Failover">Failover</h1><p>The CXF Failover feature allows to configure CXF frontend clients to retry a call when the target endpoint becomes unavailable.<br clear="none"> A number of retry strategies available: a client can iterate sequentially over the alternative addresses or chose them randomly. <br clear="none"> Every strategy can be configured to do a delay between selecting the addresses.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default"><beans xmlns="http://www.springframework.org/schema/beans" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xmlns:jaxws="http://cxf.apache.org/jaxws" |
| xmlns:clustering="http://cxf.apache.org/clustering" |
| xmlns:util="http://www.springframework.org/schema/util" |
| xsi:schemaLocation=" |
| http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd |
| http://cxf.apache.org/clustering http://cxf.apache.org/schemas/clustering.xsd |
| http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd |
| http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd"> |
| <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/> |
| |
| <util:list id="addressList"> |
| <value>http://localhost:${testutil.ports.Server.1}/services1</value> |
| <value>http://localhost:${testutil.ports.Server.2}/services2</value> |
| <value>http://localhost:${testutil.ports.Server.3}/services3</value> |
| </util:list> |
| |
| <bean id="SequentialAddresses" class="org.apache.cxf.clustering.SequentialStrategy"> |
| <property name="alternateAddresses"> |
| <ref bean="addressList"/> |
| </property> |
| <!-- delay a retry for 1/10 of a second --> |
| <property name="delayBetweenRetries" value="100"/> |
| </bean> |
| |
| <bean id="RandomAddresses" class="org.apache.cxf.clustering.RandomStrategy"> |
| <property name="alternateAddresses"> |
| <ref bean="addressList"/> |
| </property> |
| </bean> |
| |
| <!-- other jaxws:client attributes and elements are omitted for brevity --> |
| |
| <jaxws:client id="clientWithSeqFailoverSupport" address="http://localhost:8080/services"> |
| <jaxws:features> |
| <clustering:failover> |
| <clustering:strategy> |
| <ref bean="SequentialAddresses"/> |
| </clustering:strategy> |
| </clustering:failover> |
| </jaxws:features> |
| </jaxws:client> |
| |
| <!-- other jaxws:client attributes and elements are omitted for brevity --> |
| |
| <jaxws:client id="clientWithRandomFailoverSupport" address="http://localhost:8080/initialAddress"> |
| <jaxws:features> |
| <clustering:failover> |
| <clustering:strategy> |
| <ref bean="RandomAddresses"/> |
| </clustering:strategy> |
| </clustering:failover> |
| </jaxws:features> |
| </jaxws:client> |
| |
| </beans> |
| </pre> |
| </div></div><p>Note, org.apache.cxf.clustering.RetryStrategy can be used to retry the same, last address for a limited number of times, before switching to the next address. Use RetryStrategy 'maxNumberOfRetries' property. RetryStrategy currently uses a sequential algorithm for selecting the addresses.</p><h1 id="FailoverFeature-CircuitBreakersFailover">Circuit Breakers Failover</h1><p>The recent addition to CXF failover features is the implementation based on circuit breakers, more precisely Apache Zest (<a shape="rect" class="external-link" href="https://zest.apache.org/">https://zest.apache.org/</a>) library. The configuration is very similar to the regular failover strategy, the only difference is usage of<strong> clustering:circuit-breaker-failover</strong> element.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default"><beans xmlns="http://www.springframework.org/schema/beans" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xmlns:jaxws="http://cxf.apache.org/jaxws" |
| xmlns:clustering="http://cxf.apache.org/clustering" |
| xmlns:util="http://www.springframework.org/schema/util" |
| xsi:schemaLocation=" |
| http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd |
| http://cxf.apache.org/clustering http://cxf.apache.org/schemas/clustering.xsd |
| http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd |
| http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd"> |
| <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/> |
| |
| <util:list id="addressList"> |
| <value>http://localhost:${testutil.ports.Server.1}/services1</value> |
| <value>http://localhost:${testutil.ports.Server.2}/services2</value> |
| <value>http://localhost:${testutil.ports.Server.3}/services3</value> |
| </util:list> |
| |
| <bean id="SequentialAddresses" class="org.apache.cxf.clustering.SequentialStrategy"> |
| <property name="alternateAddresses"> |
| <ref bean="addressList"/> |
| </property> |
| <!-- delay a retry for 1/10 of a second --> |
| <property name="delayBetweenRetries" value="100"/> |
| </bean> |
| |
| <bean id="RandomAddresses" class="org.apache.cxf.clustering.RandomStrategy"> |
| <property name="alternateAddresses"> |
| <ref bean="addressList"/> |
| </property> |
| </bean> |
| |
| <!-- other jaxws:client attributes and elements are omitted for brevity --> |
| |
| <jaxws:client id="clientWithSeqFailoverSupport" address="http://localhost:8080/services"> |
| <jaxws:features> |
| <clustering:circuit-breaker-failover threshold="1" timeout="60000"> |
| <clustering:strategy> |
| <ref bean="SequentialAddresses"/> |
| </clustering:strategy> |
| </clustering:circuit-breaker-failover> |
| </jaxws:features> |
| </jaxws:client> |
| |
| <!-- other jaxws:client attributes and elements are omitted for brevity --> |
| |
| <jaxws:client id="clientWithRandomFailoverSupport" address="http://localhost:8080/initialAddress"> |
| <jaxws:features> |
| <clustering:circuit-breaker-failover threshold="1" timeout="60000"> |
| <clustering:strategy> |
| <ref bean="RandomAddresses"/> |
| </clustering:strategy> |
| </clustering:circuit-breaker-failover> |
| </jaxws:features> |
| </jaxws:client> |
| |
| </beans></pre> |
| </div></div><p>Circuit breakers have recommended themselves as a proven strategy to handle and monitor the failures related to external service calls, giving the external systems a time to recover by preventing endless retries or time-outing. For that reason, two configuration parameters could be tuned:</p><ul style="list-style-type: square;"><li><strong>threshold</strong>: the error threshold to open the circuit breaker</li><li><strong>timeout</strong>: the timeout to wait before trying the next invocation</li></ul><h1 id="FailoverFeature-LoadDistribution">Load Distribution</h1><p>Load Distributor Feature is a Failover feature which can allow the clients to iterate over alternative addresses on every new call, irrespectively of whether the last call has reached its target or not. It can help with the controlling the traffic originating from CXF clients at individual servers.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> |
| <pre class="brush: java; gutter: false; theme: Default"><beans xmlns="http://www.springframework.org/schema/beans" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xmlns:jaxws="http://cxf.apache.org/jaxws" |
| xmlns:clustering="http://cxf.apache.org/clustering" |
| xmlns:util="http://www.springframework.org/schema/util" |
| xsi:schemaLocation=" |
| http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd |
| http://cxf.apache.org/clustering http://cxf.apache.org/schemas/clustering.xsd |
| http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd |
| http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd"> |
| <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/> |
| |
| <util:list id="addressList"> |
| <value>http://localhost:${testutil.ports.Server.1}/services1</value> |
| <value>http://localhost:${testutil.ports.Server.2}/services2</value> |
| <value>http://localhost:${testutil.ports.Server.3}/services3</value> |
| </util:list> |
| |
| <bean id="SequentialAddresses" class="org.apache.cxf.clustering.SequentialStrategy"> |
| <property name="alternateAddresses"> |
| <ref bean="addressList"/> |
| </property> |
| </bean> |
| |
| <!-- other jaxws:client attributes and elements are omitted for brevity --> |
| |
| <jaxws:client id="clientWithLoadDistributor" address="http://localhost:8080/services"> |
| <jaxws:features> |
| <clustering:loadDistributor> |
| <clustering:strategy> |
| <ref bean="SequentialAddresses"/> |
| </clustering:strategy> |
| </clustering:loadDistributor> |
| </jaxws:features> |
| </jaxws:client> |
| </beans> |
| </pre> |
| </div></div><h1 id="FailoverFeature-ConfiguringJAX-RSclients">Configuring JAX-RS clients</h1><p>JAX-RS clients are configured exactly as JAX-WS clients are, please see <a shape="rect" href="https://cwiki.apache.org/confluence/display/CXF20DOC/JAX-RS+Failover">this page</a> for more info.</p></div> |
| </div> |
| <!-- Content --> |
| </td> |
| </tr> |
| </table> |
| </td> |
| <td id="cell-2-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-3-0"> </td> |
| <td id="cell-3-1"> </td> |
| <td id="cell-3-2"> |
| <div id="footer"> |
| <!-- Footer --> |
| <div id="site-footer"> |
| <a href="http://cxf.apache.org/privacy-policy.html">Privacy Policy</a> - |
| (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=33298616">edit page</a>) |
| (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=33298616&showComments=true&showCommentArea=true#addcomment">add comment</a>)<br> |
| Apache CXF, CXF, Apache, the Apache feather logo are trademarks of The Apache Software Foundation.<br> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| <!-- Footer --> |
| </div> |
| </td> |
| <td id="cell-3-3"> </td> |
| <td id="cell-3-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-4-0" colspan="2"> </td> |
| <td id="cell-4-1"> </td> |
| <td id="cell-4-2" colspan="2"> </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| try { |
| var pageTracker = _gat._getTracker("UA-4458903-1"); |
| pageTracker._trackPageview(); |
| } catch(err) {}</script> |
| |
| </body> |
| </html> |
| |
