UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

414 lines (413 loc) 20.2 kB
<!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 (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 --> <title>RangeSliceResponseResolver (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="RangeSliceResponseResolver (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/RangeSliceResponseResolver.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/RangeSliceVerbHandler.html" title="class in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/RangeSliceResponseResolver.html" target="_top">Frames</a></li> <li><a href="RangeSliceResponseResolver.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.cassandra.service</div> <h2 title="Class RangeSliceResponseResolver" class="title">Class RangeSliceResponseResolver</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.service.RangeSliceResponseResolver</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</dd> </dl> <hr> <br> <pre>public class <span class="strong">RangeSliceResponseResolver</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</pre> <div class="block">Turns RangeSliceReply objects into row (string -> CF) maps, resolving to the most recent ColumnFamily and setting up read repairs as necessary.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd">&nbsp;</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>java.util.List&lt;<a href="../../../../org/apache/cassandra/net/AsyncOneResponse.html" title="class in org.apache.cassandra.net">AsyncOneResponse</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#repairResults">repairResults</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.util.Collection&lt;<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#responses">responses</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#RangeSliceResponseResolver(java.lang.String,%20long)">RangeSliceResponseResolver</a></strong>(java.lang.String&nbsp;keyspaceName, long&nbsp;timestamp)</code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#getData()">getData</a></strong>()</code> <div class="block">returns the data response without comparing with any digests</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#getMessages()">getMessages</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#isDataPresent()">isDataPresent</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#preprocess(org.apache.cassandra.net.MessageIn)">preprocess</a></strong>(<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&nbsp;message)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#resolve()">resolve</a></strong>()</code> <div class="block">This Method resolves the responses that are passed in .</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/RangeSliceResponseResolver.html#setSources(java.util.List)">setSources</a></strong>(java.util.List&lt;java.net.InetAddress&gt;&nbsp;endpoints)</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="responses"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>responses</h4> <pre>protected final&nbsp;java.util.Collection&lt;<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>&gt;&gt; responses</pre> </li> </ul> <a name="repairResults"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>repairResults</h4> <pre>public final&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/net/AsyncOneResponse.html" title="class in org.apache.cassandra.net">AsyncOneResponse</a>&gt; repairResults</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="RangeSliceResponseResolver(java.lang.String, long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>RangeSliceResponseResolver</h4> <pre>public&nbsp;RangeSliceResponseResolver(java.lang.String&nbsp;keyspaceName, long&nbsp;timestamp)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="setSources(java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSources</h4> <pre>public&nbsp;void&nbsp;setSources(java.util.List&lt;java.net.InetAddress&gt;&nbsp;endpoints)</pre> </li> </ul> <a name="getData()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getData</h4> <pre>public&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&nbsp;getData()</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#getData()">IResponseResolver</a></code></strong></div> <div class="block">returns the data response without comparing with any digests</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#getData()">getData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</code></dd> </dl> </li> </ul> <a name="resolve()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>resolve</h4> <pre>public&nbsp;java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&nbsp;resolve()</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#resolve()">IResponseResolver</a></code></strong></div> <div class="block">This Method resolves the responses that are passed in . for example : if its write response then all we get is true or false return values which implies if the writes were successful but for reads its more complicated you need to look at the responses and then based on differences schedule repairs . Hence you need to derive a response resolver based on your needs from this interface.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#resolve()">resolve</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</code></dd> </dl> </li> </ul> <a name="preprocess(org.apache.cassandra.net.MessageIn)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>preprocess</h4> <pre>public&nbsp;void&nbsp;preprocess(<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&nbsp;message)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#preprocess(org.apache.cassandra.net.MessageIn)">preprocess</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</code></dd> </dl> </li> </ul> <a name="isDataPresent()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isDataPresent</h4> <pre>public&nbsp;boolean&nbsp;isDataPresent()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#isDataPresent()">isDataPresent</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</code></dd> </dl> </li> </ul> <a name="getMessages()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getMessages</h4> <pre>public&nbsp;java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/net/MessageIn.html" title="class in org.apache.cassandra.net">MessageIn</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>&gt;&gt;&nbsp;getMessages()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html#getMessages()">getMessages</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IResponseResolver.html" title="interface in org.apache.cassandra.service">IResponseResolver</a>&lt;<a href="../../../../org/apache/cassandra/db/RangeSliceReply.html" title="class in org.apache.cassandra.db">RangeSliceReply</a>,java.lang.Iterable&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&gt;</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/RangeSliceResponseResolver.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/RangeSliceVerbHandler.html" title="class in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/RangeSliceResponseResolver.html" target="_top">Frames</a></li> <li><a href="RangeSliceResponseResolver.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>