cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
273 lines (272 loc) • 12.1 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:29 CEST 2014 -->
<title>ISaslAwareAuthenticator (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="ISaslAwareAuthenticator (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/ISaslAwareAuthenticator.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/IResource.html" title="interface in org.apache.cassandra.auth"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/auth/ISaslAwareAuthenticator.SaslAuthenticator.html" title="interface 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/ISaslAwareAuthenticator.html" target="_top">Frames</a></li>
<li><a href="ISaslAwareAuthenticator.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.auth</div>
<h2 title="Interface ISaslAwareAuthenticator" class="title">Interface ISaslAwareAuthenticator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/cassandra/auth/IAuthenticator.html" title="interface in org.apache.cassandra.auth">IAuthenticator</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cassandra/auth/PasswordAuthenticator.html" title="class in org.apache.cassandra.auth">PasswordAuthenticator</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ISaslAwareAuthenticator</span>
extends <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html" title="interface in org.apache.cassandra.auth">IAuthenticator</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<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">Interface 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/auth/ISaslAwareAuthenticator.SaslAuthenticator.html" title="interface in org.apache.cassandra.auth">ISaslAwareAuthenticator.SaslAuthenticator</a></strong></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.auth.IAuthenticator">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface org.apache.cassandra.auth.<a href="../../../../org/apache/cassandra/auth/IAuthenticator.html" title="interface in org.apache.cassandra.auth">IAuthenticator</a></h3>
<code><a href="../../../../org/apache/cassandra/auth/IAuthenticator.Option.html" title="enum in org.apache.cassandra.auth">IAuthenticator.Option</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.auth.IAuthenticator">
<!-- -->
</a>
<h3>Fields inherited from interface org.apache.cassandra.auth.<a href="../../../../org/apache/cassandra/auth/IAuthenticator.html" title="interface in org.apache.cassandra.auth">IAuthenticator</a></h3>
<code><a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#PASSWORD_KEY">PASSWORD_KEY</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#USERNAME_KEY">USERNAME_KEY</a></code></li>
</ul>
</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"> </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/auth/ISaslAwareAuthenticator.SaslAuthenticator.html" title="interface in org.apache.cassandra.auth">ISaslAwareAuthenticator.SaslAuthenticator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/auth/ISaslAwareAuthenticator.html#newAuthenticator()">newAuthenticator</a></strong>()</code>
<div class="block">Provide a SaslAuthenticator to be used by the CQL binary protocol server.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.auth.IAuthenticator">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.cassandra.auth.<a href="../../../../org/apache/cassandra/auth/IAuthenticator.html" title="interface in org.apache.cassandra.auth">IAuthenticator</a></h3>
<code><a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#alter(java.lang.String,%20java.util.Map)">alter</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#alterableOptions()">alterableOptions</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#authenticate(java.util.Map)">authenticate</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#create(java.lang.String,%20java.util.Map)">create</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#drop(java.lang.String)">drop</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#protectedResources()">protectedResources</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#requireAuthentication()">requireAuthentication</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#setup()">setup</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#supportedOptions()">supportedOptions</a>, <a href="../../../../org/apache/cassandra/auth/IAuthenticator.html#validateConfiguration()">validateConfiguration</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="newAuthenticator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newAuthenticator</h4>
<pre><a href="../../../../org/apache/cassandra/auth/ISaslAwareAuthenticator.SaslAuthenticator.html" title="interface in org.apache.cassandra.auth">ISaslAwareAuthenticator.SaslAuthenticator</a> newAuthenticator()</pre>
<div class="block">Provide a SaslAuthenticator to be used by the CQL binary protocol server. If
the configured IAuthenticator requires authentication but does not implement this
interface we refuse to start the binary protocol server as it will have no way
of authenticating clients.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>SaslAuthenticator implementation
(see <code>PasswordAuthenticator.PlainTextSaslAuthenticator</code>)</dd></dl>
</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/ISaslAwareAuthenticator.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/IResource.html" title="interface in org.apache.cassandra.auth"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/auth/ISaslAwareAuthenticator.SaslAuthenticator.html" title="interface 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/ISaslAwareAuthenticator.html" target="_top">Frames</a></li>
<li><a href="ISaslAwareAuthenticator.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>