blob: d075a834d60257507b4e6154e7c0581caa5ef429 [file] [log] [blame]
<!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>FlightServer.Builder (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="FlightServer.Builder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":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/FlightServer.Builder.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/FlightServer.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/flight/FlightServer.Builder.html" target="_top">Frames</a></li>
<li><a href="FlightServer.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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</div>
<h2 title="Class FlightServer.Builder" class="title">Class FlightServer.Builder</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.arrow.flight.FlightServer.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/apache/arrow/flight/FlightServer.html" title="class in org.apache.arrow.flight">FlightServer</a></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">FlightServer.Builder</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></pre>
<div class="block">A builder for Flight servers.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#allocator-org.apache.arrow.memory.BufferAllocator-">allocator</a></span>(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#authHandler-org.apache.arrow.flight.auth.ServerAuthHandler-">authHandler</a></span>(<a href="../../../../org/apache/arrow/flight/auth/ServerAuthHandler.html" title="interface in org.apache.arrow.flight.auth">ServerAuthHandler</a>&nbsp;authHandler)</code>
<div class="block">Set the authentication handler.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#backpressureThreshold-int-">backpressureThreshold</a></span>(int&nbsp;backpressureThreshold)</code>
<div class="block">Set the number of bytes that may be queued on a server output stream before writes are blocked.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.html" title="class in org.apache.arrow.flight">FlightServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#build--">build</a></span>()</code>
<div class="block">Create the server for this builder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#executor-java.util.concurrent.ExecutorService-">executor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</code>
<div class="block">Set the executor used by the server.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#headerAuthenticator-org.apache.arrow.flight.auth2.CallHeaderAuthenticator-">headerAuthenticator</a></span>(<a href="../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator</a>&nbsp;headerAuthenticator)</code>
<div class="block">Set the header-based authentication mechanism.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#location-org.apache.arrow.flight.Location-">location</a></span>(<a href="../../../../org/apache/arrow/flight/Location.html" title="class in org.apache.arrow.flight">Location</a>&nbsp;location)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#maxInboundMessageSize-int-">maxInboundMessageSize</a></span>(int&nbsp;maxMessageSize)</code>
<div class="block">Set the maximum size of a message.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware</a>&gt;<br><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#middleware-org.apache.arrow.flight.FlightServerMiddleware.Key-org.apache.arrow.flight.FlightServerMiddleware.Factory-">middleware</a></span>(<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Key.html" title="class in org.apache.arrow.flight">FlightServerMiddleware.Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware.Factory</a>&lt;T&gt;&nbsp;factory)</code>
<div class="block">Add a Flight middleware component to inspect and modify requests to this service.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#producer-org.apache.arrow.flight.FlightProducer-">producer</a></span>(<a href="../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a>&nbsp;producer)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#transportHint-java.lang.String-java.lang.Object-">transportHint</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>&nbsp;key,
<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>&nbsp;option)</code>
<div class="block">Provide a transport-specific option.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#useMTlsClientVerification-java.io.File-">useMTlsClientVerification</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;mTlsCACert)</code>
<div class="block">Enable Client Verification via mTLS on the server.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#useMTlsClientVerification-java.io.InputStream-">useMTlsClientVerification</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;mTlsCACert)</code>
<div class="block">Enable mTLS on the server.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#useTls-java.io.File-java.io.File-">useTls</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;certChain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;key)</code>
<div class="block">Enable TLS on the server.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html#useTls-java.io.InputStream-java.io.InputStream-">useTls</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;certChain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;key)</code>
<div class="block">Enable TLS on the server.</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&nbsp;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>
</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="build--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.html" title="class in org.apache.arrow.flight">FlightServer</a>&nbsp;build()</pre>
<div class="block">Create the server for this builder.</div>
</li>
</ul>
<a name="maxInboundMessageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxInboundMessageSize</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;maxInboundMessageSize(int&nbsp;maxMessageSize)</pre>
<div class="block">Set the maximum size of a message. Defaults to "unlimited", depending on the underlying transport.</div>
</li>
</ul>
<a name="backpressureThreshold-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backpressureThreshold</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;backpressureThreshold(int&nbsp;backpressureThreshold)</pre>
<div class="block">Set the number of bytes that may be queued on a server output stream before writes are blocked.</div>
</li>
</ul>
<a name="useTls-java.io.File-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useTls</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;useTls(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;certChain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;key)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Enable TLS on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>certChain</code> - The certificate chain to use.</dd>
<dd><code>key</code> - The private key to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="useMTlsClientVerification-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useMTlsClientVerification</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;useMTlsClientVerification(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;mTlsCACert)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Enable Client Verification via mTLS on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mTlsCACert</code> - The CA certificate to use for verifying clients.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="useTls-java.io.InputStream-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useTls</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;useTls(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;certChain,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;key)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Enable TLS on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>certChain</code> - The certificate chain to use.</dd>
<dd><code>key</code> - The private key to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="useMTlsClientVerification-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useMTlsClientVerification</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;useMTlsClientVerification(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;mTlsCACert)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Enable mTLS on the server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mTlsCACert</code> - The CA certificate to use for verifying clients.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="executor-java.util.concurrent.ExecutorService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executor</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;executor(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executor)</pre>
<div class="block">Set the executor used by the server.
<p>Flight will NOT take ownership of the executor. The application must clean it up if one is provided. (If not
provided, Flight will use a default executor which it will clean up.)</div>
</li>
</ul>
<a name="authHandler-org.apache.arrow.flight.auth.ServerAuthHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authHandler</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;authHandler(<a href="../../../../org/apache/arrow/flight/auth/ServerAuthHandler.html" title="interface in org.apache.arrow.flight.auth">ServerAuthHandler</a>&nbsp;authHandler)</pre>
<div class="block">Set the authentication handler.</div>
</li>
</ul>
<a name="headerAuthenticator-org.apache.arrow.flight.auth2.CallHeaderAuthenticator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headerAuthenticator</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;headerAuthenticator(<a href="../../../../org/apache/arrow/flight/auth2/CallHeaderAuthenticator.html" title="interface in org.apache.arrow.flight.auth2">CallHeaderAuthenticator</a>&nbsp;headerAuthenticator)</pre>
<div class="block">Set the header-based authentication mechanism.</div>
</li>
</ul>
<a name="transportHint-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transportHint</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;transportHint(<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>&nbsp;key,
<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>&nbsp;option)</pre>
<div class="block">Provide a transport-specific option. Not guaranteed to have any effect.</div>
</li>
</ul>
<a name="middleware-org.apache.arrow.flight.FlightServerMiddleware.Key-org.apache.arrow.flight.FlightServerMiddleware.Factory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>middleware</h4>
<pre>public&nbsp;&lt;T extends <a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware</a>&gt;&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;middleware(<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Key.html" title="class in org.apache.arrow.flight">FlightServerMiddleware.Key</a>&lt;T&gt;&nbsp;key,
<a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.Factory.html" title="interface in org.apache.arrow.flight">FlightServerMiddleware.Factory</a>&lt;T&gt;&nbsp;factory)</pre>
<div class="block">Add a Flight middleware component to inspect and modify requests to this service.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The middleware type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - An identifier for this middleware component. Service implementations can retrieve the middleware
instance for the current call using <a href="../../../../org/apache/arrow/flight/FlightProducer.CallContext.html" title="interface in org.apache.arrow.flight"><code>FlightProducer.CallContext</code></a>.</dd>
<dd><code>factory</code> - A factory for the middleware.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the key already exists</dd>
</dl>
</li>
</ul>
<a name="allocator-org.apache.arrow.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocator</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;allocator(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator)</pre>
</li>
</ul>
<a name="location-org.apache.arrow.flight.Location-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>location</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;location(<a href="../../../../org/apache/arrow/flight/Location.html" title="class in org.apache.arrow.flight">Location</a>&nbsp;location)</pre>
</li>
</ul>
<a name="producer-org.apache.arrow.flight.FlightProducer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>producer</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;producer(<a href="../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a>&nbsp;producer)</pre>
</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/FlightServer.Builder.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/FlightServer.html" title="class in org.apache.arrow.flight"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/flight/FlightServerMiddleware.html" title="interface in org.apache.arrow.flight"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/flight/FlightServer.Builder.html" target="_top">Frames</a></li>
<li><a href="FlightServer.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>