cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
365 lines (364 loc) • 20.4 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>OldNetworkTopologyStrategy (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="OldNetworkTopologyStrategy (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/OldNetworkTopologyStrategy.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/locator/NetworkTopologyStrategy.html" title="class in org.apache.cassandra.locator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html" title="class in org.apache.cassandra.locator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/locator/OldNetworkTopologyStrategy.html" target="_top">Frames</a></li>
<li><a href="OldNetworkTopologyStrategy.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="#fields_inherited_from_class_org.apache.cassandra.locator.AbstractReplicationStrategy">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>Field | </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.cassandra.locator</div>
<h2 title="Class OldNetworkTopologyStrategy" class="title">Class OldNetworkTopologyStrategy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">org.apache.cassandra.locator.AbstractReplicationStrategy</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.locator.OldNetworkTopologyStrategy</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">OldNetworkTopologyStrategy</span>
extends <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></pre>
<div class="block">This Replication Strategy returns the nodes responsible for a given
key but respects rack awareness. It places one replica in a
different data center from the first (if there is any such data center),
the third replica in a different rack in the first datacenter, and
any remaining replicas on the first unused nodes on the ring.</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.locator.AbstractReplicationStrategy">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.locator.<a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></h3>
<code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#configOptions">configOptions</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#snitch">snitch</a></code></li>
</ul>
</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"> </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/locator/OldNetworkTopologyStrategy.html#OldNetworkTopologyStrategy(java.lang.String,%20org.apache.cassandra.locator.TokenMetadata,%20org.apache.cassandra.locator.IEndpointSnitch,%20java.util.Map)">OldNetworkTopologyStrategy</a></strong>(java.lang.String keyspaceName,
<a href="../../../../org/apache/cassandra/locator/TokenMetadata.html" title="class in org.apache.cassandra.locator">TokenMetadata</a> tokenMetadata,
<a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a> snitch,
java.util.Map<java.lang.String,java.lang.String> configOptions)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </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<java.net.InetAddress></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/OldNetworkTopologyStrategy.html#calculateNaturalEndpoints(org.apache.cassandra.dht.Token,%20org.apache.cassandra.locator.TokenMetadata)">calculateNaturalEndpoints</a></strong>(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> token,
<a href="../../../../org/apache/cassandra/locator/TokenMetadata.html" title="class in org.apache.cassandra.locator">TokenMetadata</a> metadata)</code>
<div class="block">calculate the natural endpoints for the given token</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/OldNetworkTopologyStrategy.html#getReplicationFactor()">getReplicationFactor</a></strong>()</code>
<div class="block">calculate the RF based on strategy_options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Collection<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/OldNetworkTopologyStrategy.html#recognizedOptions()">recognizedOptions</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/OldNetworkTopologyStrategy.html#validateOptions()">validateOptions</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.locator.AbstractReplicationStrategy">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.locator.<a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></h3>
<code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#createReplicationStrategy(java.lang.String,%20java.lang.Class,%20org.apache.cassandra.locator.TokenMetadata,%20org.apache.cassandra.locator.IEndpointSnitch,%20java.util.Map)">createReplicationStrategy</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getAddressRanges()">getAddressRanges</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getAddressRanges(org.apache.cassandra.locator.TokenMetadata)">getAddressRanges</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getCachedEndpoints(org.apache.cassandra.dht.Token)">getCachedEndpoints</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getClass(java.lang.String)">getClass</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getNaturalEndpoints(org.apache.cassandra.dht.RingPosition)">getNaturalEndpoints</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getPendingAddressRanges(org.apache.cassandra.locator.TokenMetadata,%20java.util.Collection,%20java.net.InetAddress)">getPendingAddressRanges</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getPendingAddressRanges(org.apache.cassandra.locator.TokenMetadata,%20org.apache.cassandra.dht.Token,%20java.net.InetAddress)">getPendingAddressRanges</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getRangeAddresses(org.apache.cassandra.locator.TokenMetadata)">getRangeAddresses</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getWriteResponseHandler(java.util.Collection,%20java.util.Collection,%20org.apache.cassandra.db.ConsistencyLevel,%20java.lang.Runnable,%20org.apache.cassandra.db.WriteType)">getWriteResponseHandler</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#validateReplicationFactor(java.lang.String)">validateReplicationFactor</a>, <a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#validateReplicationStrategy(java.lang.String,%20java.lang.Class,%20org.apache.cassandra.locator.TokenMetadata,%20org.apache.cassandra.locator.IEndpointSnitch,%20java.util.Map)">validateReplicationStrategy</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OldNetworkTopologyStrategy(java.lang.String, org.apache.cassandra.locator.TokenMetadata, org.apache.cassandra.locator.IEndpointSnitch, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OldNetworkTopologyStrategy</h4>
<pre>public OldNetworkTopologyStrategy(java.lang.String keyspaceName,
<a href="../../../../org/apache/cassandra/locator/TokenMetadata.html" title="class in org.apache.cassandra.locator">TokenMetadata</a> tokenMetadata,
<a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a> snitch,
java.util.Map<java.lang.String,java.lang.String> configOptions)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="calculateNaturalEndpoints(org.apache.cassandra.dht.Token, org.apache.cassandra.locator.TokenMetadata)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateNaturalEndpoints</h4>
<pre>public java.util.List<java.net.InetAddress> calculateNaturalEndpoints(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> token,
<a href="../../../../org/apache/cassandra/locator/TokenMetadata.html" title="class in org.apache.cassandra.locator">TokenMetadata</a> metadata)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#calculateNaturalEndpoints(org.apache.cassandra.dht.Token,%20org.apache.cassandra.locator.TokenMetadata)">AbstractReplicationStrategy</a></code></strong></div>
<div class="block">calculate the natural endpoints for the given token</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#calculateNaturalEndpoints(org.apache.cassandra.dht.Token,%20org.apache.cassandra.locator.TokenMetadata)">calculateNaturalEndpoints</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>token</code> - the token the natural endpoints are requested for</dd>
<dt><span class="strong">Returns:</span></dt><dd>a copy of the natural endpoints for the given token</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getNaturalEndpoints(org.apache.cassandra.dht.RingPosition)"><code>AbstractReplicationStrategy.getNaturalEndpoints(org.apache.cassandra.dht.RingPosition)</code></a></dd></dl>
</li>
</ul>
<a name="getReplicationFactor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplicationFactor</h4>
<pre>public int getReplicationFactor()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getReplicationFactor()">AbstractReplicationStrategy</a></code></strong></div>
<div class="block">calculate the RF based on strategy_options. When overwriting, ensure that this get()
is FAST, as this is called often.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#getReplicationFactor()">getReplicationFactor</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the replication factor</dd></dl>
</li>
</ul>
<a name="validateOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateOptions</h4>
<pre>public void validateOptions()
throws <a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#validateOptions()">validateOptions</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></code></dd></dl>
</li>
</ul>
<a name="recognizedOptions()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>recognizedOptions</h4>
<pre>public java.util.Collection<java.lang.String> recognizedOptions()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html#recognizedOptions()">recognizedOptions</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractReplicationStrategy.html" title="class in org.apache.cassandra.locator">AbstractReplicationStrategy</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><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/OldNetworkTopologyStrategy.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/locator/NetworkTopologyStrategy.html" title="class in org.apache.cassandra.locator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html" title="class in org.apache.cassandra.locator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/locator/OldNetworkTopologyStrategy.html" target="_top">Frames</a></li>
<li><a href="OldNetworkTopologyStrategy.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="#fields_inherited_from_class_org.apache.cassandra.locator.AbstractReplicationStrategy">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>Field | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>