diff options
Diffstat (limited to 'content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/auth/X509AuthenticationProvider.html')
| -rw-r--r-- | content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/auth/X509AuthenticationProvider.html | 548 |
1 files changed, 548 insertions, 0 deletions
diff --git a/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/auth/X509AuthenticationProvider.html b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/auth/X509AuthenticationProvider.html new file mode 100644 index 000000000..fb621f976 --- /dev/null +++ b/content/doc/r3.8.1/apidocs/zookeeper-server/org/apache/zookeeper/server/auth/X509AuthenticationProvider.html @@ -0,0 +1,548 @@ +<!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 (1.8.0_352) on Wed Jan 25 17:31:44 CET 2023 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>X509AuthenticationProvider (Apache ZooKeeper - Server 3.8.1 API)</title> +<meta name="date" content="2023-01-25"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="X509AuthenticationProvider (Apache ZooKeeper - Server 3.8.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/X509AuthenticationProvider.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/zookeeper/server/auth/ServerAuthenticationProvider.ServerObjs.html" title="class in org.apache.zookeeper.server.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/auth/X509AuthenticationProvider.html" target="_top">Frames</a></li> +<li><a href="X509AuthenticationProvider.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>Nested | </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> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.zookeeper.server.auth</div> +<h2 title="Class X509AuthenticationProvider" class="title">Class X509AuthenticationProvider</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.zookeeper.server.auth.X509AuthenticationProvider</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">X509AuthenticationProvider</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></pre> +<div class="block">An AuthenticationProvider backed by an X509TrustManager and an X509KeyManager + to perform remote host certificate authentication. The default algorithm is + SunX509 and a JKS KeyStore. To specify the locations of the key store and + trust store, set the following system properties: + <br><code>zookeeper.ssl.keyStore.location</code> + <br><code>zookeeper.ssl.trustStore.location</code> + <br>To specify store passwords, set the following system properties: + <br><code>zookeeper.ssl.keyStore.password</code> + <br><code>zookeeper.ssl.trustStore.password</code> + <br>Alternatively, the passwords can be specified by the following password file path properties: + <br><code>zookeeper.ssl.keyStore.passwordPath</code> + <br><code>zookeeper.ssl.trustStore.passwordPath</code> + <br>Alternatively, this can be plugged with any X509TrustManager and + X509KeyManager implementation.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#X509AuthenticationProvider--">X509AuthenticationProvider</a></span>()</code> +<div class="block">Initialize the X509AuthenticationProvider with a JKS KeyStore and JKS + TrustStore according to the following system properties: + <br><code>zookeeper.ssl.keyStore.location</code> + <br><code>zookeeper.ssl.trustStore.location</code> + <br><code>zookeeper.ssl.keyStore.password</code> + <br><code>zookeeper.ssl.keyStore.passwordPath</code> + <br><code>zookeeper.ssl.trustStore.password</code> + <br><code>zookeeper.ssl.trustStore.passwordPath</code></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#X509AuthenticationProvider-javax.net.ssl.X509TrustManager-javax.net.ssl.X509KeyManager-">X509AuthenticationProvider</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html?is-external=true" title="class or interface in javax.net.ssl">X509TrustManager</a> trustManager, + <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html?is-external=true" title="class or interface in javax.net.ssl">X509KeyManager</a> keyManager)</code> +<div class="block">Initialize the X509AuthenticationProvider with the provided + X509TrustManager and X509KeyManager.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#getClientId-java.security.cert.X509Certificate-">getClientId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html?is-external=true" title="class or interface in java.security.cert">X509Certificate</a> clientCert)</code> +<div class="block">Determine the string to be used as the remote host session Id for + authorization purposes.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html?is-external=true" title="class or interface in javax.net.ssl">X509KeyManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#getKeyManager--">getKeyManager</a></span>()</code> +<div class="block">Get the X509KeyManager implementation used for certificate management.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#getScheme--">getScheme</a></span>()</code> +<div class="block">The String used to represent this provider.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html?is-external=true" title="class or interface in javax.net.ssl">X509TrustManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#getTrustManager--">getTrustManager</a></span>()</code> +<div class="block">Get the X509TrustManager implementation used for remote host + authentication.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/zookeeper/KeeperException.Code.html" title="enum in org.apache.zookeeper">KeeperException.Code</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#handleAuthentication-org.apache.zookeeper.server.ServerCnxn-byte:A-">handleAuthentication</a></span>(<a href="../../../../../org/apache/zookeeper/server/ServerCnxn.html" title="class in org.apache.zookeeper.server">ServerCnxn</a> cnxn, + byte[] authData)</code> +<div class="block">This method is called when a client passes authentication data for this + scheme.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#isAuthenticated--">isAuthenticated</a></span>()</code> +<div class="block">This method is used to check if the authentication done by this provider + should be used to identify the creator of a node.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#isValid-java.lang.String-">isValid</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code> +<div class="block">Validates the syntax of an id.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/auth/X509AuthenticationProvider.html#matches-java.lang.String-java.lang.String-">matches</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aclExpr)</code> +<div class="block">This method is called to see if the given id matches the given id + expression in the ACL.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.zookeeper.server.auth.AuthenticationProvider"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.zookeeper.server.auth.<a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></h3> +<code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#getUserName-java.lang.String-">getUserName</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="X509AuthenticationProvider--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>X509AuthenticationProvider</h4> +<pre>public X509AuthenticationProvider() + throws <a href="../../../../../org/apache/zookeeper/common/X509Exception.html" title="class in org.apache.zookeeper.common">X509Exception</a></pre> +<div class="block">Initialize the X509AuthenticationProvider with a JKS KeyStore and JKS + TrustStore according to the following system properties: + <br><code>zookeeper.ssl.keyStore.location</code> + <br><code>zookeeper.ssl.trustStore.location</code> + <br><code>zookeeper.ssl.keyStore.password</code> + <br><code>zookeeper.ssl.keyStore.passwordPath</code> + <br><code>zookeeper.ssl.trustStore.password</code> + <br><code>zookeeper.ssl.trustStore.passwordPath</code></div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/common/X509Exception.html" title="class in org.apache.zookeeper.common">X509Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="X509AuthenticationProvider-javax.net.ssl.X509TrustManager-javax.net.ssl.X509KeyManager-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>X509AuthenticationProvider</h4> +<pre>public X509AuthenticationProvider(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html?is-external=true" title="class or interface in javax.net.ssl">X509TrustManager</a> trustManager, + <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html?is-external=true" title="class or interface in javax.net.ssl">X509KeyManager</a> keyManager)</pre> +<div class="block">Initialize the X509AuthenticationProvider with the provided + X509TrustManager and X509KeyManager.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>trustManager</code> - X509TrustManager implementation to use for remote + host authentication.</dd> +<dd><code>keyManager</code> - X509KeyManager implementation to use for certificate + management.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getScheme--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScheme</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getScheme()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#getScheme--">AuthenticationProvider</a></code></span></div> +<div class="block">The String used to represent this provider. This will correspond to the + scheme field of an Id.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#getScheme--">getScheme</a></code> in interface <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the scheme of this provider.</dd> +</dl> +</li> +</ul> +<a name="handleAuthentication-org.apache.zookeeper.server.ServerCnxn-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handleAuthentication</h4> +<pre>public <a href="../../../../../org/apache/zookeeper/KeeperException.Code.html" title="enum in org.apache.zookeeper">KeeperException.Code</a> handleAuthentication(<a href="../../../../../org/apache/zookeeper/server/ServerCnxn.html" title="class in org.apache.zookeeper.server">ServerCnxn</a> cnxn, + byte[] authData)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#handleAuthentication-org.apache.zookeeper.server.ServerCnxn-byte:A-">AuthenticationProvider</a></code></span></div> +<div class="block">This method is called when a client passes authentication data for this + scheme. The authData is directly from the authentication packet. The + implementor may attach new ids to the authInfo field of cnxn or may use + cnxn to send packets back to the client.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#handleAuthentication-org.apache.zookeeper.server.ServerCnxn-byte:A-">handleAuthentication</a></code> in interface <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cnxn</code> - the cnxn that received the authentication information.</dd> +<dd><code>authData</code> - the authentication data received.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TODO</dd> +</dl> +</li> +</ul> +<a name="getClientId-java.security.cert.X509Certificate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClientId</h4> +<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClientId(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html?is-external=true" title="class or interface in java.security.cert">X509Certificate</a> clientCert)</pre> +<div class="block">Determine the string to be used as the remote host session Id for + authorization purposes. Associate this client identifier with a + ServerCnxn that has been authenticated over SSL, and any ACLs that refer + to the authenticated client.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>clientCert</code> - Authenticated X509Certificate associated with the + remote host.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Identifier string to be associated with the client.</dd> +</dl> +</li> +</ul> +<a name="matches-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matches</h4> +<pre>public boolean matches(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aclExpr)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#matches-java.lang.String-java.lang.String-">AuthenticationProvider</a></code></span></div> +<div class="block">This method is called to see if the given id matches the given id + expression in the ACL. This allows schemes to use application specific + wild cards.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#matches-java.lang.String-java.lang.String-">matches</a></code> in interface <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - the id to check.</dd> +<dd><code>aclExpr</code> - the expression to match ids against.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the id can be matched by the expression.</dd> +</dl> +</li> +</ul> +<a name="isAuthenticated--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAuthenticated</h4> +<pre>public boolean isAuthenticated()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#isAuthenticated--">AuthenticationProvider</a></code></span></div> +<div class="block">This method is used to check if the authentication done by this provider + should be used to identify the creator of a node. Some ids such as hosts + and ip addresses are rather transient and in general don't really + identify a client even though sometimes they do.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#isAuthenticated--">isAuthenticated</a></code> in interface <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if this provider identifies creators.</dd> +</dl> +</li> +</ul> +<a name="isValid-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isValid</h4> +<pre>public boolean isValid(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#isValid-java.lang.String-">AuthenticationProvider</a></code></span></div> +<div class="block">Validates the syntax of an id.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html#isValid-java.lang.String-">isValid</a></code> in interface <code><a href="../../../../../org/apache/zookeeper/server/auth/AuthenticationProvider.html" title="interface in org.apache.zookeeper.server.auth">AuthenticationProvider</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>id</code> - the id to validate.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if id is well formed.</dd> +</dl> +</li> +</ul> +<a name="getTrustManager--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTrustManager</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html?is-external=true" title="class or interface in javax.net.ssl">X509TrustManager</a> getTrustManager() + throws <a href="../../../../../org/apache/zookeeper/common/X509Exception.TrustManagerException.html" title="class in org.apache.zookeeper.common">X509Exception.TrustManagerException</a></pre> +<div class="block">Get the X509TrustManager implementation used for remote host + authentication.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The X509TrustManager.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/common/X509Exception.TrustManagerException.html" title="class in org.apache.zookeeper.common">X509Exception.TrustManagerException</a></code> - When there is no trust manager available.</dd> +</dl> +</li> +</ul> +<a name="getKeyManager--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getKeyManager</h4> +<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html?is-external=true" title="class or interface in javax.net.ssl">X509KeyManager</a> getKeyManager() + throws <a href="../../../../../org/apache/zookeeper/common/X509Exception.KeyManagerException.html" title="class in org.apache.zookeeper.common">X509Exception.KeyManagerException</a></pre> +<div class="block">Get the X509KeyManager implementation used for certificate management.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The X509KeyManager.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/zookeeper/common/X509Exception.KeyManagerException.html" title="class in org.apache.zookeeper.common">X509Exception.KeyManagerException</a></code> - When there is no key manager available.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/X509AuthenticationProvider.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/zookeeper/server/auth/ServerAuthenticationProvider.ServerObjs.html" title="class in org.apache.zookeeper.server.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/zookeeper/server/auth/X509AuthenticationProvider.html" target="_top">Frames</a></li> +<li><a href="X509AuthenticationProvider.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>Nested | </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> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |