blob: fafc59f14da845e79dd55dc0ea0e99a501981196 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ServletServerBuilder (grpc-all 1.77.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ServletServerBuilder (grpc-all 1.77.0 API)";
}
}
catch(err) {
}
//-->
var data = {"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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServletServerBuilder.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.grpc.servlet.jakarta</a></div>
<h2 title="Class ServletServerBuilder" class="title">Class ServletServerBuilder</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" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../ServerBuilder.html" title="class in io.grpc">io.grpc.ServerBuilder</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../ForwardingServerBuilder.html" title="class in io.grpc">io.grpc.ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</li>
<li>
<ul class="inheritance">
<li>io.grpc.servlet.jakarta.ServletServerBuilder</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre><a href="../../ExperimentalApi.html" title="annotation in io.grpc">@ExperimentalApi</a>("https://github.com/grpc/grpc-java/issues/5066")
@NotThreadSafe
public final class <span class="typeNameLabel">ServletServerBuilder</span>
extends <a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</pre>
<div class="block">Builder to build a gRPC server that can run as a servlet. This is for advanced custom settings.
Normally, users should consider extending the out-of-box <a href="GrpcServlet.html" title="class in io.grpc.servlet.jakarta"><code>GrpcServlet</code></a> directly instead.
<p>The API is experimental. The authors would like to know more about the real usecases. Users
are welcome to provide feedback by commenting on
<a href=https://github.com/grpc/grpc-java/issues/5066>the tracking issue</a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ServletServerBuilder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../Server.html" title="class in io.grpc">Server</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Builds a gRPC server that can run as a servlet.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="GrpcServlet.html" title="class in io.grpc.servlet.jakarta">GrpcServlet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildServlet()">buildServlet</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a <a href="GrpcServlet.html" title="class in io.grpc.servlet.jakarta"><code>GrpcServlet</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="ServletAdapter.html" title="class in io.grpc.servlet.jakarta">ServletAdapter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildServletAdapter()">buildServletAdapter</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a <a href="ServletAdapter.html" title="class in io.grpc.servlet.jakarta"><code>ServletAdapter</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../../ServerBuilder.html" title="class in io.grpc">ServerBuilder</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delegate()">delegate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the delegated <code>ServerBuilder</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxInboundMessageSize(int)">maxInboundMessageSize</a></span>&#8203;(int&nbsp;bytes)</code></th>
<td class="colLast">
<div class="block">Sets the maximum message size allowed to be received on the server.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#methodNameResolver(java.util.function.Function)">methodNameResolver</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;jakarta.servlet.http.HttpServletRequest,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;methodResolver)</code></th>
<td class="colLast">
<div class="block">Specifies how to determine gRPC method name from servlet request.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduledExecutorService(java.util.concurrent.ScheduledExecutorService)">scheduledExecutorService</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a>&nbsp;scheduler)</code></th>
<td class="colLast">
<div class="block">Provides a custom scheduled executor service to the server builder.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useTransportSecurity(java.io.File,java.io.File)">useTransportSecurity</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">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" class="externalLink">File</a>&nbsp;privateKey)</code></th>
<td class="colLast">
<div class="block">Throws <code>UnsupportedOperationException</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.io.grpc.ForwardingServerBuilder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;io.grpc.<a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a></h3>
<code><a href="../../ForwardingServerBuilder.html#addService(io.grpc.BindableService)">addService</a>, <a href="../../ForwardingServerBuilder.html#addService(io.grpc.ServerServiceDefinition)">addService</a>, <a href="../../ForwardingServerBuilder.html#addStreamTracerFactory(io.grpc.ServerStreamTracer.Factory)">addStreamTracerFactory</a>, <a href="../../ForwardingServerBuilder.html#addTransportFilter(io.grpc.ServerTransportFilter)">addTransportFilter</a>, <a href="../../ForwardingServerBuilder.html#callExecutor(io.grpc.ServerCallExecutorSupplier)">callExecutor</a>, <a href="../../ForwardingServerBuilder.html#compressorRegistry(io.grpc.CompressorRegistry)">compressorRegistry</a>, <a href="../../ForwardingServerBuilder.html#decompressorRegistry(io.grpc.DecompressorRegistry)">decompressorRegistry</a>, <a href="../../ForwardingServerBuilder.html#directExecutor()">directExecutor</a>, <a href="../../ForwardingServerBuilder.html#executor(java.util.concurrent.Executor)">executor</a>, <a href="../../ForwardingServerBuilder.html#fallbackHandlerRegistry(io.grpc.HandlerRegistry)">fallbackHandlerRegistry</a>, <a href="../../ForwardingServerBuilder.html#forPort(int)">forPort</a>, <a href="../../ForwardingServerBuilder.html#handshakeTimeout(long,java.util.concurrent.TimeUnit)">handshakeTimeout</a>, <a href="../../ForwardingServerBuilder.html#intercept(io.grpc.ServerInterceptor)">intercept</a>, <a href="../../ForwardingServerBuilder.html#keepAliveTime(long,java.util.concurrent.TimeUnit)">keepAliveTime</a>, <a href="../../ForwardingServerBuilder.html#keepAliveTimeout(long,java.util.concurrent.TimeUnit)">keepAliveTimeout</a>, <a href="../../ForwardingServerBuilder.html#maxConnectionAge(long,java.util.concurrent.TimeUnit)">maxConnectionAge</a>, <a href="../../ForwardingServerBuilder.html#maxConnectionAgeGrace(long,java.util.concurrent.TimeUnit)">maxConnectionAgeGrace</a>, <a href="../../ForwardingServerBuilder.html#maxConnectionIdle(long,java.util.concurrent.TimeUnit)">maxConnectionIdle</a>, <a href="../../ForwardingServerBuilder.html#maxInboundMetadataSize(int)">maxInboundMetadataSize</a>, <a href="../../ForwardingServerBuilder.html#permitKeepAliveTime(long,java.util.concurrent.TimeUnit)">permitKeepAliveTime</a>, <a href="../../ForwardingServerBuilder.html#permitKeepAliveWithoutCalls(boolean)">permitKeepAliveWithoutCalls</a>, <a href="../../ForwardingServerBuilder.html#setBinaryLog(io.grpc.BinaryLog)">setBinaryLog</a>, <a href="../../ForwardingServerBuilder.html#toString()">toString</a>, <a href="../../ForwardingServerBuilder.html#useTransportSecurity(java.io.InputStream,java.io.InputStream)">useTransportSecurity</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.io.grpc.ServerBuilder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;io.grpc.<a href="../../ServerBuilder.html" title="class in io.grpc">ServerBuilder</a></h3>
<code><a href="../../ServerBuilder.html#addServices(java.util.List)">addServices</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">notifyAll</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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServletServerBuilder</h4>
<pre>public&nbsp;ServletServerBuilder()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="build()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="../../Server.html" title="class in io.grpc">Server</a>&nbsp;build()</pre>
<div class="block">Builds a gRPC server that can run as a servlet.
<p>The returned server will not be started or bound to a port.
<p>Users should not call this method directly. Instead users should call
<a href="#buildServletAdapter()"><code>buildServletAdapter()</code></a> which internally will call <code>build()</code> and <code>start()</code>
appropriately.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../ForwardingServerBuilder.html#build()">build</a></code>&nbsp;in class&nbsp;<code><a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new Server</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if this method is called by users directly</dd>
</dl>
</li>
</ul>
<a id="buildServletAdapter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildServletAdapter</h4>
<pre class="methodSignature">public&nbsp;<a href="ServletAdapter.html" title="class in io.grpc.servlet.jakarta">ServletAdapter</a>&nbsp;buildServletAdapter()</pre>
<div class="block">Creates a <a href="ServletAdapter.html" title="class in io.grpc.servlet.jakarta"><code>ServletAdapter</code></a>.</div>
</li>
</ul>
<a id="buildServlet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildServlet</h4>
<pre class="methodSignature">public&nbsp;<a href="GrpcServlet.html" title="class in io.grpc.servlet.jakarta">GrpcServlet</a>&nbsp;buildServlet()</pre>
<div class="block">Creates a <a href="GrpcServlet.html" title="class in io.grpc.servlet.jakarta"><code>GrpcServlet</code></a>.</div>
</li>
</ul>
<a id="delegate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delegate</h4>
<pre class="methodSignature"><a href="../../Internal.html" title="annotation in io.grpc">@Internal</a>
protected&nbsp;<a href="../../ServerBuilder.html" title="class in io.grpc">ServerBuilder</a>&lt;?&gt;&nbsp;delegate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../ForwardingServerBuilder.html#delegate()">ForwardingServerBuilder</a></code></span></div>
<div class="block">Returns the delegated <code>ServerBuilder</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../ForwardingServerBuilder.html#delegate()">delegate</a></code>&nbsp;in class&nbsp;<code><a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="useTransportSecurity(java.io.File,java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useTransportSecurity</h4>
<pre class="methodSignature">public&nbsp;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&nbsp;useTransportSecurity&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">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" class="externalLink">File</a>&nbsp;privateKey)</pre>
<div class="block">Throws <code>UnsupportedOperationException</code>. TLS should be configured by the servlet
container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../ForwardingServerBuilder.html#useTransportSecurity(java.io.File,java.io.File)">useTransportSecurity</a></code>&nbsp;in class&nbsp;<code><a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>certChain</code> - file containing the full certificate chain</dd>
<dd><code>privateKey</code> - file containing the private key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a id="methodNameResolver(java.util.function.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>methodNameResolver</h4>
<pre class="methodSignature">public&nbsp;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&nbsp;methodNameResolver&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;jakarta.servlet.http.HttpServletRequest,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&gt;&nbsp;methodResolver)</pre>
<div class="block">Specifies how to determine gRPC method name from servlet request.
<p>The default strategy is using <code>HttpServletRequest.getRequestURI()</code> without the leading
slash.</p></div>
</li>
</ul>
<a id="maxInboundMessageSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxInboundMessageSize</h4>
<pre class="methodSignature">public&nbsp;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&nbsp;maxInboundMessageSize&#8203;(int&nbsp;bytes)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../ServerBuilder.html#maxInboundMessageSize(int)">ServerBuilder</a></code></span></div>
<div class="block">Sets the maximum message size allowed to be received on the server. If not called,
defaults to 4 MiB. The default provides protection to servers who haven't considered the
possibility of receiving large messages while trying to be large enough to not be hit in normal
usage.
<p>This method is advisory, and implementations may decide to not enforce this. Currently,
the only known transport to not enforce this is <code>InProcessServer</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../ForwardingServerBuilder.html#maxInboundMessageSize(int)">maxInboundMessageSize</a></code>&nbsp;in class&nbsp;<code><a href="../../ForwardingServerBuilder.html" title="class in io.grpc">ForwardingServerBuilder</a>&lt;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the maximum number of bytes a single message can be.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a id="scheduledExecutorService(java.util.concurrent.ScheduledExecutorService)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>scheduledExecutorService</h4>
<pre class="methodSignature">public&nbsp;<a href="ServletServerBuilder.html" title="class in io.grpc.servlet.jakarta">ServletServerBuilder</a>&nbsp;scheduledExecutorService&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a>&nbsp;scheduler)</pre>
<div class="block">Provides a custom scheduled executor service to the server builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServletServerBuilder.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>