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>CassandraDaemon (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/CassandraDaemon.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/CASConditions.html" title="interface in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface 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/CassandraDaemon.html" target="_top">Frames</a></li> <li><a href="CassandraDaemon.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><a href="#nested_class_summary">Nested</a> | </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.service</div> <h2 title="Class CassandraDaemon" class="title">Class CassandraDaemon</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.service.CassandraDaemon</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CassandraDaemon</span> extends java.lang.Object</pre> <div class="block">The <code>CassandraDaemon</code> is an abstraction for a Cassandra daemon service, which defines not only a way to activate and deactivate it, but also hooks into its lifecycle methods (see <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#setup()"><code>setup()</code></a>, <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#start()"><code>start()</code></a>, <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#stop()"><code>stop()</code></a> and <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#setup()"><code>setup()</code></a>).</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static interface </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></strong></code> </td> </tr> </table> </li> </ul>  <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/service/CassandraDaemon.html#MBEAN_NAME">MBEAN_NAME</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#nativeServer">nativeServer</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#thriftServer">thriftServer</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/service/CassandraDaemon.html#CassandraDaemon()">CassandraDaemon</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#activate()">activate</a></strong>()</code> <div class="block">A convenience method to initialize and start the daemon in one shot.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#deactivate()">deactivate</a></strong>()</code> <div class="block">A convenience method to stop and destroy the daemon in one shot.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#destroy()">destroy</a></strong>()</code> <div class="block">Clean up all resources obtained during the lifetime of the daemon.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#init(java.lang.String[])">init</a></strong>(java.lang.String[] arguments)</code> <div class="block">Initialize the Cassandra Daemon based on the given <a href="http://commons.apache.org/daemon/jsvc.html">Commons Daemon</a>-specific arguments.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#setup()">setup</a></strong>()</code> <div class="block">This is a hook for concrete daemons to initialize themselves suitably.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#start()">start</a></strong>()</code> <div class="block">Start the Cassandra Daemon, assuming that it has already been initialized via <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#init(java.lang.String[])"><code>init(String[])</code></a> Hook for JSVC</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#stop()">stop</a></strong>()</code> <div class="block">Stop the daemon, ideally in an idempotent manner.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#stop(java.lang.String[])">stop</a></strong>(java.lang.String[] args)</code> </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.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="MBEAN_NAME">  </a> <ul class="blockList"> <li class="blockList"> <h4>MBEAN_NAME</h4> <pre>public static final java.lang.String MBEAN_NAME</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.service.CassandraDaemon.MBEAN_NAME">Constant Field Values</a></dd></dl> </li> </ul> <a name="thriftServer">  </a> <ul class="blockList"> <li class="blockList"> <h4>thriftServer</h4> <pre>public <a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a> thriftServer</pre> </li> </ul> <a name="nativeServer">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>nativeServer</h4> <pre>public <a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface in org.apache.cassandra.service">CassandraDaemon.Server</a> nativeServer</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="CassandraDaemon()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>CassandraDaemon</h4> <pre>public CassandraDaemon()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="setup()">  </a> <ul class="blockList"> <li class="blockList"> <h4>setup</h4> <pre>protected void setup()</pre> <div class="block">This is a hook for concrete daemons to initialize themselves suitably. Subclasses should override this to finish the job (listening on ports, etc.)</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="init(java.lang.String[])">  </a> <ul class="blockList"> <li class="blockList"> <h4>init</h4> <pre>public void init(java.lang.String[] arguments) throws java.io.IOException</pre> <div class="block">Initialize the Cassandra Daemon based on the given <a href="http://commons.apache.org/daemon/jsvc.html">Commons Daemon</a>-specific arguments. To clarify, this is a hook for JSVC.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>arguments</code> - the arguments passed in from JSVC</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="start()">  </a> <ul class="blockList"> <li class="blockList"> <h4>start</h4> <pre>public void start()</pre> <div class="block">Start the Cassandra Daemon, assuming that it has already been initialized via <a href="../../../../org/apache/cassandra/service/CassandraDaemon.html#init(java.lang.String[])"><code>init(String[])</code></a> Hook for JSVC</div> </li> </ul> <a name="stop()">  </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public void stop()</pre> <div class="block">Stop the daemon, ideally in an idempotent manner. Hook for JSVC</div> </li> </ul> <a name="destroy()">  </a> <ul class="blockList"> <li class="blockList"> <h4>destroy</h4> <pre>public void destroy()</pre> <div class="block">Clean up all resources obtained during the lifetime of the daemon. This is a hook for JSVC.</div> </li> </ul> <a name="activate()">  </a> <ul class="blockList"> <li class="blockList"> <h4>activate</h4> <pre>public void activate()</pre> <div class="block">A convenience method to initialize and start the daemon in one shot.</div> </li> </ul> <a name="deactivate()">  </a> <ul class="blockList"> <li class="blockList"> <h4>deactivate</h4> <pre>public void deactivate()</pre> <div class="block">A convenience method to stop and destroy the daemon in one shot.</div> </li> </ul> <a name="stop(java.lang.String[])">  </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public static void stop(java.lang.String[] args)</pre> </li> </ul> <a name="main(java.lang.String[])">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>main</h4> <pre>public static void main(java.lang.String[] args)</pre> </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/CassandraDaemon.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/CASConditions.html" title="interface in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/CassandraDaemon.Server.html" title="interface 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/CassandraDaemon.html" target="_top">Frames</a></li> <li><a href="CassandraDaemon.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><a href="#nested_class_summary">Nested</a> | </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>