UNPKG

cassandra-server

Version:

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

542 lines (541 loc) 18 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>CliSessionState (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="CliSessionState (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/CliSessionState.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/cli/CliOptions.html" title="class in org.apache.cassandra.cli"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cli/CliUserHelp.html" title="class in org.apache.cassandra.cli"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cli/CliSessionState.html" target="_top">Frames</a></li> <li><a href="CliSessionState.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.cli</div> <h2 title="Class CliSessionState" class="title">Class CliSessionState</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cli.CliSessionState</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CliSessionState</span> extends java.lang.Object</pre> <div class="block">Used to hold the state for the CLI.</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#batch">batch</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#debug">debug</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/EncryptionOptions.html" title="class in org.apache.cassandra.config">EncryptionOptions</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#encOptions">encOptions</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.io.PrintStream</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#err">err</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#filename">filename</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#hostName">hostName</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.io.InputStream</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#in">in</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#jmxPassword">jmxPassword</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#jmxPort">jmxPort</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#jmxUsername">jmxUsername</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#keyspace">keyspace</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.io.PrintStream</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#out">out</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#password">password</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#thriftPort">thriftPort</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#transportFactory">transportFactory</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#username">username</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/cli/CliSessionState.html#verbose">verbose</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/cli/CliSessionState.html#CliSessionState()">CliSessionState</a></strong>()</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><a href="../../../../org/apache/cassandra/tools/NodeProbe.html" title="class in org.apache.cassandra.tools">NodeProbe</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#getNodeProbe()">getNodeProbe</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#inFileMode()">inFileMode</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/cli/CliSessionState.html#setErr(java.io.PrintStream)">setErr</a></strong>(java.io.PrintStream&nbsp;newErr)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliSessionState.html#setOut(java.io.PrintStream)">setOut</a></strong>(java.io.PrintStream&nbsp;newOut)</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="hostName"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hostName</h4> <pre>public&nbsp;java.lang.String hostName</pre> </li> </ul> <a name="thriftPort"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>thriftPort</h4> <pre>public&nbsp;int thriftPort</pre> </li> </ul> <a name="debug"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>debug</h4> <pre>public&nbsp;boolean debug</pre> </li> </ul> <a name="username"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>username</h4> <pre>public&nbsp;java.lang.String username</pre> </li> </ul> <a name="password"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>password</h4> <pre>public&nbsp;java.lang.String password</pre> </li> </ul> <a name="keyspace"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>keyspace</h4> <pre>public&nbsp;java.lang.String keyspace</pre> </li> </ul> <a name="batch"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>batch</h4> <pre>public&nbsp;boolean batch</pre> </li> </ul> <a name="filename"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>filename</h4> <pre>public&nbsp;java.lang.String filename</pre> </li> </ul> <a name="jmxPort"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>jmxPort</h4> <pre>public&nbsp;int jmxPort</pre> </li> </ul> <a name="jmxUsername"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>jmxUsername</h4> <pre>public&nbsp;java.lang.String jmxUsername</pre> </li> </ul> <a name="jmxPassword"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>jmxPassword</h4> <pre>public&nbsp;java.lang.String jmxPassword</pre> </li> </ul> <a name="verbose"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>verbose</h4> <pre>public&nbsp;boolean verbose</pre> </li> </ul> <a name="transportFactory"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>transportFactory</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a> transportFactory</pre> </li> </ul> <a name="encOptions"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>encOptions</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/config/EncryptionOptions.html" title="class in org.apache.cassandra.config">EncryptionOptions</a> encOptions</pre> </li> </ul> <a name="in"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>in</h4> <pre>public&nbsp;java.io.InputStream in</pre> </li> </ul> <a name="out"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>out</h4> <pre>public&nbsp;java.io.PrintStream out</pre> </li> </ul> <a name="err"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>err</h4> <pre>public&nbsp;java.io.PrintStream err</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="CliSessionState()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CliSessionState</h4> <pre>public&nbsp;CliSessionState()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="setOut(java.io.PrintStream)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setOut</h4> <pre>public&nbsp;void&nbsp;setOut(java.io.PrintStream&nbsp;newOut)</pre> </li> </ul> <a name="setErr(java.io.PrintStream)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setErr</h4> <pre>public&nbsp;void&nbsp;setErr(java.io.PrintStream&nbsp;newErr)</pre> </li> </ul> <a name="inFileMode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>inFileMode</h4> <pre>public&nbsp;boolean&nbsp;inFileMode()</pre> </li> </ul> <a name="getNodeProbe()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getNodeProbe</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/tools/NodeProbe.html" title="class in org.apache.cassandra.tools">NodeProbe</a>&nbsp;getNodeProbe()</pre> </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/CliSessionState.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/cli/CliOptions.html" title="class in org.apache.cassandra.cli"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cli/CliUserHelp.html" title="class in org.apache.cassandra.cli"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cli/CliSessionState.html" target="_top">Frames</a></li> <li><a href="CliSessionState.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>