| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CallHeaderAuthenticator (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title> |
| <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="CallHeaderAuthenticator (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/CallHeaderAuthenticator.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/arrow/flight/auth2/BearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.AuthResult.html" title="interface in org.apache.arrow.flight.auth2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" target="_top">Frames</a></li> |
| <li><a href="CallHeaderAuthenticator.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </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>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.arrow.flight.auth2</div> |
| <h2 title="Interface CallHeaderAuthenticator" class="title">Interface CallHeaderAuthenticator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/arrow/flight/auth2/BasicCallHeaderAuthenticator.html" title="class in org.apache.arrow.flight.auth2">BasicCallHeaderAuthenticator</a>, <a href="../../../../../org/apache/arrow/flight/auth2/BearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2">BearerTokenAuthenticator</a>, <a href="../../../../../org/apache/arrow/flight/auth2/GeneratedBearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2">GeneratedBearerTokenAuthenticator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">CallHeaderAuthenticator</span></pre> |
| <div class="block">Interface for Server side authentication handlers. |
| |
| A CallHeaderAuthenticator is used by <a href="../../../../../org/apache/arrow/flight/auth2/ServerCallHeaderAuthMiddleware.html" title="class in org.apache.arrow.flight.auth2"><code>ServerCallHeaderAuthMiddleware</code></a> to validate headers sent by a Flight |
| client for authentication purposes. The headers validated do not necessarily have to be Authorization headers. |
| |
| The workflow is that the FlightServer will intercept headers on a request, validate the headers, and |
| either send back an UNAUTHENTICATED error, or succeed and potentially send back additional headers to the client. |
| |
| Implementations of CallHeaderAuthenticator should take care not to provide leak confidential details (such as |
| indicating if usernames are valid or not) for security reasons when reporting errors back to clients. |
| |
| Example CallHeaderAuthenticators provided include: |
| The <a href="../../../../../org/apache/arrow/flight/auth2/BasicCallHeaderAuthenticator.html" title="class in org.apache.arrow.flight.auth2"><code>BasicCallHeaderAuthenticator</code></a> will authenticate basic HTTP credentials. |
| |
| The <a href="../../../../../org/apache/arrow/flight/auth2/BearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2"><code>BearerTokenAuthenticator</code></a> will authenticate basic HTTP credentials initially, then also send back a |
| bearer token that the client can use for subsequent requests. The <a href="../../../../../org/apache/arrow/flight/auth2/GeneratedBearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2"><code>GeneratedBearerTokenAuthenticator</code></a> will |
| provide internally generated bearer tokens and maintain a cache of them.</div> |
| </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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.AuthResult.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator.AuthResult</a></span></code> |
| <div class="block">Encapsulates the result of the <a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" title="interface in org.apache.arrow.flight.auth2"><code>CallHeaderAuthenticator</code></a> analysis of headers.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" 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 <a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html#NO_OP">NO_OP</a></span></code> |
| <div class="block">An auth handler that does nothing.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.AuthResult.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator.AuthResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html#authenticate-org.apache.arrow.flight.CallHeaders-">authenticate</a></span>(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a> incomingHeaders)</code> |
| <div class="block">Validate the auth headers sent by the client.</div> |
| </td> |
| </tr> |
| </table> |
| </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="NO_OP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NO_OP</h4> |
| <pre>static final <a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator</a> NO_OP</pre> |
| <div class="block">An auth handler that does nothing.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="authenticate-org.apache.arrow.flight.CallHeaders-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>authenticate</h4> |
| <pre><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.AuthResult.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator.AuthResult</a> authenticate(<a href="../../../../../org/apache/arrow/flight/CallHeaders.html" title="interface in org.apache.arrow.flight">CallHeaders</a> incomingHeaders)</pre> |
| <div class="block">Validate the auth headers sent by the client.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>incomingHeaders</code> - The incoming headers to authenticate.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an auth result containing a peer identity and optionally a bearer token.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/flight/FlightRuntimeException.html" title="class in org.apache.arrow.flight">FlightRuntimeException</a></code> - with CallStatus.UNAUTHENTICATED if credentials were not supplied |
| or if credentials were supplied but were not valid.</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/CallHeaderAuthenticator.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/arrow/flight/auth2/BearerTokenAuthenticator.html" title="class in org.apache.arrow.flight.auth2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.AuthResult.html" title="interface in org.apache.arrow.flight.auth2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" target="_top">Frames</a></li> |
| <li><a href="CallHeaderAuthenticator.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </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>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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
