content/releases/current/javadocs/org/apache/storm/assignments/InMemoryAssignmentBackend.html - storm-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>InMemoryAssignmentBackend (Storm 2.6.2 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.storm.assignments, class: InMemoryAssignmentBackend">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/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="../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <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="sub-nav-list">
 <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>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.storm.assignments</a></div>
 <h1 title="Class InMemoryAssignmentBackend" class="title">Class InMemoryAssignmentBackend</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.storm.assignments.InMemoryAssignmentBackend</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">InMemoryAssignmentBackend</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 implements <a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></span></div>
 <div class="block">An assignment backend which will keep all assignments and id-info in memory. Only used if no backend is specified internal.

  <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/en/java/javase/11/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.html" title="class or interface in java.util.concurrent" class="external-link"><code>ConcurrentHashMap</code></a> is ok.</li>
  <li>nameToId: same as <i>idToName</i>.
  </ul></div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">InMemoryAssignmentBackend</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#assignments()" class="member-name-link">assignments</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">List all the storm runtime ids of local assignments.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#assignmentsInfo()" class="member-name-link">assignmentsInfo</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get all the local assignments of local state.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStateForStorm(java.lang.String)" class="member-name-link">clearStateForStorm</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Clear all the state for a storm.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Function to release resource.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteStormId(java.lang.String)" class="member-name-link">deleteStormId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Delete a local cache of stormId which is mapped to a specific storm name.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAssignment(java.lang.String)" class="member-name-link">getAssignment</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get assignment as <a href="../generated/Assignment.html" title="class in org.apache.storm.generated"><code>Assignment</code></a> for a storm.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStormId(java.lang.String)" class="member-name-link">getStormId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get storm runtime id from local.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSynchronized()" class="member-name-link">isSynchronized</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Decide if the assignments is synchronized from remote state-store.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keepOrUpdateAssignment(java.lang.String,org.apache.storm.generated.Assignment)" class="member-name-link">keepOrUpdateAssignment</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId,
  <a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&nbsp;assignment)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Keep a storm assignment to local state or update old assignment.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keepStormId(java.lang.String,java.lang.String)" class="member-name-link">keepStormId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Keep a mapping storm-name -> storm-id to local state.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(java.util.Map)" class="member-name-link">prepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&nbsp;conf)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Initial function for creating backend.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeAssignment(java.lang.String)" class="member-name-link">removeAssignment</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSynchronized()" class="member-name-link">setSynchronized</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Mark this backend as synchronized when sync work is done.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syncRemoteAssignments(java.util.Map)" class="member-name-link">syncRemoteAssignments</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>byte[]&gt;&nbsp;remote)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sync remote assignments to local, if remote is null, we will sync it from zk.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syncRemoteIds(java.util.Map)" class="member-name-link">syncRemoteIds</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;remote)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sync remote storm ids to local, will just used for nimbus.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>InMemoryAssignmentBackend</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">InMemoryAssignmentBackend</span>()</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="isSynchronized()">
 <h3>isSynchronized</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSynchronized</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#isSynchronized()">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Decide if the assignments is synchronized from remote state-store.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#isSynchronized()">isSynchronized</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSynchronized()">
 <h3>setSynchronized</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSynchronized</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#setSynchronized()">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Mark this backend as synchronized when sync work is done.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#setSynchronized()">setSynchronized</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="prepare(java.util.Map)">
 <h3>prepare</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">prepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&nbsp;conf)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#prepare(java.util.Map)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Initial function for creating backend.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#prepare(java.util.Map)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>conf</code> - config</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="keepOrUpdateAssignment(java.lang.String,org.apache.storm.generated.Assignment)">
 <h3>keepOrUpdateAssignment</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">keepOrUpdateAssignment</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId,
  <a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&nbsp;assignment)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#keepOrUpdateAssignment(java.lang.String,org.apache.storm.generated.Assignment)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Keep a storm assignment to local state or update old assignment.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#keepOrUpdateAssignment(java.lang.String,org.apache.storm.generated.Assignment)">keepOrUpdateAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormId</code> - storm runtime id</dd>
 <dd><code>assignment</code> - assignment as thrift</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getAssignment(java.lang.String)">
 <h3>getAssignment</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a></span>&nbsp;<span class="element-name">getAssignment</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#getAssignment(java.lang.String)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Get assignment as <a href="../generated/Assignment.html" title="class in org.apache.storm.generated"><code>Assignment</code></a> for a storm.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#getAssignment(java.lang.String)">getAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormId</code> - storm runtime id</dd>
 <dt>Returns:</dt>
 <dd>assignment</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="removeAssignment(java.lang.String)">
 <h3>removeAssignment</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeAssignment</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</span></div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#removeAssignment(java.lang.String)">removeAssignment</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="assignments()">
 <h3>assignments</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">assignments</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#assignments()">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">List all the storm runtime ids of local assignments.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#assignments()">assignments</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Returns:</dt>
 <dd>a list of storm ids</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="assignmentsInfo()">
 <h3>assignmentsInfo</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../generated/Assignment.html" title="class in org.apache.storm.generated">Assignment</a>&gt;</span>&nbsp;<span class="element-name">assignmentsInfo</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#assignmentsInfo()">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Get all the local assignments of local state.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#assignmentsInfo()">assignmentsInfo</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Returns:</dt>
 <dd>mapping of storm-id -> assignment</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="syncRemoteAssignments(java.util.Map)">
 <h3>syncRemoteAssignments</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">syncRemoteAssignments</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>byte[]&gt;&nbsp;remote)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#syncRemoteAssignments(java.util.Map)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Sync remote assignments to local, if remote is null, we will sync it from zk.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#syncRemoteAssignments(java.util.Map)">syncRemoteAssignments</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>remote</code> - specific remote assignments, if it is null, it will sync from zookeeper[only used for nimbus]</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="keepStormId(java.lang.String,java.lang.String)">
 <h3>keepStormId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">keepStormId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#keepStormId(java.lang.String,java.lang.String)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Keep a mapping storm-name -> storm-id to local state.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#keepStormId(java.lang.String,java.lang.String)">keepStormId</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormName</code> - storm name</dd>
 <dd><code>stormId</code> - storm runtime id</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getStormId(java.lang.String)">
 <h3>getStormId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getStormId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#getStormId(java.lang.String)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Get storm runtime id from local.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#getStormId(java.lang.String)">getStormId</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormName</code> - name of a storm</dd>
 <dt>Returns:</dt>
 <dd>runtime storm id</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="syncRemoteIds(java.util.Map)">
 <h3>syncRemoteIds</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">syncRemoteIds</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;remote)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#syncRemoteIds(java.util.Map)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Sync remote storm ids to local, will just used for nimbus.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#syncRemoteIds(java.util.Map)">syncRemoteIds</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>remote</code> - remote ids from state store</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="deleteStormId(java.lang.String)">
 <h3>deleteStormId</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">deleteStormId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormName)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#deleteStormId(java.lang.String)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Delete a local cache of stormId which is mapped to a specific storm name.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#deleteStormId(java.lang.String)">deleteStormId</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormName</code> - storm name</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="clearStateForStorm(java.lang.String)">
 <h3>clearStateForStorm</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clearStateForStorm</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;stormId)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#clearStateForStorm(java.lang.String)">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Clear all the state for a storm.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#clearStateForStorm(java.lang.String)">clearStateForStorm</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>stormId</code> - storm id</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="close()">
 <h3>close</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ILocalAssignmentsBackend.html#close()">ILocalAssignmentsBackend</a></code></span></div>
 <div class="block">Function to release resource.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
 <dt>Specified by:</dt>
 <dd><code><a href="ILocalAssignmentsBackend.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="ILocalAssignmentsBackend.html" title="interface in org.apache.storm.assignments">ILocalAssignmentsBackend</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>