blob: 884f34ce14a064b4cfb50d1f936d0389831444cf [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>LocalFileSystemStateManager (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="LocalFileSystemStateManager (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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>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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.statemgr.localfs</a></div>
<h2 title="Class LocalFileSystemStateManager" class="title">Class LocalFileSystemStateManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">org.apache.heron.statemgr.FileSystemStateManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.heron.statemgr.localfs.LocalFileSystemStateManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../../spi/statemgr/IStateManager.html" title="interface in org.apache.heron.spi.statemgr">IStateManager</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">LocalFileSystemStateManager</span>
extends <a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.heron.statemgr.FileSystemStateManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.heron.statemgr.<a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></h3>
<code><a href="../FileSystemStateManager.StateLocation.html" title="enum in org.apache.heron.statemgr">FileSystemStateManager.StateLocation</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.heron.spi.statemgr.IStateManager">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.heron.spi.statemgr.<a href="../../spi/statemgr/IStateManager.html" title="interface in org.apache.heron.spi.statemgr">IStateManager</a></h3>
<code><a href="../../spi/statemgr/IStateManager.LockName.html" title="enum in org.apache.heron.spi.statemgr">IStateManager.LockName</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.heron.statemgr.FileSystemStateManager">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.heron.statemgr.<a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></h3>
<code><a href="../FileSystemStateManager.html#rootAddress">rootAddress</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">LocalFileSystemStateManager</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">This is to for disposing or cleaning up any internal state accumulated by
the StateManager</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteNode(java.lang.String,boolean)">deleteNode</a></span>&#8203;(java.lang.String&nbsp;path,
boolean&nbsp;deleteChildrenIfNecessary)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../spi/statemgr/Lock.html" title="interface in org.apache.heron.spi.statemgr">Lock</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLock(java.lang.String)">getLock</a></span>&#8203;(java.lang.String&nbsp;path)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected &lt;M extends com.google.protobuf.Message&gt;<br>com.google.common.util.concurrent.ListenableFuture&lt;M&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNodeData(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String,com.google.protobuf.Message.Builder)">getNodeData</a></span>&#8203;(<a href="../../spi/statemgr/WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a>&nbsp;watcher,
java.lang.String&nbsp;path,
com.google.protobuf.Message.Builder&nbsp;builder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.apache.heron.spi.common.Config)">initialize</a></span>&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;ipconfig)</code></th>
<td class="colLast">
<div class="block">Initialize StateManager with the incoming context.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initTree()">initTree</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#main(java.lang.String%5B%5D)">main</a></span>&#8203;(java.lang.String[]&nbsp;args)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nodeExists(java.lang.String)">nodeExists</a></span>&#8203;(java.lang.String&nbsp;path)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setData(java.lang.String,byte%5B%5D,boolean)">setData</a></span>&#8203;(java.lang.String&nbsp;path,
byte[]&nbsp;data,
boolean&nbsp;overwrite)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)">setExecutionState</a></span>&#8203;(<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a>&nbsp;executionState,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the execution state for the given topology</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMetricsCacheLocation(org.apache.heron.proto.tmanager.TopologyManager.MetricsCacheLocation,java.lang.String)">setMetricsCacheLocation</a></span>&#8203;(<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the location of MetricsCache.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)">setPackingPlan</a></span>&#8203;(<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a>&nbsp;packingPlan,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the packing plan for the given topology</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPhysicalPlan(org.apache.heron.proto.system.PhysicalPlans.PhysicalPlan,java.lang.String)">setPhysicalPlan</a></span>&#8203;(<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a>&nbsp;physicalPlan,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the physical plan for the given topology</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchedulerLocation(org.apache.heron.proto.scheduler.Scheduler.SchedulerLocation,java.lang.String)">setSchedulerLocation</a></span>&#8203;(<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the scheduler location for the given topology</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatefulCheckpoints(org.apache.heron.proto.ckptmgr.CheckpointManager.StatefulConsistentCheckpoints,java.lang.String)">setStatefulCheckpoints</a></span>&#8203;(<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a>&nbsp;checkpoint,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the Stateful Checkpoints</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTManagerLocation(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation,java.lang.String)">setTManagerLocation</a></span>&#8203;(<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the location of Tmanager.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">setTopology</a></span>&#8203;(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;topology,
java.lang.String&nbsp;topologyName)</code></th>
<td class="colLast">
<div class="block">Set the topology definition for the given topology</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.statemgr.FileSystemStateManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.heron.statemgr.<a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></h3>
<code><a href="../FileSystemStateManager.html#deleteExecutionState(java.lang.String)">deleteExecutionState</a>, <a href="../FileSystemStateManager.html#deleteLocks(java.lang.String)">deleteLocks</a>, <a href="../FileSystemStateManager.html#deleteMetricsCacheLocation(java.lang.String)">deleteMetricsCacheLocation</a>, <a href="../FileSystemStateManager.html#deletePackingPlan(java.lang.String)">deletePackingPlan</a>, <a href="../FileSystemStateManager.html#deletePhysicalPlan(java.lang.String)">deletePhysicalPlan</a>, <a href="../FileSystemStateManager.html#deleteSchedulerLocation(java.lang.String)">deleteSchedulerLocation</a>, <a href="../FileSystemStateManager.html#deleteStatefulCheckpoints(java.lang.String)">deleteStatefulCheckpoints</a>, <a href="../FileSystemStateManager.html#deleteTManagerLocation(java.lang.String)">deleteTManagerLocation</a>, <a href="../FileSystemStateManager.html#deleteTopology(java.lang.String)">deleteTopology</a>, <a href="../FileSystemStateManager.html#doMain(java.lang.String%5B%5D,org.apache.heron.spi.common.Config)">doMain</a>, <a href="../FileSystemStateManager.html#getExecutionState(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getExecutionState</a>, <a href="../FileSystemStateManager.html#getLock(java.lang.String,org.apache.heron.spi.statemgr.IStateManager.LockName)">getLock</a>, <a href="../FileSystemStateManager.html#getMetricsCacheLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getMetricsCacheLocation</a>, <a href="../FileSystemStateManager.html#getPackingPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getPackingPlan</a>, <a href="../FileSystemStateManager.html#getPhysicalPlan(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getPhysicalPlan</a>, <a href="../FileSystemStateManager.html#getSchedulerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getSchedulerLocation</a>, <a href="../FileSystemStateManager.html#getStateDirectory(org.apache.heron.statemgr.FileSystemStateManager.StateLocation)">getStateDirectory</a>, <a href="../FileSystemStateManager.html#getStatefulCheckpoints(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getStatefulCheckpoints</a>, <a href="../FileSystemStateManager.html#getStatePath(org.apache.heron.statemgr.FileSystemStateManager.StateLocation,java.lang.String)">getStatePath</a>, <a href="../FileSystemStateManager.html#getTManagerLocation(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getTManagerLocation</a>, <a href="../FileSystemStateManager.html#getTopology(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String)">getTopology</a>, <a href="../FileSystemStateManager.html#isTopologyRunning(java.lang.String)">isTopologyRunning</a>, <a href="../FileSystemStateManager.html#print(java.lang.String,java.lang.Object...)">print</a>, <a href="../FileSystemStateManager.html#safeSetException(com.google.common.util.concurrent.SettableFuture,java.lang.Throwable)">safeSetException</a>, <a href="../FileSystemStateManager.html#safeSetFuture(com.google.common.util.concurrent.SettableFuture,V)">safeSetFuture</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LocalFileSystemStateManager</h4>
<pre>public&nbsp;LocalFileSystemStateManager()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initialize(org.apache.heron.spi.common.Config)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initialize&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;ipconfig)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#initialize(org.apache.heron.spi.common.Config)">IStateManager</a></code></span></div>
<div class="block">Initialize StateManager with the incoming context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/statemgr/IStateManager.html#initialize(org.apache.heron.spi.common.Config)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/statemgr/IStateManager.html" title="interface in org.apache.heron.spi.statemgr">IStateManager</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../FileSystemStateManager.html#initialize(org.apache.heron.spi.common.Config)">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="initTree()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTree</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;initTree()</pre>
</li>
</ul>
<a id="setData(java.lang.String,byte[],boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setData</h4>
<pre class="methodSignature">protected&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setData&#8203;(java.lang.String&nbsp;path,
byte[]&nbsp;data,
boolean&nbsp;overwrite)</pre>
</li>
</ul>
<a id="nodeExists(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nodeExists</h4>
<pre class="methodSignature">protected&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;nodeExists&#8203;(java.lang.String&nbsp;path)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FileSystemStateManager.html#nodeExists(java.lang.String)">nodeExists</a></code>&nbsp;in class&nbsp;<code><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="deleteNode(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteNode</h4>
<pre class="methodSignature">protected&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;deleteNode&#8203;(java.lang.String&nbsp;path,
boolean&nbsp;deleteChildrenIfNecessary)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FileSystemStateManager.html#deleteNode(java.lang.String,boolean)">deleteNode</a></code>&nbsp;in class&nbsp;<code><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="getNodeData(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String,com.google.protobuf.Message.Builder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeData</h4>
<pre class="methodSignature">protected&nbsp;&lt;M extends com.google.protobuf.Message&gt;&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;M&gt;&nbsp;getNodeData&#8203;(<a href="../../spi/statemgr/WatchCallback.html" title="interface in org.apache.heron.spi.statemgr">WatchCallback</a>&nbsp;watcher,
java.lang.String&nbsp;path,
com.google.protobuf.Message.Builder&nbsp;builder)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FileSystemStateManager.html#getNodeData(org.apache.heron.spi.statemgr.WatchCallback,java.lang.String,com.google.protobuf.Message.Builder)">getNodeData</a></code>&nbsp;in class&nbsp;<code><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExecutionState</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setExecutionState&#8203;(<a href="../../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a>&nbsp;executionState,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setExecutionState(org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the execution state for the given topology</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setTManagerLocation(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTManagerLocation</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setTManagerLocation&#8203;(<a href="../../proto/tmanager/TopologyManager.TManagerLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.TManagerLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setTManagerLocation(org.apache.heron.proto.tmanager.TopologyManager.TManagerLocation,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the location of Tmanager.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setMetricsCacheLocation(org.apache.heron.proto.tmanager.TopologyManager.MetricsCacheLocation,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetricsCacheLocation</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setMetricsCacheLocation&#8203;(<a href="../../proto/tmanager/TopologyManager.MetricsCacheLocation.html" title="class in org.apache.heron.proto.tmanager">TopologyManager.MetricsCacheLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setMetricsCacheLocation(org.apache.heron.proto.tmanager.TopologyManager.MetricsCacheLocation,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the location of MetricsCache.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTopology</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setTopology&#8203;(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;topology,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setTopology(org.apache.heron.api.generated.TopologyAPI.Topology,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the topology definition for the given topology</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setPhysicalPlan(org.apache.heron.proto.system.PhysicalPlans.PhysicalPlan,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPhysicalPlan</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setPhysicalPlan&#8203;(<a href="../../proto/system/PhysicalPlans.PhysicalPlan.html" title="class in org.apache.heron.proto.system">PhysicalPlans.PhysicalPlan</a>&nbsp;physicalPlan,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setPhysicalPlan(org.apache.heron.proto.system.PhysicalPlans.PhysicalPlan,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the physical plan for the given topology</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPackingPlan</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setPackingPlan&#8203;(<a href="../../proto/system/PackingPlans.PackingPlan.html" title="class in org.apache.heron.proto.system">PackingPlans.PackingPlan</a>&nbsp;packingPlan,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setPackingPlan(org.apache.heron.proto.system.PackingPlans.PackingPlan,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the packing plan for the given topology</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setSchedulerLocation(org.apache.heron.proto.scheduler.Scheduler.SchedulerLocation,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSchedulerLocation</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setSchedulerLocation&#8203;(<a href="../../proto/scheduler/Scheduler.SchedulerLocation.html" title="class in org.apache.heron.proto.scheduler">Scheduler.SchedulerLocation</a>&nbsp;location,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setSchedulerLocation(org.apache.heron.proto.scheduler.Scheduler.SchedulerLocation,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the scheduler location for the given topology</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="setStatefulCheckpoints(org.apache.heron.proto.ckptmgr.CheckpointManager.StatefulConsistentCheckpoints,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatefulCheckpoints</h4>
<pre class="methodSignature">public&nbsp;com.google.common.util.concurrent.ListenableFuture&lt;java.lang.Boolean&gt;&nbsp;setStatefulCheckpoints&#8203;(<a href="../../proto/ckptmgr/CheckpointManager.StatefulConsistentCheckpoints.html" title="class in org.apache.heron.proto.ckptmgr">CheckpointManager.StatefulConsistentCheckpoints</a>&nbsp;checkpoint,
java.lang.String&nbsp;topologyName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#setStatefulCheckpoints(org.apache.heron.proto.ckptmgr.CheckpointManager.StatefulConsistentCheckpoints,java.lang.String)">IStateManager</a></code></span></div>
<div class="block">Set the Stateful Checkpoints</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Boolean - Success or Failure</dd>
</dl>
</li>
</ul>
<a id="getLock(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLock</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../spi/statemgr/Lock.html" title="interface in org.apache.heron.spi.statemgr">Lock</a>&nbsp;getLock&#8203;(java.lang.String&nbsp;path)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FileSystemStateManager.html#getLock(java.lang.String)">getLock</a></code>&nbsp;in class&nbsp;<code><a href="../FileSystemStateManager.html" title="class in org.apache.heron.statemgr">FileSystemStateManager</a></code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/statemgr/IStateManager.html#close()">IStateManager</a></code></span></div>
<div class="block">This is to for disposing or cleaning up any internal state accumulated by
the StateManager
<p>
Closes this stream and releases any system resources associated
with it. If the stream is already closed then invoking this
method has no effect.</div>
</li>
</ul>
<a id="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;main&#8203;(java.lang.String[]&nbsp;args)
throws java.util.concurrent.ExecutionException,
java.lang.InterruptedException,
java.lang.IllegalAccessException,
java.lang.ClassNotFoundException,
java.lang.InstantiationException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.util.concurrent.ExecutionException</code></dd>
<dd><code>java.lang.InterruptedException</code></dd>
<dd><code>java.lang.IllegalAccessException</code></dd>
<dd><code>java.lang.ClassNotFoundException</code></dd>
<dd><code>java.lang.InstantiationException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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>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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>