| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:10:59 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ConfigurableFederationPolicy (Apache Hadoop YARN Server Common 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ConfigurableFederationPolicy (Apache Hadoop YARN Server Common 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ConfigurableFederationPolicy.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurableFederationPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.yarn.server.federation.policies</div> |
| <h2 title="Interface ConfigurableFederationPolicy" class="title">Interface ConfigurableFederationPolicy</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/FederationAMRMProxyPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">FederationAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/FederationRouterPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies.router">FederationRouterPolicy</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/AbstractAMRMProxyPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">AbstractAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies">AbstractConfigurableFederationPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/AbstractRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">AbstractRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/BroadcastAMRMProxyPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">BroadcastAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/HashBasedRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">HashBasedRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/HomeAMRMProxyPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">HomeAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/LoadBasedRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">LoadBasedRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/LocalityMulticastAMRMProxyPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">LocalityMulticastAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/LocalityRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">LocalityRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/PriorityRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">PriorityRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/amrmproxy/RejectAMRMProxyPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.amrmproxy">RejectAMRMProxyPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/RejectRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">RejectRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/UniformRandomRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">UniformRandomRouterPolicy</a>, <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/router/WeightedRandomRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">WeightedRandomRouterPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ConfigurableFederationPolicy</span></pre> |
| <div class="block">This interface provides a general method to reinitialize a policy. The |
| semantics are try-n-swap, so in case of an exception is thrown the |
| implmentation must ensure the previous state and configuration is preserved.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">reinitialize</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a> policyContext)</code> |
| <div class="block">This method is invoked to initialize of update the configuration of |
| policies.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>reinitialize</h4> |
| <pre>void reinitialize(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a> policyContext) |
| throws <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/exceptions/FederationPolicyInitializationException.html" title="class in org.apache.hadoop.yarn.server.federation.policies.exceptions">FederationPolicyInitializationException</a></pre> |
| <div class="block">This method is invoked to initialize of update the configuration of |
| policies. The implementor should provide try-n-swap semantics, and retain |
| state if possible.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>policyContext</code> - the new context to provide to implementor.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/exceptions/FederationPolicyInitializationException.html" title="class in org.apache.hadoop.yarn.server.federation.policies.exceptions">FederationPolicyInitializationException</a></code> - in case the initialization |
| fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ConfigurableFederationPolicy.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurableFederationPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |