cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>PropertyFileSnitch (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/PropertyFileSnitch.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/OldNetworkTopologyStrategy.html" title="class in org.apache.cassandra.locator"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/locator/RackInferringSnitch.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/PropertyFileSnitch.html" target="_top">Frames</a></li> <li><a href="PropertyFileSnitch.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"> </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.locator</div> <h2 title="Class PropertyFileSnitch" class="title">Class PropertyFileSnitch</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html" title="class in org.apache.cassandra.locator">org.apache.cassandra.locator.AbstractEndpointSnitch</a></li> <li> <ul class="inheritance"> <li><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html" title="class in org.apache.cassandra.locator">org.apache.cassandra.locator.AbstractNetworkTopologySnitch</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.locator.PropertyFileSnitch</li> </ul> </li> </ul> </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/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">PropertyFileSnitch</span> extends <a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html" title="class in org.apache.cassandra.locator">AbstractNetworkTopologySnitch</a></pre> <div class="block">Used to determine if two IP's are in the same datacenter or on the same rack. <p/> Based on a properties file in the following format: 10.0.0.13=DC1:RAC2 10.21.119.14=DC3:RAC2 10.20.114.15=DC2:RAC2 default=DC1:r1</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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"> </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 java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#SNITCH_PROPERTIES_FILENAME">SNITCH_PROPERTIES_FILENAME</a></strong></code> </td> </tr> </table> </li> </ul>  <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/PropertyFileSnitch.html#PropertyFileSnitch()">PropertyFileSnitch</a></strong>()</code> </td> </tr> </table> </li> </ul>  <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.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#getDatacenter(java.net.InetAddress)">getDatacenter</a></strong>(java.net.InetAddress endpoint)</code> <div class="block">Return the data center for which an endpoint resides in</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#getEndpointInfo(java.net.InetAddress)">getEndpointInfo</a></strong>(java.net.InetAddress endpoint)</code> <div class="block">Get the raw information about an end point</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#getRack(java.net.InetAddress)">getRack</a></strong>(java.net.InetAddress endpoint)</code> <div class="block">Return the rack for which an endpoint resides in</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#gossiperStarting()">gossiperStarting</a></strong>()</code> <div class="block">called after Gossiper instance exists immediately before it starts gossiping</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/locator/PropertyFileSnitch.html#reloadConfiguration()">reloadConfiguration</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.locator.AbstractNetworkTopologySnitch">  </a> <h3>Methods inherited from class org.apache.cassandra.locator.<a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html" title="class in org.apache.cassandra.locator">AbstractNetworkTopologySnitch</a></h3> <code><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html#compareEndpoints(java.net.InetAddress,%20java.net.InetAddress,%20java.net.InetAddress)">compareEndpoints</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.locator.AbstractEndpointSnitch">  </a> <h3>Methods inherited from class org.apache.cassandra.locator.<a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html" title="class in org.apache.cassandra.locator">AbstractEndpointSnitch</a></h3> <code><a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html#getSortedListByProximity(java.net.InetAddress,%20java.util.Collection)">getSortedListByProximity</a>, <a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html#isWorthMergingForRangeQuery(java.util.List,%20java.util.List,%20java.util.List)">isWorthMergingForRangeQuery</a>, <a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html#sortByProximity(java.net.InetAddress,%20java.util.List)">sortByProximity</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">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="SNITCH_PROPERTIES_FILENAME">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>SNITCH_PROPERTIES_FILENAME</h4> <pre>public static final java.lang.String SNITCH_PROPERTIES_FILENAME</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.locator.PropertyFileSnitch.SNITCH_PROPERTIES_FILENAME">Constant Field Values</a></dd></dl> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="PropertyFileSnitch()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>PropertyFileSnitch</h4> <pre>public PropertyFileSnitch() throws <a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre> <dl><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> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getEndpointInfo(java.net.InetAddress)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getEndpointInfo</h4> <pre>public java.lang.String[] getEndpointInfo(java.net.InetAddress endpoint)</pre> <div class="block">Get the raw information about an end point</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - endpoint to process</dd> <dt><span class="strong">Returns:</span></dt><dd>a array of string with the first index being the data center and the second being the rack</dd></dl> </li> </ul> <a name="getDatacenter(java.net.InetAddress)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getDatacenter</h4> <pre>public java.lang.String getDatacenter(java.net.InetAddress endpoint)</pre> <div class="block">Return the data center for which an endpoint resides in</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html#getDatacenter(java.net.InetAddress)">getDatacenter</a></code> in interface <code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a></code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html#getDatacenter(java.net.InetAddress)">getDatacenter</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html" title="class in org.apache.cassandra.locator">AbstractNetworkTopologySnitch</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - the endpoint to process</dd> <dt><span class="strong">Returns:</span></dt><dd>string of data center</dd></dl> </li> </ul> <a name="getRack(java.net.InetAddress)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getRack</h4> <pre>public java.lang.String getRack(java.net.InetAddress endpoint)</pre> <div class="block">Return the rack for which an endpoint resides in</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html#getRack(java.net.InetAddress)">getRack</a></code> in interface <code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a></code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html#getRack(java.net.InetAddress)">getRack</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractNetworkTopologySnitch.html" title="class in org.apache.cassandra.locator">AbstractNetworkTopologySnitch</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>endpoint</code> - the endpoint to process</dd> <dt><span class="strong">Returns:</span></dt><dd>string of rack</dd></dl> </li> </ul> <a name="reloadConfiguration()">  </a> <ul class="blockList"> <li class="blockList"> <h4>reloadConfiguration</h4> <pre>public void reloadConfiguration() throws <a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre> <dl><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="gossiperStarting()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>gossiperStarting</h4> <pre>public void gossiperStarting()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html#gossiperStarting()">IEndpointSnitch</a></code></strong></div> <div class="block">called after Gossiper instance exists immediately before it starts gossiping</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html#gossiperStarting()">gossiperStarting</a></code> in interface <code><a href="../../../../org/apache/cassandra/locator/IEndpointSnitch.html" title="interface in org.apache.cassandra.locator">IEndpointSnitch</a></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html#gossiperStarting()">gossiperStarting</a></code> in class <code><a href="../../../../org/apache/cassandra/locator/AbstractEndpointSnitch.html" title="class in org.apache.cassandra.locator">AbstractEndpointSnitch</a></code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/PropertyFileSnitch.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/OldNetworkTopologyStrategy.html" title="class in org.apache.cassandra.locator"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/locator/RackInferringSnitch.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/PropertyFileSnitch.html" target="_top">Frames</a></li> <li><a href="PropertyFileSnitch.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"> </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>