UNPKG

cassandra-server

Version:

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

370 lines (368 loc) 14.8 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:30 CEST 2014 --> <title>RepairJob (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="RepairJob (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/RepairJob.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/repair/RepairFuture.html" title="class in org.apache.cassandra.repair"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/repair/RepairJobDesc.html" title="class in org.apache.cassandra.repair"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/repair/RepairJob.html" target="_top">Frames</a></li> <li><a href="RepairJob.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.repair</div> <h2 title="Class RepairJob" class="title">Class RepairJob</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.repair.RepairJob</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">RepairJob</span> extends java.lang.Object</pre> <div class="block">RepairJob runs repair on given ColumnFamily.</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><a href="../../../../org/apache/cassandra/repair/RepairJobDesc.html" title="class in org.apache.cassandra.repair">RepairJobDesc</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/repair/RepairJob.html#desc">desc</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/repair/RepairJob.html#RepairJob(org.apache.cassandra.repair.IRepairJobEventListener,%20java.util.UUID,%20java.util.UUID,%20java.lang.String,%20java.lang.String,%20org.apache.cassandra.dht.Range,%20boolean,%20com.google.common.util.concurrent.ListeningExecutorService)">RepairJob</a></strong>(<a href="../../../../org/apache/cassandra/repair/IRepairJobEventListener.html" title="interface in org.apache.cassandra.repair">IRepairJobEventListener</a>&nbsp;listener, java.util.UUID&nbsp;parentSessionId, java.util.UUID&nbsp;sessionId, java.lang.String&nbsp;keyspace, java.lang.String&nbsp;columnFamily, <a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a>&lt;<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>&gt;&nbsp;range, boolean&nbsp;isSequential, com.google.common.util.concurrent.ListeningExecutorService&nbsp;taskExecutor)</code> <div class="block">Create repair job to run on specific columnfamily</div> </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>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/repair/RepairJob.html#addTree(java.net.InetAddress,%20org.apache.cassandra.utils.MerkleTree)">addTree</a></strong>(java.net.InetAddress&nbsp;endpoint, <a href="../../../../org/apache/cassandra/utils/MerkleTree.html" title="class in org.apache.cassandra.utils">MerkleTree</a>&nbsp;tree)</code> <div class="block">Add a new received tree and return the number of remaining tree to be received for the job to be complete.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/repair/RepairJob.html#isFailed()">isFailed</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/repair/RepairJob.html#sendTreeRequests(java.util.Collection)">sendTreeRequests</a></strong>(java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;endpoints)</code> <div class="block">Send merkle tree request to every involved neighbor.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/repair/RepairJob.html#submitDifferencers()">submitDifferencers</a></strong>()</code> <div class="block">Submit differencers for running.</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&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="desc"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>desc</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/repair/RepairJobDesc.html" title="class in org.apache.cassandra.repair">RepairJobDesc</a> desc</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="RepairJob(org.apache.cassandra.repair.IRepairJobEventListener, java.util.UUID, java.util.UUID, java.lang.String, java.lang.String, org.apache.cassandra.dht.Range, boolean, com.google.common.util.concurrent.ListeningExecutorService)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>RepairJob</h4> <pre>public&nbsp;RepairJob(<a href="../../../../org/apache/cassandra/repair/IRepairJobEventListener.html" title="interface in org.apache.cassandra.repair">IRepairJobEventListener</a>&nbsp;listener, java.util.UUID&nbsp;parentSessionId, java.util.UUID&nbsp;sessionId, java.lang.String&nbsp;keyspace, java.lang.String&nbsp;columnFamily, <a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a>&lt;<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>&gt;&nbsp;range, boolean&nbsp;isSequential, com.google.common.util.concurrent.ListeningExecutorService&nbsp;taskExecutor)</pre> <div class="block">Create repair job to run on specific columnfamily</div> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="isFailed()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isFailed</h4> <pre>public&nbsp;boolean&nbsp;isFailed()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if this job failed</dd></dl> </li> </ul> <a name="sendTreeRequests(java.util.Collection)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sendTreeRequests</h4> <pre>public&nbsp;void&nbsp;sendTreeRequests(java.util.Collection&lt;java.net.InetAddress&gt;&nbsp;endpoints)</pre> <div class="block">Send merkle tree request to every involved neighbor.</div> </li> </ul> <a name="addTree(java.net.InetAddress, org.apache.cassandra.utils.MerkleTree)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addTree</h4> <pre>public&nbsp;int&nbsp;addTree(java.net.InetAddress&nbsp;endpoint, <a href="../../../../org/apache/cassandra/utils/MerkleTree.html" title="class in org.apache.cassandra.utils">MerkleTree</a>&nbsp;tree)</pre> <div class="block">Add a new received tree and return the number of remaining tree to be received for the job to be complete. Callers may assume exactly one addTree call will result in zero remaining endpoints.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - address of the endpoint that sent response</dd><dd><code>tree</code> - sent Merkle tree or null if validation failed on endpoint</dd> <dt><span class="strong">Returns:</span></dt><dd>the number of responses waiting to receive</dd></dl> </li> </ul> <a name="submitDifferencers()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>submitDifferencers</h4> <pre>public&nbsp;void&nbsp;submitDifferencers()</pre> <div class="block">Submit differencers for running. All tree *must* have been received before this is called.</div> </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/RepairJob.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/repair/RepairFuture.html" title="class in org.apache.cassandra.repair"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/repair/RepairJobDesc.html" title="class in org.apache.cassandra.repair"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/repair/RepairJob.html" target="_top">Frames</a></li> <li><a href="RepairJob.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>