UNPKG

cassandra-server

Version:

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

527 lines (526 loc) 21.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:35 CEST 2014 --> <title>SimpleClient (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="SimpleClient (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/SimpleClient.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/transport/ServerError.html" title="class in org.apache.cassandra.transport"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/transport/SimpleClient.html" target="_top">Frames</a></li> <li><a href="SimpleClient.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.transport</div> <h2 title="Class SimpleClient" class="title">Class SimpleClient</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.transport.SimpleClient</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/transport/Client.html" title="class in org.apache.cassandra.transport">Client</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">SimpleClient</span> extends java.lang.Object</pre> </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>protected io.netty.bootstrap.Bootstrap</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#bootstrap">bootstrap</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected io.netty.channel.Channel</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#channel">channel</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/transport/Connection.html" title="class in org.apache.cassandra.transport">Connection</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#connection">connection</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/transport/SimpleClient.html#host">host</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected io.netty.channel.ChannelFuture</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#lastWriteFuture">lastWriteFuture</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/transport/SimpleClient.html#port">port</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected org.apache.cassandra.transport.SimpleClient.ResponseHandler</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#responseHandler">responseHandler</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/transport/Connection.Tracker.html" title="interface in org.apache.cassandra.transport">Connection.Tracker</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#tracker">tracker</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/transport/SimpleClient.html#SimpleClient(java.lang.String,%20int)">SimpleClient</a></strong>(java.lang.String&nbsp;host, int&nbsp;port)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#SimpleClient(java.lang.String,%20int,%20org.apache.cassandra.config.EncryptionOptions.ClientEncryptionOptions)">SimpleClient</a></strong>(java.lang.String&nbsp;host, int&nbsp;port, <a href="../../../../org/apache/cassandra/config/EncryptionOptions.ClientEncryptionOptions.html" title="class in org.apache.cassandra.config">EncryptionOptions.ClientEncryptionOptions</a>&nbsp;encryptionOptions)</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#close()">close</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#connect(boolean)">connect</a></strong>(boolean&nbsp;useCompression)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#establishConnection()">establishConnection</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/transport/Message.Response.html" title="class in org.apache.cassandra.transport">Message.Response</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#execute(org.apache.cassandra.transport.Message.Request)">execute</a></strong>(<a href="../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a>&nbsp;request)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#execute(java.lang.String,%20org.apache.cassandra.db.ConsistencyLevel)">execute</a></strong>(java.lang.String&nbsp;query, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistency)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#execute(java.lang.String,%20java.util.List,%20org.apache.cassandra.db.ConsistencyLevel)">execute</a></strong>(java.lang.String&nbsp;query, java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;values, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistencyLevel)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#executePrepared(byte[],%20java.util.List,%20org.apache.cassandra.db.ConsistencyLevel)">executePrepared</a></strong>(byte[]&nbsp;statementId, java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;values, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistency)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#login(java.util.Map)">login</a></strong>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;credentials)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.Prepared.html" title="class in org.apache.cassandra.transport.messages">ResultMessage.Prepared</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/transport/SimpleClient.html#prepare(java.lang.String)">prepare</a></strong>(java.lang.String&nbsp;query)</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="host"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>host</h4> <pre>public final&nbsp;java.lang.String host</pre> </li> </ul> <a name="port"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>port</h4> <pre>public final&nbsp;int port</pre> </li> </ul> <a name="responseHandler"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>responseHandler</h4> <pre>protected final&nbsp;org.apache.cassandra.transport.SimpleClient.ResponseHandler responseHandler</pre> </li> </ul> <a name="tracker"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>tracker</h4> <pre>protected final&nbsp;<a href="../../../../org/apache/cassandra/transport/Connection.Tracker.html" title="interface in org.apache.cassandra.transport">Connection.Tracker</a> tracker</pre> </li> </ul> <a name="connection"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>connection</h4> <pre>protected final&nbsp;<a href="../../../../org/apache/cassandra/transport/Connection.html" title="class in org.apache.cassandra.transport">Connection</a> connection</pre> </li> </ul> <a name="bootstrap"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>bootstrap</h4> <pre>protected&nbsp;io.netty.bootstrap.Bootstrap bootstrap</pre> </li> </ul> <a name="channel"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>channel</h4> <pre>protected&nbsp;io.netty.channel.Channel channel</pre> </li> </ul> <a name="lastWriteFuture"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>lastWriteFuture</h4> <pre>protected&nbsp;io.netty.channel.ChannelFuture lastWriteFuture</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="SimpleClient(java.lang.String, int, org.apache.cassandra.config.EncryptionOptions.ClientEncryptionOptions)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>SimpleClient</h4> <pre>public&nbsp;SimpleClient(java.lang.String&nbsp;host, int&nbsp;port, <a href="../../../../org/apache/cassandra/config/EncryptionOptions.ClientEncryptionOptions.html" title="class in org.apache.cassandra.config">EncryptionOptions.ClientEncryptionOptions</a>&nbsp;encryptionOptions)</pre> </li> </ul> <a name="SimpleClient(java.lang.String, int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SimpleClient</h4> <pre>public&nbsp;SimpleClient(java.lang.String&nbsp;host, int&nbsp;port)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="connect(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>connect</h4> <pre>public&nbsp;void&nbsp;connect(boolean&nbsp;useCompression) throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="establishConnection()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>establishConnection</h4> <pre>protected&nbsp;void&nbsp;establishConnection() throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="login(java.util.Map)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>login</h4> <pre>public&nbsp;void&nbsp;login(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;credentials)</pre> </li> </ul> <a name="execute(java.lang.String, org.apache.cassandra.db.ConsistencyLevel)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a>&nbsp;execute(java.lang.String&nbsp;query, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistency)</pre> </li> </ul> <a name="execute(java.lang.String, java.util.List, org.apache.cassandra.db.ConsistencyLevel)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a>&nbsp;execute(java.lang.String&nbsp;query, java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;values, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistencyLevel)</pre> </li> </ul> <a name="prepare(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>prepare</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.Prepared.html" title="class in org.apache.cassandra.transport.messages">ResultMessage.Prepared</a>&nbsp;prepare(java.lang.String&nbsp;query)</pre> </li> </ul> <a name="executePrepared(byte[], java.util.List, org.apache.cassandra.db.ConsistencyLevel)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>executePrepared</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a>&nbsp;executePrepared(byte[]&nbsp;statementId, java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;values, <a href="../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a>&nbsp;consistency)</pre> </li> </ul> <a name="close()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close()</pre> </li> </ul> <a name="execute(org.apache.cassandra.transport.Message.Request)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>execute</h4> <pre>protected&nbsp;<a href="../../../../org/apache/cassandra/transport/Message.Response.html" title="class in org.apache.cassandra.transport">Message.Response</a>&nbsp;execute(<a href="../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a>&nbsp;request)</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/SimpleClient.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/transport/ServerError.html" title="class in org.apache.cassandra.transport"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/transport/SimpleClient.html" target="_top">Frames</a></li> <li><a href="SimpleClient.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>