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>AuthenticationStatement (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/AuthenticationStatement.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/cql3/statements/AlterUserStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/AuthorizationStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/AuthenticationStatement.html" target="_top">Frames</a></li> <li><a href="AuthenticationStatement.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_classes_inherited_from_class_org.apache.cassandra.cql3.statements.ParsedStatement">Nested</a> | </li> <li>Field | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.cql3.statements</div> <h2 title="Class AuthenticationStatement" class="title">Class AuthenticationStatement</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html" title="class in org.apache.cassandra.cql3.statements">org.apache.cassandra.cql3.statements.ParsedStatement</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.statements.AuthenticationStatement</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/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../../org/apache/cassandra/cql3/statements/AlterUserStatement.html" title="class in org.apache.cassandra.cql3.statements">AlterUserStatement</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/CreateUserStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateUserStatement</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/DropUserStatement.html" title="class in org.apache.cassandra.cql3.statements">DropUserStatement</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ListUsersStatement.html" title="class in org.apache.cassandra.cql3.statements">ListUsersStatement</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AuthenticationStatement</span> extends <a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement</a> implements <a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></pre> </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> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.cql3.statements.ParsedStatement">  </a> <h3>Nested classes/interfaces inherited from class org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.Prepared.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement.Prepared</a></code></li> </ul> </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/cql3/statements/AuthenticationStatement.html#AuthenticationStatement()">AuthenticationStatement</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>abstract <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/cql3/statements/AuthenticationStatement.html#execute(org.apache.cassandra.service.ClientState)">execute</a></strong>(<a href="../../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state)</code> </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/cql3/statements/AuthenticationStatement.html#execute(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">execute</a></strong>(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code> <div class="block">Execute the statement and return the resulting result or null if there is no result.</div> </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/cql3/statements/AuthenticationStatement.html#executeInternal(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">executeInternal</a></strong>(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code> <div class="block">Variante of execute used for internal query against the system tables, and thus only query the local node.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/AuthenticationStatement.html#getBoundTerms()">getBoundTerms</a></strong>()</code> <div class="block">Returns the number of bound terms in this statement.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.Prepared.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement.Prepared</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/AuthenticationStatement.html#prepare()">prepare</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql3.statements.ParsedStatement">  </a> <h3>Methods inherited from class org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html#getBoundVariables()">getBoundVariables</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html#setBoundVariables(java.util.List)">setBoundVariables</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> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql3.CQLStatement">  </a> <h3>Methods inherited from interface org.apache.cassandra.cql3.<a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#checkAccess(org.apache.cassandra.service.ClientState)">checkAccess</a>, <a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#validate(org.apache.cassandra.service.ClientState)">validate</a></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="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="AuthenticationStatement()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>AuthenticationStatement</h4> <pre>public AuthenticationStatement()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="prepare()">  </a> <ul class="blockList"> <li class="blockList"> <h4>prepare</h4> <pre>public <a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.Prepared.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement.Prepared</a> prepare()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html#prepare()">prepare</a></code> in class <code><a href="../../../../../org/apache/cassandra/cql3/statements/ParsedStatement.html" title="class in org.apache.cassandra.cql3.statements">ParsedStatement</a></code></dd> </dl> </li> </ul> <a name="getBoundTerms()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getBoundTerms</h4> <pre>public int getBoundTerms()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#getBoundTerms()">CQLStatement</a></code></strong></div> <div class="block">Returns the number of bound terms in this statement.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#getBoundTerms()">getBoundTerms</a></code> in interface <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></code></dd> </dl> </li> </ul> <a name="execute(org.apache.cassandra.service.QueryState, org.apache.cassandra.cql3.QueryOptions)">  </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public <a href="../../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a> execute(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options) throws <a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a>, <a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#execute(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">CQLStatement</a></code></strong></div> <div class="block">Execute the statement and return the resulting result or null if there is no result.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#execute(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">execute</a></code> in interface <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current query state</dd><dd><code>options</code> - options for this query (consistency, variables, pageSize, ...)</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></code></dd> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd></dl> </li> </ul> <a name="execute(org.apache.cassandra.service.ClientState)">  </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public abstract <a href="../../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a> execute(<a href="../../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state) throws <a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a>, <a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></code></dd> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd></dl> </li> </ul> <a name="executeInternal(org.apache.cassandra.service.QueryState, org.apache.cassandra.cql3.QueryOptions)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>executeInternal</h4> <pre>public <a href="../../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a> executeInternal(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#executeInternal(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">CQLStatement</a></code></strong></div> <div class="block">Variante of execute used for internal query against the system tables, and thus only query the local node.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html#executeInternal(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">executeInternal</a></code> in interface <code><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current query state</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/AuthenticationStatement.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/cql3/statements/AlterUserStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/AuthorizationStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/AuthenticationStatement.html" target="_top">Frames</a></li> <li><a href="AuthenticationStatement.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_classes_inherited_from_class_org.apache.cassandra.cql3.statements.ParsedStatement">Nested</a> | </li> <li>Field | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>