Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-resourcemanager / apidocs / org / apache / hadoop / yarn / server / resourcemanager / scheduler / capacity / conf / MutableCSConfigurationProvider.html
blob: 917019e9f2b3f78d64639545ec6339f675cf5857 [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:12:12 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MutableCSConfigurationProvider (Apache Hadoop YARN ResourceManager 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="MutableCSConfigurationProvider (Apache Hadoop YARN ResourceManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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/MutableCSConfigurationProvider.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/resourcemanager/scheduler/capacity/conf/LeveldbConfigurationStore.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/QueueAdminConfigurationMutationACLPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html" target="_top">Frames</a></li>
<li><a href="MutableCSConfigurationProvider.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.resourcemanager.scheduler.capacity.conf</div>
<h2 title="Class MutableCSConfigurationProvider" class="title">Class MutableCSConfigurationProvider</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.resourcemanager.scheduler.capacity.conf.MutableCSConfigurationProvider</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/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">CSConfigurationProvider</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MutableCSConfigurationProvider</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/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">CSConfigurationProvider</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></pre>
<div class="block">CS configuration provider which implements
<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler"><code>MutableConfigurationProvider</code></a> for modifying capacity scheduler
configuration.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#MutableCSConfigurationProvider-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">MutableCSConfigurationProvider</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</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>org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#applyChanges-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">applyChanges</a></span>(org.apache.hadoop.conf.Configuration&nbsp;oldConfiguration,
org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo&nbsp;confUpdate)</code>
<div class="block">Apply the changes on top of the actual configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#close--">close</a></span>()</code>
<div class="block">Closes the configuration provider, releasing any required resources.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#confirmPendingMutation-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf.YarnConfigurationStore.LogMutation-boolean-">confirmPendingMutation</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.LogMutation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore.LogMutation</a>&nbsp;pendingMutation,
boolean&nbsp;isValid)</code>
<div class="block">Confirm last logged mutation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#formatConfigurationInStore-org.apache.hadoop.conf.Configuration-">formatConfigurationInStore</a></span>(org.apache.hadoop.conf.Configuration&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ConfigurationMutationACLPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ConfigurationMutationACLPolicy</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#getAclMutationPolicy--">getAclMutationPolicy</a></span>()</code>
<div class="block">Get the acl mutation policy for this configuration provider.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#getConfiguration--">getConfiguration</a></span>()</code>
<div class="block">Returns scheduler configuration cached in this provider.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#getConfigVersion--">getConfigVersion</a></span>()</code>
<div class="block">Get the last updated scheduler config version.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#getConfStore--">getConfStore</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#init-org.apache.hadoop.conf.Configuration-">init</a></span>(org.apache.hadoop.conf.Configuration&nbsp;config)</code>
<div class="block">Initialize the configuration provider with given conf.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CapacitySchedulerConfiguration.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CapacitySchedulerConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#loadConfiguration-org.apache.hadoop.conf.Configuration-">loadConfiguration</a></span>(org.apache.hadoop.conf.Configuration&nbsp;configuration)</code>
<div class="block">Loads capacity scheduler configuration object.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.LogMutation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore.LogMutation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#logAndApplyMutation-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">logAndApplyMutation</a></span>(org.apache.hadoop.security.UserGroupInformation&nbsp;user,
org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo&nbsp;confUpdate)</code>
<div class="block">Log user's requested configuration mutation, and applies it in-memory.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#reloadConfigurationFromStore--">reloadConfigurationFromStore</a></span>()</code>
<div class="block">Called when a new ResourceManager is starting/becomes active.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html#revertToOldConfig-org.apache.hadoop.conf.Configuration-">revertToOldConfig</a></span>(org.apache.hadoop.conf.Configuration&nbsp;config)</code>&nbsp;</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOG</h4>
<pre>public static final&nbsp;org.slf4j.Logger LOG</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MutableCSConfigurationProvider-org.apache.hadoop.yarn.server.resourcemanager.RMContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MutableCSConfigurationProvider</h4>
<pre>public&nbsp;MutableCSConfigurationProvider(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/RMContext.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager">RMContext</a>&nbsp;rmContext)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(org.apache.hadoop.conf.Configuration&nbsp;config)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html#init-org.apache.hadoop.conf.Configuration-">CSConfigurationProvider</a></code></span></div>
<div class="block">Initialize the configuration provider with given conf.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html#init-org.apache.hadoop.conf.Configuration-">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">CSConfigurationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - configuration to initialize with</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if initialization fails due to misconfiguration</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#close--">MutableConfigurationProvider</a></code></span></div>
<div class="block">Closes the configuration provider, releasing any required resources.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on failure to close</dd>
</dl>
</li>
</ul>
<a name="getConfStore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfStore</h4>
<pre>public&nbsp;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore</a>&nbsp;getConfStore()</pre>
</li>
</ul>
<a name="loadConfiguration-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadConfiguration</h4>
<pre>public&nbsp;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/CapacitySchedulerConfiguration.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity">CapacitySchedulerConfiguration</a>&nbsp;loadConfiguration(org.apache.hadoop.conf.Configuration&nbsp;configuration)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html#loadConfiguration-org.apache.hadoop.conf.Configuration-">CSConfigurationProvider</a></code></span></div>
<div class="block">Loads capacity scheduler configuration object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html#loadConfiguration-org.apache.hadoop.conf.Configuration-">loadConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/CSConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">CSConfigurationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - initial bootstrap configuration</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CS configuration</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if fail to retrieve configuration</dd>
</dl>
</li>
</ul>
<a name="getConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre>public&nbsp;org.apache.hadoop.conf.Configuration&nbsp;getConfiguration()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getConfiguration--">MutableConfigurationProvider</a></code></span></div>
<div class="block">Returns scheduler configuration cached in this provider.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getConfiguration--">getConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>scheduler configuration.</dd>
</dl>
</li>
</ul>
<a name="getConfigVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigVersion</h4>
<pre>public&nbsp;long&nbsp;getConfigVersion()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getConfigVersion--">MutableConfigurationProvider</a></code></span></div>
<div class="block">Get the last updated scheduler config version.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getConfigVersion--">getConfigVersion</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Last updated scheduler config version.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="getAclMutationPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAclMutationPolicy</h4>
<pre>public&nbsp;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/ConfigurationMutationACLPolicy.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">ConfigurationMutationACLPolicy</a>&nbsp;getAclMutationPolicy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getAclMutationPolicy--">MutableConfigurationProvider</a></code></span></div>
<div class="block">Get the acl mutation policy for this configuration provider.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#getAclMutationPolicy--">getAclMutationPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The acl mutation policy.</dd>
</dl>
</li>
</ul>
<a name="logAndApplyMutation-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logAndApplyMutation</h4>
<pre>public&nbsp;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.LogMutation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore.LogMutation</a>&nbsp;logAndApplyMutation(org.apache.hadoop.security.UserGroupInformation&nbsp;user,
org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo&nbsp;confUpdate)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#logAndApplyMutation-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">MutableConfigurationProvider</a></code></span></div>
<div class="block">Log user's requested configuration mutation, and applies it in-memory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#logAndApplyMutation-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">logAndApplyMutation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - User who requested the change</dd>
<dd><code>confUpdate</code> - User's requested configuration change</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>LogMutation with update info from given SchedConfUpdateInfo</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if logging the mutation fails</dd>
</dl>
</li>
</ul>
<a name="applyChanges-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyChanges</h4>
<pre>public&nbsp;org.apache.hadoop.conf.Configuration&nbsp;applyChanges(org.apache.hadoop.conf.Configuration&nbsp;oldConfiguration,
org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo&nbsp;confUpdate)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#applyChanges-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">MutableConfigurationProvider</a></code></span></div>
<div class="block">Apply the changes on top of the actual configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#applyChanges-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.webapp.dao.SchedConfUpdateInfo-">applyChanges</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>oldConfiguration</code> - actual configuration</dd>
<dd><code>confUpdate</code> - changelist</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new configuration with the applied changed</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the merge failed</dd>
</dl>
</li>
</ul>
<a name="formatConfigurationInStore-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatConfigurationInStore</h4>
<pre>public&nbsp;void&nbsp;formatConfigurationInStore(org.apache.hadoop.conf.Configuration&nbsp;config)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#formatConfigurationInStore-org.apache.hadoop.conf.Configuration-">formatConfigurationInStore</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="revertToOldConfig-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>revertToOldConfig</h4>
<pre>public&nbsp;void&nbsp;revertToOldConfig(org.apache.hadoop.conf.Configuration&nbsp;config)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#revertToOldConfig-org.apache.hadoop.conf.Configuration-">revertToOldConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="confirmPendingMutation-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf.YarnConfigurationStore.LogMutation-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>confirmPendingMutation</h4>
<pre>public&nbsp;void&nbsp;confirmPendingMutation(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/YarnConfigurationStore.LogMutation.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf">YarnConfigurationStore.LogMutation</a>&nbsp;pendingMutation,
boolean&nbsp;isValid)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#confirmPendingMutation-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf.YarnConfigurationStore.LogMutation-boolean-">MutableConfigurationProvider</a></code></span></div>
<div class="block">Confirm last logged mutation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#confirmPendingMutation-org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf.YarnConfigurationStore.LogMutation-boolean-">confirmPendingMutation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pendingMutation</code> - the log mutation to apply</dd>
<dd><code>isValid</code> - if the last logged mutation is applied to scheduler
properly.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if confirming mutation fails</dd>
</dl>
</li>
</ul>
<a name="reloadConfigurationFromStore--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reloadConfigurationFromStore</h4>
<pre>public&nbsp;void&nbsp;reloadConfigurationFromStore()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#reloadConfigurationFromStore--">MutableConfigurationProvider</a></code></span></div>
<div class="block">Called when a new ResourceManager is starting/becomes active. Ensures
configuration is up-to-date.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html#reloadConfigurationFromStore--">reloadConfigurationFromStore</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/MutableConfigurationProvider.html" title="interface in org.apache.hadoop.yarn.server.resourcemanager.scheduler">MutableConfigurationProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if configuration could not be refreshed from store</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/MutableCSConfigurationProvider.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/resourcemanager/scheduler/capacity/conf/LeveldbConfigurationStore.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/QueueAdminConfigurationMutationACLPolicy.html" title="class in org.apache.hadoop.yarn.server.resourcemanager.scheduler.capacity.conf"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/resourcemanager/scheduler/capacity/conf/MutableCSConfigurationProvider.html" target="_top">Frames</a></li>
<li><a href="MutableCSConfigurationProvider.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>