Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / assignments / InMemoryAssignmentBackend.html
blob: 04496e39a3fb79234742e7e41461b58d0c0a6ba1 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InMemoryAssignmentBackend (Storm 2.4.0 API)</title>
<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="InMemoryAssignmentBackend (Storm 2.4.0 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,"i13":10,"i14":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/InMemoryAssignmentBackend.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/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/assignments/LocalAssignmentsBackendFactory.html" title="class in org.apache.storm.assignments"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/assignments/InMemoryAssignmentBackend.html" target="_top">Frames</a></li>
<li><a href="InMemoryAssignmentBackend.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.storm.assignments</div>
<h2 title="Class InMemoryAssignmentBackend" class="title">Class InMemoryAssignmentBackend</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.storm.assignments.InMemoryAssignmentBackend</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">InMemoryAssignmentBackend</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/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></pre>
<div class="block"><p>An assignment backend which will keep all assignments and id-info in memory. Only used if no backend is specified internal.</p><p><p>About thread safe: idToAssignment,idToName,nameToId are all memory cache in nimbus local, for <ul> <li>idToAssignment: nimbus will modify it and supervisors will sync it at fixed interval, so the assignments would come to eventual consistency.</li> <li>idToName: storm submitting/killing is guarded by the same lock, a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentHashMap.html?is-external=true" title="class or interface in java.util.concurrent"><code>ConcurrentHashMap</code></a> is ok.</li> <li>nameToId: same as <i>idToName</i>. </ul></p></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/storm/assignments/InMemoryAssignmentBackend.html#InMemoryAssignmentBackend--">InMemoryAssignmentBackend</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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#assignments--">assignments</a></span>()</code>
<div class="block">List all the storm runtime ids of local assignments.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#assignmentsInfo--">assignmentsInfo</a></span>()</code>
<div class="block">Get all the local assignments of local state.</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/storm/assignments/InMemoryAssignmentBackend.html#clearStateForStorm-java.lang.String-">clearStateForStorm</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</code>
<div class="block">Clear all the state for a storm.</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/storm/assignments/InMemoryAssignmentBackend.html#close--">close</a></span>()</code>
<div class="block">Function to release resource.</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/storm/assignments/InMemoryAssignmentBackend.html#deleteStormId-java.lang.String-">deleteStormId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName)</code>
<div class="block">Delete a local cache of stormId which is mapped to a specific storm name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#getAssignment-java.lang.String-">getAssignment</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</code>
<div class="block">Get assignment as <a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated"><code>Assignment</code></a> for a storm.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#getStormId-java.lang.String-">getStormId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName)</code>
<div class="block">Get storm runtime id from local.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#isSynchronized--">isSynchronized</a></span>()</code>
<div class="block">Decide if the assignments is synchronized from remote state-store.</div>
</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/storm/assignments/InMemoryAssignmentBackend.html#keepOrUpdateAssignment-java.lang.String-org.apache.storm.generated.Assignment-">keepOrUpdateAssignment</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId,
<a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&nbsp;assignment)</code>
<div class="block">Keep a storm assignment to local state or update old assignment.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#keepStormId-java.lang.String-java.lang.String-">keepStormId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</code>
<div class="block">Keep a mapping storm-name -&gt; storm-id to local state.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#prepare-java.util.Map-">prepare</a></span>(<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>&nbsp;conf)</code>
<div class="block">Initial function for creating backend.</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/storm/assignments/InMemoryAssignmentBackend.html#removeAssignment-java.lang.String-">removeAssignment</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</code>&nbsp;</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/storm/assignments/InMemoryAssignmentBackend.html#setSynchronized--">setSynchronized</a></span>()</code>
<div class="block">Mark this backend as synchronized when sync work is done.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#syncRemoteAssignments-java.util.Map-">syncRemoteAssignments</a></span>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,byte[]&gt;&nbsp;remote)</code>
<div class="block">Sync remote assignments to local, if remote is null, we will sync it from zk.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/assignments/InMemoryAssignmentBackend.html#syncRemoteIds-java.util.Map-">syncRemoteIds</a></span>(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;remote)</code>
<div class="block">Sync remote storm ids to local, will just used for nimbus.</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="InMemoryAssignmentBackend--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InMemoryAssignmentBackend</h4>
<pre>public&nbsp;InMemoryAssignmentBackend()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isSynchronized--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSynchronized</h4>
<pre>public&nbsp;boolean&nbsp;isSynchronized()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#isSynchronized--">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Decide if the assignments is synchronized from remote state-store.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#isSynchronized--">isSynchronized</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
</dl>
</li>
</ul>
<a name="setSynchronized--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSynchronized</h4>
<pre>public&nbsp;void&nbsp;setSynchronized()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#setSynchronized--">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Mark this backend as synchronized when sync work is done.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#setSynchronized--">setSynchronized</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
</dl>
</li>
</ul>
<a name="prepare-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;void&nbsp;prepare(<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>&nbsp;conf)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#prepare-java.util.Map-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Initial function for creating backend.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#prepare-java.util.Map-">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - config</dd>
</dl>
</li>
</ul>
<a name="keepOrUpdateAssignment-java.lang.String-org.apache.storm.generated.Assignment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepOrUpdateAssignment</h4>
<pre>public&nbsp;void&nbsp;keepOrUpdateAssignment(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId,
<a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&nbsp;assignment)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#keepOrUpdateAssignment-java.lang.String-org.apache.storm.generated.Assignment-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Keep a storm assignment to local state or update old assignment.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#keepOrUpdateAssignment-java.lang.String-org.apache.storm.generated.Assignment-">keepOrUpdateAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormId</code> - storm runtime id</dd>
<dd><code>assignment</code> - assignment as thrift</dd>
</dl>
</li>
</ul>
<a name="getAssignment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAssignment</h4>
<pre>public&nbsp;<a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&nbsp;getAssignment(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#getAssignment-java.lang.String-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Get assignment as <a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated"><code>Assignment</code></a> for a storm.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#getAssignment-java.lang.String-">getAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormId</code> - storm runtime id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>assignment</dd>
</dl>
</li>
</ul>
<a name="removeAssignment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAssignment</h4>
<pre>public&nbsp;void&nbsp;removeAssignment(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#removeAssignment-java.lang.String-">removeAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
</dl>
</li>
</ul>
<a name="assignments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignments</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;assignments()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#assignments--">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>List all the storm runtime ids of local assignments.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#assignments--">assignments</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of storm ids</dd>
</dl>
</li>
</ul>
<a name="assignmentsInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignmentsInfo</h4>
<pre>public&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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/storm/generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&gt;&nbsp;assignmentsInfo()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#assignmentsInfo--">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Get all the local assignments of local state.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#assignmentsInfo--">assignmentsInfo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>mapping of storm-id -&gt; assignment</dd>
</dl>
</li>
</ul>
<a name="syncRemoteAssignments-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>syncRemoteAssignments</h4>
<pre>public&nbsp;void&nbsp;syncRemoteAssignments(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,byte[]&gt;&nbsp;remote)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#syncRemoteAssignments-java.util.Map-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Sync remote assignments to local, if remote is null, we will sync it from zk.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#syncRemoteAssignments-java.util.Map-">syncRemoteAssignments</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>remote</code> - specific remote assignments, if it is null, it will sync from zookeeper[only used for nimbus]</dd>
</dl>
</li>
</ul>
<a name="keepStormId-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepStormId</h4>
<pre>public&nbsp;void&nbsp;keepStormId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#keepStormId-java.lang.String-java.lang.String-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Keep a mapping storm-name -&gt; storm-id to local state.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#keepStormId-java.lang.String-java.lang.String-">keepStormId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormName</code> - storm name</dd>
<dd><code>stormId</code> - storm runtime id</dd>
</dl>
</li>
</ul>
<a name="getStormId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStormId</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getStormId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#getStormId-java.lang.String-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Get storm runtime id from local.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#getStormId-java.lang.String-">getStormId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormName</code> - name of a storm</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>runtime storm id</dd>
</dl>
</li>
</ul>
<a name="syncRemoteIds-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>syncRemoteIds</h4>
<pre>public&nbsp;void&nbsp;syncRemoteIds(<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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;remote)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#syncRemoteIds-java.util.Map-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Sync remote storm ids to local, will just used for nimbus.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#syncRemoteIds-java.util.Map-">syncRemoteIds</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>remote</code> - remote ids from state store</dd>
</dl>
</li>
</ul>
<a name="deleteStormId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteStormId</h4>
<pre>public&nbsp;void&nbsp;deleteStormId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormName)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#deleteStormId-java.lang.String-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Delete a local cache of stormId which is mapped to a specific storm name.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#deleteStormId-java.lang.String-">deleteStormId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormName</code> - storm name</dd>
</dl>
</li>
</ul>
<a name="clearStateForStorm-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearStateForStorm</h4>
<pre>public&nbsp;void&nbsp;clearStateForStorm(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;stormId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#clearStateForStorm-java.lang.String-">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Clear all the state for a storm.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#clearStateForStorm-java.lang.String-">clearStateForStorm</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stormId</code> - storm id</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#close--">ILocalAssignmentsBackend</a></code></span></div>
<div class="block"><p>Function to release resource.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html#close--">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></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/InMemoryAssignmentBackend.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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/assignments/ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/assignments/LocalAssignmentsBackendFactory.html" title="class in org.apache.storm.assignments"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/assignments/InMemoryAssignmentBackend.html" target="_top">Frames</a></li>
<li><a href="InMemoryAssignmentBackend.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; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>