| <!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="/" title="Apache TomEE"> |
| <span> |
| |
| |
| <img |
| src="../../img/apache_tomee-logo.svg" |
| onerror="this.src='../../img/apache_tomee-logo.jpg'" |
| height="50" |
| > |
| |
| |
| </span> |
| </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 class="btn btn-accent accent-orange no-shadow" 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>EJB Client/Server Failover</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>OpenEJB supports stateless failover. Specifically, the ability for an |
| EJB client to failover from one server to the next if a request cannot |
| be completed. No application state information is communicated between |
| the servers, so this functionality should be used only with applications |
| that are inherently stateless. A common term for this sort of setup is a |
| server farm.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The basic design assumption is that all servers in the same group have |
| the same applications deployed and are capable of doing the same job. |
| Servers can be brought online and offline while clients are running. As |
| members join/leave this information is sent to the client as part of |
| normal EJB request/response communication so active clients always have |
| the most current information on servers that can process their request |
| should communication with a particular server fail.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_client_behavior">Client Behavior</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>On each request to the server, the client will send the version number |
| associated with the list of servers in the cluster it is aware of. |
| Initially this version will be zero and the list will be empty. Only |
| when the server sees the client has an old list will the server send the |
| updated list. This is an important distinction as the list is not |
| transmitted back and forth on every request, only on change. If the |
| membership of the cluster is stable there is essentially no clustering |
| overhead to the protocol — 8 byte overhead to each request and 1 byte |
| on each response — so you will <em>not</em> see an exponential slowdown in |
| response times the more members are added to the cluster. This new list |
| takes affect for all proxies that share the same connection.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When a server shuts down, more connections are refused, existing |
| connections not in mid-request are closed, any remaining connections are |
| closed immediately after completion of the request in progress and |
| clients can failover gracefully to the next server in the list. If a |
| server crashes requests are retried on the next server in the list (or |
| depending on the <code>ConnectionStrategy</code>). This failover pattern is |
| followed until there are no more servers in the list at which point the |
| client attempts a final multicast search (if it was created with a |
| <code>PROVIDER_URL</code> starting with <code>multicast://</code>) before abandoning the |
| request and throwing an exception to the caller.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, the failover is ordered but random selection is supported. |
| The multicast discovery aspect of the client adds a nice randomness to |
| the selection of the first server.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_discovery">Discovery</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Each discoverable service has a URI which is broadcast as a heartbeat to |
| other servers in the cluster. This URI advertises the service’s type, |
| its cluster group, and its location in the format of |
| 'group:jbake-date: 2018-12-05 |
| :jbake-type:location'. Say for example |
| "cluster1:ejb:ejbd://thehost:4201". The URI is sent out repeatedly in a |
| pulse and its presence on the network indicates its availability and its |
| absence indicates the service is no longer available.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The sending of this pulse (the heartbeat) can be done via UDP or TCP: |
| multicast and "multipoint" respectively. More on that in the following |
| section. The rate at which the heartbeat is pulsed to the network can be |
| specified via the 'heart_rate' property. The default is 500 |
| milliseconds. This rate is also used when listening for services on the |
| network. If a service goes missing for the duration of 'heart_rate' |
| multiplied by 'max_missed_heartbeats', then the service is considered |
| dead.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The 'group' property, cluster1 in the example, is used to dissect the |
| servers on the network into smaller logical clusters. A given server |
| will broadcast all it’s services with the group prefixed in the URI, as |
| well it will ignore any services it sees broadcast if they do not share |
| the same group name.</p> |
| </div> |
| </div> |
| </div> |
| <h1 id="_details" class="sect0">Details</h1> |
| <div class="paragraph"> |
| <p>Multicast</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="multicast-discovery.html">Multicast UDP Discovery</a></p> |
| </li> |
| <li> |
| <p><a href="multipulse-discovery.html">Multipulse UDP Discovery</a></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Multipoint</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="multipoint-discovery.html">Multipoint TCP Discovery</a></p> |
| </li> |
| <li> |
| <p><a href="multipoint-considerations.html">Considerations</a></p> |
| </li> |
| <li> |
| <p><a href="multipoint-recommendations.html">Recommendations</a></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Logging</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="failover-logging.html">Failover Logging Events</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| <div style="margin-bottom: 30px;"></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> |
| </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-2021 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> |
| |
