| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ZKStateStorage (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.cluster, class: ZKStateStorage"> |
| <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/ZKStateStorage.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.storm.cluster</a></div> |
| <h1 title="Class ZKStateStorage" class="title">Class ZKStateStorage</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.cluster.ZKStateStorage</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/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <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="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ZKStateStorage</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="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></span></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(java.util.Map,java.util.Map,org.apache.storm.cluster.ClusterStateContext)" class="member-name-link">ZKStateStorage</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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> authConf, |
| <a href="ClusterStateContext.html" title="class in org.apache.storm.cluster">ClusterStateContext</a> context)</code></div> |
| <div class="col-last even-row-color"> </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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add_listener(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener)" class="member-name-link">add_listener</a><wbr>(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a StateStorageListener to the connection.</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">Close the connection to the data store.</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="#create_sequential(java.lang.String,byte%5B%5D,java.util.List)" class="member-name-link">create_sequential</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Path will be appended with a monotonically increasing integer, a new node will be created there, and data will be put at that node.</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="#delete_node(java.lang.String)" class="member-name-link">delete_node</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> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes the node at a given path, and any child nodes that may exist.</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="#delete_node_blobstore(java.lang.String,java.lang.String)" class="member-name-link">delete_node_blobstore</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> path, |
| <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> nimbusHostPortInfo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allows us to delete the znodes within /storm/blobstore/key_name whose znodes start with the corresponding nimbusHostPortInfo.</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="#delete_worker_hb(java.lang.String)" class="member-name-link">delete_worker_hb</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> path)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes the heartbeat at a given path, and any child nodes that may exist.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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="#get_children(java.lang.String,boolean)" class="member-name-link">get_children</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> path, |
| boolean watch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get a list of paths of all the child nodes which exist immediately under path.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get_data(java.lang.String,boolean)" class="member-name-link">get_data</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> path, |
| boolean watch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the data from the node at path</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="VersionedData.html" title="class in org.apache.storm.cluster">VersionedData</a><byte[]></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get_data_with_version(java.lang.String,boolean)" class="member-name-link">get_data_with_version</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> path, |
| boolean watch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the data at the node along with its version.</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/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get_version(java.lang.String,boolean)" class="member-name-link">get_version</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> path, |
| boolean watch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the 'version' of the node at a path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get_worker_hb(java.lang.String,boolean)" class="member-name-link">get_worker_hb</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> path, |
| boolean watch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the heartbeat from the node at path</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/List.html" title="class or interface in java.util" class="external-link">List</a><<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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get_worker_hb_children(java.lang.String,boolean)" class="member-name-link">get_worker_hb_children</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> path, |
| boolean watch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get a list of paths of all the child nodes which exist immediately under path.</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="#mkdirs(java.lang.String,java.util.List)" class="member-name-link">mkdirs</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> path, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates nodes for path and all its parents.</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="#node_exists(java.lang.String,boolean)" class="member-name-link">node_exists</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> path, |
| boolean watch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Check if a node exists and optionally set a watch on the path.</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="#register(org.apache.storm.callback.ZKStateChangedCallback)" class="member-name-link">register</a><wbr>(<a href="../callback/ZKStateChangedCallback.html" title="interface in org.apache.storm.callback">ZKStateChangedCallback</a> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a callback function that gets called when CuratorEvents happen.</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="#set_data(java.lang.String,byte%5B%5D,java.util.List)" class="member-name-link">set_data</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the value of the node at path to data.</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="#set_ephemeral_node(java.lang.String,byte%5B%5D,java.util.List)" class="member-name-link">set_ephemeral_node</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates an ephemeral node at path.</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="#set_worker_hb(java.lang.String,byte%5B%5D,java.util.List)" class="member-name-link">set_worker_hb</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Write a worker heartbeat at the path.</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="#sync_path(java.lang.String)" class="member-name-link">sync_path</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> path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Force consistency on a path.</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="#unregister(java.lang.String)" class="member-name-link">unregister</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> id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Unregisters a callback function that was registered with register(...).</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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="<init>(java.util.Map,java.util.Map,org.apache.storm.cluster.ClusterStateContext)"> |
| <h3>ZKStateStorage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ZKStateStorage</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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <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><<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/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> authConf, |
| <a href="ClusterStateContext.html" title="class in org.apache.storm.cluster">ClusterStateContext</a> context)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </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="delete_node_blobstore(java.lang.String,java.lang.String)"> |
| <h3>delete_node_blobstore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">delete_node_blobstore</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> path, |
| <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> nimbusHostPortInfo)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#delete_node_blobstore(java.lang.String,java.lang.String)">IStateStorage</a></code></span></div> |
| <div class="block">Allows us to delete the znodes within /storm/blobstore/key_name whose znodes start with the corresponding nimbusHostPortInfo.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#delete_node_blobstore(java.lang.String,java.lang.String)">delete_node_blobstore</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - /storm/blobstore/key_name</dd> |
| <dd><code>nimbusHostPortInfo</code> - Contains the host port information of a nimbus node.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.storm.callback.ZKStateChangedCallback)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../callback/ZKStateChangedCallback.html" title="interface in org.apache.storm.callback">ZKStateChangedCallback</a> callback)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#register(org.apache.storm.callback.ZKStateChangedCallback)">IStateStorage</a></code></span></div> |
| <div class="block">Registers a callback function that gets called when CuratorEvents happen.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#register(org.apache.storm.callback.ZKStateChangedCallback)">register</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>callback</code> - is a clojure IFn that accepts the type - translated to clojure keyword as in zookeeper - and the path: (callback type |
| path)</dd> |
| <dt>Returns:</dt> |
| <dd>is an id that can be passed to unregister(...) to unregister the callback.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unregister(java.lang.String)"> |
| <h3>unregister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unregister</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> id)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#unregister(java.lang.String)">IStateStorage</a></code></span></div> |
| <div class="block">Unregisters a callback function that was registered with register(...).</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#unregister(java.lang.String)">unregister</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - is the String id that was returned from register(...).</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create_sequential(java.lang.String,byte[],java.util.List)"> |
| <h3>create_sequential</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">create_sequential</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#create_sequential(java.lang.String,byte%5B%5D,java.util.List)">IStateStorage</a></code></span></div> |
| <div class="block">Path will be appended with a monotonically increasing integer, a new node will be created there, and data will be put at that node.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#create_sequential(java.lang.String,byte%5B%5D,java.util.List)">create_sequential</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path that the monotonically increasing integer suffix will be added to.</dd> |
| <dd><code>data</code> - The data that will be written at the suffixed path's node.</dd> |
| <dd><code>acls</code> - The acls to apply to the path. May be null.</dd> |
| <dt>Returns:</dt> |
| <dd>The path with the integer suffix appended.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mkdirs(java.lang.String,java.util.List)"> |
| <h3>mkdirs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">mkdirs</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> path, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#mkdirs(java.lang.String,java.util.List)">IStateStorage</a></code></span></div> |
| <div class="block">Creates nodes for path and all its parents. Path elements are separated by a "/", as in *nix filesystem notation. Equivalent to mkdir |
| -p in *nix.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#mkdirs(java.lang.String,java.util.List)">mkdirs</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to create, along with all its parents.</dd> |
| <dd><code>acls</code> - The acls to apply to the path. May be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete_node(java.lang.String)"> |
| <h3>delete_node</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">delete_node</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> path)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#delete_node(java.lang.String)">IStateStorage</a></code></span></div> |
| <div class="block">Deletes the node at a given path, and any child nodes that may exist.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#delete_node(java.lang.String)">delete_node</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to delete</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set_ephemeral_node(java.lang.String,byte[],java.util.List)"> |
| <h3>set_ephemeral_node</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set_ephemeral_node</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#set_ephemeral_node(java.lang.String,byte%5B%5D,java.util.List)">IStateStorage</a></code></span></div> |
| <div class="block">Creates an ephemeral node at path. Ephemeral nodes are destroyed by the store when the client disconnects.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#set_ephemeral_node(java.lang.String,byte%5B%5D,java.util.List)">set_ephemeral_node</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path where a node will be created.</dd> |
| <dd><code>data</code> - The data to be written at the node.</dd> |
| <dd><code>acls</code> - The acls to apply to the path. May be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_version(java.lang.String,boolean)"> |
| <h3>get_version</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">get_version</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> path, |
| boolean watch)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_version(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Gets the 'version' of the node at a path. Optionally sets a watch on that node. The version should increase whenever a write |
| happens.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_version(java.lang.String,boolean)">get_version</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to get the version of.</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>The integer version of this node.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="node_exists(java.lang.String,boolean)"> |
| <h3>node_exists</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">node_exists</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#node_exists(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Check if a node exists and optionally set a watch on the path.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#node_exists(java.lang.String,boolean)">node_exists</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to check for the existence of a node.</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>Whether or not a node exists at path.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_children(java.lang.String,boolean)"> |
| <h3>get_children</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<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> <span class="element-name">get_children</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_children(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Get a list of paths of all the child nodes which exist immediately under path.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_children(java.lang.String,boolean)">get_children</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to look under</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>list of string paths under path.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#close()">IStateStorage</a></code></span></div> |
| <div class="block">Close the connection to the data store.</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> in interface <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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#close()">close</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set_data(java.lang.String,byte[],java.util.List)"> |
| <h3>set_data</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set_data</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#set_data(java.lang.String,byte%5B%5D,java.util.List)">IStateStorage</a></code></span></div> |
| <div class="block">Set the value of the node at path to data.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#set_data(java.lang.String,byte%5B%5D,java.util.List)">set_data</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path whose node we want to set.</dd> |
| <dd><code>data</code> - The data to put in the node.</dd> |
| <dd><code>acls</code> - The acls to apply to the path. May be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_data(java.lang.String,boolean)"> |
| <h3>get_data</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">get_data</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_data(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Get the data from the node at path</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_data(java.lang.String,boolean)">get_data</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to look under</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>The data at the node.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_data_with_version(java.lang.String,boolean)"> |
| <h3>get_data_with_version</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="VersionedData.html" title="class in org.apache.storm.cluster">VersionedData</a><byte[]></span> <span class="element-name">get_data_with_version</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_data_with_version(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Get the data at the node along with its version. Data is returned in an Map with the keys data and version.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_data_with_version(java.lang.String,boolean)">get_data_with_version</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to look under</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>the data with a version</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set_worker_hb(java.lang.String,byte[],java.util.List)"> |
| <h3>set_worker_hb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">set_worker_hb</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> path, |
| byte[] data, |
| <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><org.apache.storm.shade.org.apache.zookeeper.data.ACL> acls)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#set_worker_hb(java.lang.String,byte%5B%5D,java.util.List)">IStateStorage</a></code></span></div> |
| <div class="block">Write a worker heartbeat at the path.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#set_worker_hb(java.lang.String,byte%5B%5D,java.util.List)">set_worker_hb</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path whose node we want to set.</dd> |
| <dd><code>data</code> - The data to put in the node.</dd> |
| <dd><code>acls</code> - The acls to apply to the path. May be null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_worker_hb(java.lang.String,boolean)"> |
| <h3>get_worker_hb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">get_worker_hb</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_worker_hb(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Get the heartbeat from the node at path</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_worker_hb(java.lang.String,boolean)">get_worker_hb</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to look under</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>The heartbeat at the node.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get_worker_hb_children(java.lang.String,boolean)"> |
| <h3>get_worker_hb_children</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<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> <span class="element-name">get_worker_hb_children</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> path, |
| boolean watch)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#get_worker_hb_children(java.lang.String,boolean)">IStateStorage</a></code></span></div> |
| <div class="block">Get a list of paths of all the child nodes which exist immediately under path. This is similar to get_children, but must be used for |
| any nodes</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#get_worker_hb_children(java.lang.String,boolean)">get_worker_hb_children</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to look under</dd> |
| <dd><code>watch</code> - Whether or not to set a watch on the path. Watched paths emit events which are consumed by functions registered with the |
| register method. Very useful for catching updates to nodes.</dd> |
| <dt>Returns:</dt> |
| <dd>list of string paths under path.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete_worker_hb(java.lang.String)"> |
| <h3>delete_worker_hb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">delete_worker_hb</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> path)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#delete_worker_hb(java.lang.String)">IStateStorage</a></code></span></div> |
| <div class="block">Deletes the heartbeat at a given path, and any child nodes that may exist.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#delete_worker_hb(java.lang.String)">delete_worker_hb</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to delete.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add_listener(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener)"> |
| <h3>add_listener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add_listener</span><wbr><span class="parameters">(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#add_listener(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener)">IStateStorage</a></code></span></div> |
| <div class="block">Add a StateStorageListener to the connection.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#add_listener(org.apache.storm.shade.org.apache.curator.framework.state.ConnectionStateListener)">add_listener</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>listener</code> - A StateStorageListener to handle changing cluster state events.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sync_path(java.lang.String)"> |
| <h3>sync_path</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sync_path</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> path)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="IStateStorage.html#sync_path(java.lang.String)">IStateStorage</a></code></span></div> |
| <div class="block">Force consistency on a path. Any writes committed on the path before this call will be completely propagated when it returns.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="IStateStorage.html#sync_path(java.lang.String)">sync_path</a></code> in interface <code><a href="IStateStorage.html" title="interface in org.apache.storm.cluster">IStateStorage</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>path</code> - The path to synchronize.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
