Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / flight / class-use / FlightServer.Builder.html
blob: 757563f34390c3bbda154bd374e5c1152c45bb43 [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>Uses of Class org.apache.arrow.flight.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="Uses of Class org.apache.arrow.flight.FlightServer.Builder (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/class-use/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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class org.apache.arrow.flight.FlightServer.Builder" class="title">Uses of Class<br>org.apache.arrow.flight.FlightServer.Builder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.arrow.flight">org.apache.arrow.flight</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.arrow.flight.integration.tests">org.apache.arrow.flight.integration.tests</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="org.apache.arrow.flight">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a> in <a href="../../../../../org/apache/arrow/flight/package-summary.html">org.apache.arrow.flight</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/arrow/flight/package-summary.html">org.apache.arrow.flight</a> that return <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><span class="typeNameLabel">FlightServer.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/FlightServer.html#builder--">builder</a></span>()</code>
<div class="block">Create a builder for a Flight server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></code></td>
<td class="colLast"><span class="typeNameLabel">FlightServer.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/FlightServer.html#builder-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.flight.Location-org.apache.arrow.flight.FlightProducer-">builder</a></span>(<a href="../../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a>&nbsp;allocator,
<a href="../../../../../org/apache/arrow/flight/Location.html" title="class in org.apache.arrow.flight">Location</a>&nbsp;location,
<a href="../../../../../org/apache/arrow/flight/FlightProducer.html" title="interface in org.apache.arrow.flight">FlightProducer</a>&nbsp;producer)</code>
<div class="block">Create a builder for a Flight server.</div>
</td>
</tr>
<tr 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 class="rowColor">
<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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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 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"><span class="typeNameLabel">FlightServer.Builder.</span><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>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.arrow.flight.integration.tests">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a> in <a href="../../../../../org/apache/arrow/flight/integration/tests/package-summary.html">org.apache.arrow.flight.integration.tests</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../org/apache/arrow/flight/integration/tests/package-summary.html">org.apache.arrow.flight.integration.tests</a> with parameters of type <a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">LocationReuseConnectionScenario.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/integration/tests/LocationReuseConnectionScenario.html#buildServer-org.apache.arrow.flight.FlightServer.Builder-">buildServer</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;builder)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">OrderedScenario.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/integration/tests/OrderedScenario.html#buildServer-org.apache.arrow.flight.FlightServer.Builder-">buildServer</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;builder)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">FlightSqlScenario.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/flight/integration/tests/FlightSqlScenario.html#buildServer-org.apache.arrow.flight.FlightServer.Builder-">buildServer</a></span>(<a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">FlightServer.Builder</a>&nbsp;builder)</code>&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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><a href="../../../../../org/apache/arrow/flight/FlightServer.Builder.html" title="class in org.apache.arrow.flight">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../../../../../overview-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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/arrow/flight/class-use/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>
<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>