| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RedisKeyValueState (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.redis.state, class: RedisKeyValueState"> |
| <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/RedisKeyValueState.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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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.redis.state</a></div> |
| <h1 title="Class RedisKeyValueState" class="title">Class RedisKeyValueState<K,<wbr>V></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.redis.state.RedisKeyValueState<K,<wbr>V></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/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><K,<wbr>V>></code>, <code><a href="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><K,<wbr>V></code>, <code><a href="../../state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RedisKeyValueState<K,<wbr>V></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="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><K,<wbr>V></span></div> |
| <div class="block">A redis based implementation that persists the state in Redis.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/NavigableMap.html" title="class or interface in java.util" class="external-link">NavigableMap</a><byte[],<wbr>byte[]></code></div> |
| <div class="col-second even-row-color"><code><a href="#EMPTY_PENDING_COMMIT_MAP" class="member-name-link">EMPTY_PENDING_COMMIT_MAP</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#ITERATOR_CHUNK_SIZE" class="member-name-link">ITERATOR_CHUNK_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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.lang.String)" class="member-name-link">RedisKeyValueState</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> namespace)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)" class="member-name-link">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a> jedisClusterConfig, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.redis.common.config.JedisPoolConfig)" class="member-name-link">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.redis.common.config.JedisPoolConfig,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)" class="member-name-link">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.redis.common.container.RedisCommandsInstanceContainer,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)" class="member-name-link">RedisKeyValueState</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> namespace, |
| <a href="../common/container/RedisCommandsInstanceContainer.html" title="interface in org.apache.storm.redis.common.container">RedisCommandsInstanceContainer</a> container, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</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="#commit()" class="member-name-link">commit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Persist the current state.</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="#commit(long)" class="member-name-link">commit</a><wbr>(long txid)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Commit a previously prepared transaction.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(K)" class="member-name-link">delete</a><wbr>(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes the value mapped to the key, if there is any.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</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(K)" class="member-name-link">get</a><wbr>(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value mapped to the key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</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(K,V)" class="member-name-link">get</a><wbr>(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value mapped to the key or defaultValue if no mapping is found.</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/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#prepareCommit(long)" class="member-name-link">prepareCommit</a><wbr>(long txid)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Invoked by the framework to prepare a transaction for commit.</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="#put(K,V)" class="member-name-link">put</a><wbr>(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Maps the value with the key.</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="#rollback()" class="member-name-link">rollback</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Rollback a prepared transaction to the previously committed state.</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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ITERATOR_CHUNK_SIZE"> |
| <h3>ITERATOR_CHUNK_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">ITERATOR_CHUNK_SIZE</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.redis.state.RedisKeyValueState.ITERATOR_CHUNK_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EMPTY_PENDING_COMMIT_MAP"> |
| <h3>EMPTY_PENDING_COMMIT_MAP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/NavigableMap.html" title="class or interface in java.util" class="external-link">NavigableMap</a><byte[],<wbr>byte[]></span> <span class="element-name">EMPTY_PENDING_COMMIT_MAP</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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.lang.String)"> |
| <h3>RedisKeyValueState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedisKeyValueState</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> namespace)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.redis.common.config.JedisPoolConfig)"> |
| <h3>RedisKeyValueState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.redis.common.config.JedisPoolConfig,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)"> |
| <h3>RedisKeyValueState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.redis.common.config.JedisClusterConfig,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)"> |
| <h3>RedisKeyValueState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedisKeyValueState</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> namespace, |
| <a href="../common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a> jedisClusterConfig, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,org.apache.storm.redis.common.container.RedisCommandsInstanceContainer,org.apache.storm.state.Serializer,org.apache.storm.state.Serializer)"> |
| <h3>RedisKeyValueState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedisKeyValueState</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> namespace, |
| <a href="../common/container/RedisCommandsInstanceContainer.html" title="interface in org.apache.storm.redis.common.container">RedisCommandsInstanceContainer</a> container, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</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="put(K,V)"> |
| <h3 id="put(java.lang.Object,java.lang.Object)">put</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">put</span><wbr><span class="parameters">(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/KeyValueState.html#put(K,V)">KeyValueState</a></code></span></div> |
| <div class="block">Maps the value with the key.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/KeyValueState.html#put(K,V)">put</a></code> in interface <code><a href="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key</dd> |
| <dd><code>value</code> - the value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(K)"> |
| <h3 id="get(java.lang.Object)">get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/KeyValueState.html#get(K)">KeyValueState</a></code></span></div> |
| <div class="block">Returns the value mapped to the key.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/KeyValueState.html#get(K)">get</a></code> in interface <code><a href="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key</dd> |
| <dt>Returns:</dt> |
| <dd>the value or null if no mapping is found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(K,V)"> |
| <h3 id="get(java.lang.Object,java.lang.Object)">get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> defaultValue)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/KeyValueState.html#get(K,V)">KeyValueState</a></code></span></div> |
| <div class="block">Returns the value mapped to the key or defaultValue if no mapping is found.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/KeyValueState.html#get(K,V)">get</a></code> in interface <code><a href="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key</dd> |
| <dd><code>defaultValue</code> - the value to return if no mapping is found</dd> |
| <dt>Returns:</dt> |
| <dd>the value or defaultValue if no mapping is found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(K)"> |
| <h3 id="delete(java.lang.Object)">delete</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></span> <span class="element-name">delete</span><wbr><span class="parameters">(<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/KeyValueState.html#delete(K)">KeyValueState</a></code></span></div> |
| <div class="block">Deletes the value mapped to the key, if there is any.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/KeyValueState.html#delete(K)">delete</a></code> in interface <code><a href="../../state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="iterator()"> |
| <h3>iterator</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/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<wbr><a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>>></span> <span class="element-name">iterator</span>()</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/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prepareCommit(long)"> |
| <h3>prepareCommit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepareCommit</span><wbr><span class="parameters">(long txid)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/State.html#prepareCommit(long)">State</a></code></span></div> |
| <div class="block">Invoked by the framework to prepare a transaction for commit. It should be possible to commit the prepared state later. |
| <p> |
| The same txid can be prepared again, but the next txid cannot be prepared when previous one is not yet committed. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/State.html#prepareCommit(long)">prepareCommit</a></code> in interface <code><a href="../../state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>txid</code> - the transaction id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commit(long)"> |
| <h3>commit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">commit</span><wbr><span class="parameters">(long txid)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/State.html#commit(long)">State</a></code></span></div> |
| <div class="block">Commit a previously prepared transaction. It should be possible to retrieve a committed state later.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/State.html#commit(long)">commit</a></code> in interface <code><a href="../../state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>txid</code> - the transaction id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="commit()"> |
| <h3>commit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">commit</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/State.html#commit()">State</a></code></span></div> |
| <div class="block">Persist the current state. This is used when the component manages the state.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/State.html#commit()">commit</a></code> in interface <code><a href="../../state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rollback()"> |
| <h3>rollback</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">rollback</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../state/State.html#rollback()">State</a></code></span></div> |
| <div class="block">Rollback a prepared transaction to the previously committed state.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../state/State.html#rollback()">rollback</a></code> in interface <code><a href="../../state/State.html" title="interface in org.apache.storm.state">State</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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
