Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-common / apidocs / org / apache / hadoop / yarn / server / federation / policies / AbstractConfigurableFederationPolicy.html
blob: 8f7ddafcc38b3a8633031f438b27cde7d2f884ec [file] [log] [blame]
<!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>AbstractConfigurableFederationPolicy (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="AbstractConfigurableFederationPolicy (Apache Hadoop YARN Server Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/AbstractConfigurableFederationPolicy.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" target="_top">Frames</a></li>
<li><a href="AbstractConfigurableFederationPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class AbstractConfigurableFederationPolicy" class="title">Class AbstractConfigurableFederationPolicy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.server.federation.policies.AbstractConfigurableFederationPolicy</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies">ConfigurableFederationPolicy</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</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/router/AbstractRouterPolicy.html" title="class in org.apache.hadoop.yarn.server.federation.policies.router">AbstractRouterPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractConfigurableFederationPolicy</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies">ConfigurableFederationPolicy</a></pre>
<div class="block">Base abstract class for a weighted <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies"><code>ConfigurableFederationPolicy</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#AbstractConfigurableFederationPolicy--">AbstractConfigurableFederationPolicy</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a>,<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getActiveSubclusters--">getActiveSubclusters</a></span>()</code>
<div class="block">This methods gets active subclusters map from the <code>FederationStateStoreFacade</code> and validate it not being null/empty.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getIsDirty--">getIsDirty</a></span>()</code>
<div class="block">Returns true whether the last reinitialization requires actual changes, or
was "free" as the weights have not changed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getPolicyContext--">getPolicyContext</a></span>()</code>
<div class="block">Getter method for the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><code>FederationPolicyInitializationContext</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#getPolicyInfo--">getPolicyInfo</a></span>()</code>
<div class="block">Getter method for the configuration weights.</div>
</td>
</tr>
<tr id="i4" 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/AbstractConfigurableFederationPolicy.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>&nbsp;initializationContext)</code>
<div class="block">This method is invoked to initialize of update the configuration of
policies.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#setPolicyContext-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">setPolicyContext</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>&nbsp;policyContext)</code>
<div class="block">Setter method for the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><code>FederationPolicyInitializationContext</code></a>.</div>
</td>
</tr>
<tr id="i6" 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/AbstractConfigurableFederationPolicy.html#setPolicyInfo-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">setPolicyInfo</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a>&nbsp;policyInfo)</code>
<div class="block">Setter method for the configuration weights.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html#validate-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">validate</a></span>(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a>&nbsp;newPolicyInfo)</code>
<div class="block">Overridable validation step for the policy configuration.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractConfigurableFederationPolicy--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractConfigurableFederationPolicy</h4>
<pre>public&nbsp;AbstractConfigurableFederationPolicy()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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="blockList">
<li class="blockList">
<h4>reinitialize</h4>
<pre>public&nbsp;void&nbsp;reinitialize(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a>&nbsp;initializationContext)
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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">ConfigurableFederationPolicy</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html#reinitialize-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">reinitialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies">ConfigurableFederationPolicy</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>initializationContext</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>
<a name="validate-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>public&nbsp;void&nbsp;validate(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a>&nbsp;newPolicyInfo)
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">Overridable validation step for the policy configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newPolicyInfo</code> - the configuration to test.</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> - if the configuration is not
valid.</dd>
</dl>
</li>
</ul>
<a name="getIsDirty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIsDirty</h4>
<pre>public&nbsp;boolean&nbsp;getIsDirty()</pre>
<div class="block">Returns true whether the last reinitialization requires actual changes, or
was "free" as the weights have not changed. This is used by subclasses
overriding reinitialize and calling super.reinitialize() to know whether to
quit early.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether more work is needed to initialize.</dd>
</dl>
</li>
</ul>
<a name="getPolicyInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicyInfo</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a>&nbsp;getPolicyInfo()</pre>
<div class="block">Getter method for the configuration weights.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao"><code>WeightedPolicyInfo</code></a> representing the policy
configuration.</dd>
</dl>
</li>
</ul>
<a name="setPolicyInfo-org.apache.hadoop.yarn.server.federation.policies.dao.WeightedPolicyInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolicyInfo</h4>
<pre>public&nbsp;void&nbsp;setPolicyInfo(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao">WeightedPolicyInfo</a>&nbsp;policyInfo)</pre>
<div class="block">Setter method for the configuration weights.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>policyInfo</code> - the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/dao/WeightedPolicyInfo.html" title="class in org.apache.hadoop.yarn.server.federation.policies.dao"><code>WeightedPolicyInfo</code></a> representing the policy
configuration.</dd>
</dl>
</li>
</ul>
<a name="getPolicyContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicyContext</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a>&nbsp;getPolicyContext()</pre>
<div class="block">Getter method for the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><code>FederationPolicyInitializationContext</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the context for this policy.</dd>
</dl>
</li>
</ul>
<a name="setPolicyContext-org.apache.hadoop.yarn.server.federation.policies.FederationPolicyInitializationContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPolicyContext</h4>
<pre>public&nbsp;void&nbsp;setPolicyContext(<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies">FederationPolicyInitializationContext</a>&nbsp;policyContext)</pre>
<div class="block">Setter method for the <a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/FederationPolicyInitializationContext.html" title="class in org.apache.hadoop.yarn.server.federation.policies"><code>FederationPolicyInitializationContext</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>policyContext</code> - the context to assign to this policy.</dd>
</dl>
</li>
</ul>
<a name="getActiveSubclusters--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getActiveSubclusters</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterId.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterId</a>,<a href="../../../../../../../org/apache/hadoop/yarn/server/federation/store/records/SubClusterInfo.html" title="class in org.apache.hadoop.yarn.server.federation.store.records">SubClusterInfo</a>&gt;&nbsp;getActiveSubclusters()
throws org.apache.hadoop.yarn.exceptions.YarnException</pre>
<div class="block">This methods gets active subclusters map from the <code>FederationStateStoreFacade</code> and validate it not being null/empty.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the map of ids to info for all active subclusters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.yarn.exceptions.YarnException</code> - if we can't get the list.</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/AbstractConfigurableFederationPolicy.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>Prev&nbsp;Class</li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/federation/policies/ConfigurableFederationPolicy.html" title="interface in org.apache.hadoop.yarn.server.federation.policies"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/federation/policies/AbstractConfigurableFederationPolicy.html" target="_top">Frames</a></li>
<li><a href="AbstractConfigurableFederationPolicy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>