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>Auth (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/Auth.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/auth/AllowAllInternodeAuthenticator.html" title="class in org.apache.cassandra.auth"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/auth/Auth.MigrationListener.html" title="class in org.apache.cassandra.auth"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/auth/Auth.html" target="_top">Frames</a></li> <li><a href="Auth.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.auth</div> <h2 title="Class Auth" class="title">Class Auth</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.auth.Auth</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Auth</span> extends java.lang.Object</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> <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 class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.MigrationListener.html" title="class in org.apache.cassandra.auth">Auth.MigrationListener</a></strong></code> <div class="block">IMigrationListener implementation that cleans up permissions on dropped resources.</div> </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/auth/Auth.html#AUTH_KS">AUTH_KS</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#DEFAULT_SUPERUSER_NAME">DEFAULT_SUPERUSER_NAME</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#SUPERUSER_SETUP_DELAY">SUPERUSER_SETUP_DELAY</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#USERS_CF">USERS_CF</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/auth/Auth.html#Auth()">Auth</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>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#deleteUser(java.lang.String)">deleteUser</a></strong>(java.lang.String username)</code> <div class="block">Deletes the user from AUTH_KS.USERS_CF.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#insertUser(java.lang.String,%20boolean)">insertUser</a></strong>(java.lang.String username, boolean isSuper)</code> <div class="block">Inserts the user into AUTH_KS.USERS_CF (or overwrites their superuser status as a result of an ALTER USER query).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#isExistingUser(java.lang.String)">isExistingUser</a></strong>(java.lang.String username)</code> <div class="block">Checks if the username is stored in AUTH_KS.USERS_CF.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#isSuperuser(java.lang.String)">isSuperuser</a></strong>(java.lang.String username)</code> <div class="block">Checks if the user is a known superuser.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#setup()">setup</a></strong>()</code> <div class="block">Sets up Authenticator and Authorizer.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/Auth.html#setupTable(java.lang.String,%20java.lang.String)">setupTable</a></strong>(java.lang.String name, java.lang.String cql)</code> <div class="block">Set up table from given CREATE TABLE statement under system_auth keyspace, if not already done so.</div> </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="DEFAULT_SUPERUSER_NAME">  </a> <ul class="blockList"> <li class="blockList"> <h4>DEFAULT_SUPERUSER_NAME</h4> <pre>public static final java.lang.String DEFAULT_SUPERUSER_NAME</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.auth.Auth.DEFAULT_SUPERUSER_NAME">Constant Field Values</a></dd></dl> </li> </ul> <a name="SUPERUSER_SETUP_DELAY">  </a> <ul class="blockList"> <li class="blockList"> <h4>SUPERUSER_SETUP_DELAY</h4> <pre>public static final long SUPERUSER_SETUP_DELAY</pre> </li> </ul> <a name="AUTH_KS">  </a> <ul class="blockList"> <li class="blockList"> <h4>AUTH_KS</h4> <pre>public static final java.lang.String AUTH_KS</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.auth.Auth.AUTH_KS">Constant Field Values</a></dd></dl> </li> </ul> <a name="USERS_CF">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>USERS_CF</h4> <pre>public static final java.lang.String USERS_CF</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.auth.Auth.USERS_CF">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="Auth()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>Auth</h4> <pre>public Auth()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="isExistingUser(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isExistingUser</h4> <pre>public static boolean isExistingUser(java.lang.String username)</pre> <div class="block">Checks if the username is stored in AUTH_KS.USERS_CF.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - Username to query.</dd> <dt><span class="strong">Returns:</span></dt><dd>whether or not Cassandra knows about the user.</dd></dl> </li> </ul> <a name="isSuperuser(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isSuperuser</h4> <pre>public static boolean isSuperuser(java.lang.String username)</pre> <div class="block">Checks if the user is a known superuser.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - Username to query.</dd> <dt><span class="strong">Returns:</span></dt><dd>true is the user is a superuser, false if they aren't or don't exist at all.</dd></dl> </li> </ul> <a name="insertUser(java.lang.String, boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>insertUser</h4> <pre>public static void insertUser(java.lang.String username, boolean isSuper) throws <a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></pre> <div class="block">Inserts the user into AUTH_KS.USERS_CF (or overwrites their superuser status as a result of an ALTER USER query).</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - Username to insert.</dd><dd><code>isSuper</code> - User's new status.</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></dl> </li> </ul> <a name="deleteUser(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>deleteUser</h4> <pre>public static void deleteUser(java.lang.String username) throws <a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></pre> <div class="block">Deletes the user from AUTH_KS.USERS_CF.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code> - Username to delete.</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></dl> </li> </ul> <a name="setup()">  </a> <ul class="blockList"> <li class="blockList"> <h4>setup</h4> <pre>public static void setup()</pre> <div class="block">Sets up Authenticator and Authorizer.</div> </li> </ul> <a name="setupTable(java.lang.String, java.lang.String)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>setupTable</h4> <pre>public static void setupTable(java.lang.String name, java.lang.String cql)</pre> <div class="block">Set up table from given CREATE TABLE statement under system_auth keyspace, if not already done so.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of the table</dd><dd><code>cql</code> - CREATE TABLE statement</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/Auth.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/auth/AllowAllInternodeAuthenticator.html" title="class in org.apache.cassandra.auth"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/auth/Auth.MigrationListener.html" title="class in org.apache.cassandra.auth"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/auth/Auth.html" target="_top">Frames</a></li> <li><a href="Auth.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>