| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RedisKeyValueState (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RedisKeyValueState (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueStateIterator.html" title="class in org.apache.storm.redis.state"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/redis/state/RedisKeyValueState.html" target="_top">Frames</a></li> |
| <li><a href="RedisKeyValueState.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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="subNavList"> |
| <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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.redis.state</div> |
| <h2 title="Class RedisKeyValueState" class="title">Class RedisKeyValueState<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.redis.state.RedisKeyValueState<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><K,V>>, <a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><K,V>, <a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RedisKeyValueState<K,V></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><K,V></pre> |
| <div class="block"><p>A redis based implementation that persists the state in Redis.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a><byte[],byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#EMPTY_PENDING_COMMIT_MAP">EMPTY_PENDING_COMMIT_MAP</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#ITERATOR_CHUNK_SIZE">ITERATOR_CHUNK_SIZE</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#RedisKeyValueState-java.lang.String-">RedisKeyValueState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisClusterConfig-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-">RedisKeyValueState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a> jedisClusterConfig, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisPoolConfig-">RedisKeyValueState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisPoolConfig-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-">RedisKeyValueState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.container.RedisCommandsInstanceContainer-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-">RedisKeyValueState</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/container/RedisCommandsInstanceContainer.html" title="interface in org.apache.storm.redis.common.container">RedisCommandsInstanceContainer</a> container, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#commit--">commit</a></span>()</code> |
| <div class="block">Persist the current state.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#commit-long-">commit</a></span>(long txid)</code> |
| <div class="block">Commit a previously prepared transaction.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#delete-K-">delete</a></span>(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</code> |
| <div class="block">Deletes the value mapped to the key, if there is any.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#get-K-">get</a></span>(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</code> |
| <div class="block">Returns the value mapped to the key.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#get-K-V-">get</a></span>(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> defaultValue)</code> |
| <div class="block">Returns the value mapped to the key or defaultValue if no mapping is found.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#iterator--">iterator</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#prepareCommit-long-">prepareCommit</a></span>(long txid)</code> |
| <div class="block">Invoked by the framework to prepare a transaction for commit.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#put-K-V-">put</a></span>(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> value)</code> |
| <div class="block">Maps the value with the key.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html#rollback--">rollback</a></span>()</code> |
| <div class="block">Rollback a prepared transaction to the previously committed state.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ITERATOR_CHUNK_SIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ITERATOR_CHUNK_SIZE</h4> |
| <pre>public static final int ITERATOR_CHUNK_SIZE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.storm.redis.state.RedisKeyValueState.ITERATOR_CHUNK_SIZE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="EMPTY_PENDING_COMMIT_MAP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EMPTY_PENDING_COMMIT_MAP</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a><byte[],byte[]> EMPTY_PENDING_COMMIT_MAP</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="RedisKeyValueState-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RedisKeyValueState</h4> |
| <pre>public RedisKeyValueState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace)</pre> |
| </li> |
| </ul> |
| <a name="RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisPoolConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RedisKeyValueState</h4> |
| <pre>public RedisKeyValueState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig)</pre> |
| </li> |
| </ul> |
| <a name="RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisPoolConfig-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RedisKeyValueState</h4> |
| <pre>public RedisKeyValueState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisPoolConfig.html" title="class in org.apache.storm.redis.common.config">JedisPoolConfig</a> poolConfig, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</pre> |
| </li> |
| </ul> |
| <a name="RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.config.JedisClusterConfig-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RedisKeyValueState</h4> |
| <pre>public RedisKeyValueState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/config/JedisClusterConfig.html" title="class in org.apache.storm.redis.common.config">JedisClusterConfig</a> jedisClusterConfig, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</pre> |
| </li> |
| </ul> |
| <a name="RedisKeyValueState-java.lang.String-org.apache.storm.redis.common.container.RedisCommandsInstanceContainer-org.apache.storm.state.Serializer-org.apache.storm.state.Serializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RedisKeyValueState</h4> |
| <pre>public RedisKeyValueState(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace, |
| <a href="../../../../../org/apache/storm/redis/common/container/RedisCommandsInstanceContainer.html" title="interface in org.apache.storm.redis.common.container">RedisCommandsInstanceContainer</a> container, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>> keySerializer, |
| <a href="../../../../../org/apache/storm/state/Serializer.html" title="interface in org.apache.storm.state">Serializer</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>> valueSerializer)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="put-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="put-K-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public void put(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/KeyValueState.html#put-K-V-">KeyValueState</a></code></span></div> |
| <div class="block"><p>Maps the value with the key.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/KeyValueState.html#put-K-V-">put</a></code> in interface <code><a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dd><code>value</code> - the value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> get(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/KeyValueState.html#get-K-">KeyValueState</a></code></span></div> |
| <div class="block"><p>Returns the value mapped to the key.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/KeyValueState.html#get-K-">get</a></code> in interface <code><a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value or null if no mapping is found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-K-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> get(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key, |
| <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> defaultValue)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/KeyValueState.html#get-K-V-">KeyValueState</a></code></span></div> |
| <div class="block"><p>Returns the value mapped to the key or defaultValue if no mapping is found.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/KeyValueState.html#get-K-V-">get</a></code> in interface <code><a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| <dd><code>defaultValue</code> - the value to return if no mapping is found</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value or defaultValue if no mapping is found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="delete-java.lang.Object-"> |
| <!-- --> |
| </a><a name="delete-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public <a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a> delete(<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a> key)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/KeyValueState.html#delete-K-">KeyValueState</a></code></span></div> |
| <div class="block"><p>Deletes the value mapped to the key, if there is any.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/KeyValueState.html#delete-K-">delete</a></code> in interface <code><a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>>> iterator()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">K</a>,<a href="../../../../../org/apache/storm/redis/state/RedisKeyValueState.html" title="type parameter in RedisKeyValueState">V</a>>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareCommit-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareCommit</h4> |
| <pre>public void prepareCommit(long txid)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/State.html#prepareCommit-long-">State</a></code></span></div> |
| <div class="block"><p>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></p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/State.html#prepareCommit-long-">prepareCommit</a></code> in interface <code><a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txid</code> - the transaction id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commit-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit(long txid)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/State.html#commit-long-">State</a></code></span></div> |
| <div class="block"><p>Commit a previously prepared transaction. It should be possible to retrieve a committed state later.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/State.html#commit-long-">commit</a></code> in interface <code><a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>txid</code> - the transaction id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="commit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commit</h4> |
| <pre>public void commit()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/State.html#commit--">State</a></code></span></div> |
| <div class="block"><p>Persist the current state. This is used when the component manages the state.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/State.html#commit--">commit</a></code> in interface <code><a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rollback--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rollback</h4> |
| <pre>public void rollback()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/state/State.html#rollback--">State</a></code></span></div> |
| <div class="block"><p>Rollback a prepared transaction to the previously committed state.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/state/State.html#rollback--">rollback</a></code> in interface <code><a href="../../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/storm/redis/state/RedisKeyValueStateIterator.html" title="class in org.apache.storm.redis.state"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/redis/state/RedisKeyValueState.html" target="_top">Frames</a></li> |
| <li><a href="RedisKeyValueState.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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="subNavList"> |
| <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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
