blob: 1813d841398574cffcb908613bb6b06897b6879a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>SecureRequestCustomizer (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SecureRequestCustomizer (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"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";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
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/SecureRequestCustomizer.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">org.eclipse.jetty.server</a></div>
<h2 title="Class SecureRequestCustomizer" class="title">Class SecureRequestCustomizer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.server.SecureRequestCustomizer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SecureRequestCustomizer</span>
extends java.lang.Object
implements <a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></pre>
<div class="block"><p>Customizer that extracts the attribute from an <code>SSLContext</code>
and sets them on the request with <code>ServletRequest.setAttribute(String, Object)</code>
according to Servlet Specification Requirements.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAVAX_SERVLET_REQUEST_CIPHER_SUITE">JAVAX_SERVLET_REQUEST_CIPHER_SUITE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAVAX_SERVLET_REQUEST_KEY_SIZE">JAVAX_SERVLET_REQUEST_KEY_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAVAX_SERVLET_REQUEST_SSL_SESSION_ID">JAVAX_SERVLET_REQUEST_SSL_SESSION_ID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE">JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<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()">SecureRequestCustomizer</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean)">SecureRequestCustomizer</a></span>&#8203;(boolean&nbsp;sniHostCheck)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean,boolean,long,boolean)">SecureRequestCustomizer</a></span>&#8203;(boolean&nbsp;sniRequired,
boolean&nbsp;sniHostCheck,
long&nbsp;stsMaxAgeSeconds,
boolean&nbsp;stsIncludeSubdomains)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean,long,boolean)">SecureRequestCustomizer</a></span>&#8203;(boolean&nbsp;sniHostCheck,
long&nbsp;stsMaxAgeSeconds,
boolean&nbsp;stsIncludeSubdomains)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#customize(javax.net.ssl.SSLEngine,org.eclipse.jetty.server.Request)">customize</a></span>&#8203;(javax.net.ssl.SSLEngine&nbsp;sslEngine,
<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">
Customizes the request attributes to be set for SSL requests.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)">customize</a></span>&#8203;(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
<a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a>&nbsp;channelConfig,
<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#customizeSecure(org.eclipse.jetty.server.Request)">customizeSecure</a></span>&#8203;(<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Customizes the request attributes for general secure settings.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslSessionAttribute()">getSslSessionAttribute</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStsMaxAge()">getStsMaxAge</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSniHostCheck()">isSniHostCheck</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSniRequired()">isSniRequired</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStsIncludeSubDomains()">isStsIncludeSubDomains</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSniHostCheck(boolean)">setSniHostCheck</a></span>&#8203;(boolean&nbsp;sniHostCheck)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSniRequired(boolean)">setSniRequired</a></span>&#8203;(boolean&nbsp;sniRequired)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSslSessionAttribute(java.lang.String)">setSslSessionAttribute</a></span>&#8203;(java.lang.String&nbsp;attribute)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStsIncludeSubDomains(boolean)">setStsIncludeSubDomains</a></span>&#8203;(boolean&nbsp;stsIncludeSubDomains)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStsMaxAge(long)">setStsMaxAge</a></span>&#8203;(long&nbsp;stsMaxAgeSeconds)</code></th>
<td class="colLast">
<div class="block">Set the Strict-Transport-Security max age.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStsMaxAge(long,java.util.concurrent.TimeUnit)">setStsMaxAge</a></span>&#8203;(long&nbsp;period,
java.util.concurrent.TimeUnit&nbsp;units)</code></th>
<td class="colLast">
<div class="block">Convenience method to call <a href="#setStsMaxAge(long)"><code>setStsMaxAge(long)</code></a></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE</h4>
<pre>public static final&nbsp;java.lang.String JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.server.SecureRequestCustomizer.JAVAX_SERVLET_REQUEST_X_509_CERTIFICATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JAVAX_SERVLET_REQUEST_CIPHER_SUITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JAVAX_SERVLET_REQUEST_CIPHER_SUITE</h4>
<pre>public static final&nbsp;java.lang.String JAVAX_SERVLET_REQUEST_CIPHER_SUITE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.server.SecureRequestCustomizer.JAVAX_SERVLET_REQUEST_CIPHER_SUITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JAVAX_SERVLET_REQUEST_KEY_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JAVAX_SERVLET_REQUEST_KEY_SIZE</h4>
<pre>public static final&nbsp;java.lang.String JAVAX_SERVLET_REQUEST_KEY_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.server.SecureRequestCustomizer.JAVAX_SERVLET_REQUEST_KEY_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JAVAX_SERVLET_REQUEST_SSL_SESSION_ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JAVAX_SERVLET_REQUEST_SSL_SESSION_ID</h4>
<pre>public static final&nbsp;java.lang.String JAVAX_SERVLET_REQUEST_SSL_SESSION_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.eclipse.jetty.server.SecureRequestCustomizer.JAVAX_SERVLET_REQUEST_SSL_SESSION_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SecureRequestCustomizer</h4>
<pre>public&nbsp;SecureRequestCustomizer()</pre>
</li>
</ul>
<a id="&lt;init&gt;(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SecureRequestCustomizer</h4>
<pre>public&nbsp;SecureRequestCustomizer&#8203;(<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("sniHostCheck")
boolean&nbsp;sniHostCheck)</pre>
</li>
</ul>
<a id="&lt;init&gt;(boolean,long,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SecureRequestCustomizer</h4>
<pre>public&nbsp;SecureRequestCustomizer&#8203;(<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("sniHostCheck")
boolean&nbsp;sniHostCheck,
<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("stsMaxAgeSeconds")
long&nbsp;stsMaxAgeSeconds,
<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("stsIncludeSubdomains")
boolean&nbsp;stsIncludeSubdomains)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sniHostCheck</code> - True if the SNI Host name must match.</dd>
<dd><code>stsMaxAgeSeconds</code> - The max age in seconds for a Strict-Transport-Security response header. If set less than zero then no header is sent.</dd>
<dd><code>stsIncludeSubdomains</code> - If true, a include subdomain property is sent with any Strict-Transport-Security header</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(boolean,boolean,long,boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecureRequestCustomizer</h4>
<pre>public&nbsp;SecureRequestCustomizer&#8203;(<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("sniRequired")
boolean&nbsp;sniRequired,
<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("sniHostCheck")
boolean&nbsp;sniHostCheck,
<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("stsMaxAgeSeconds")
long&nbsp;stsMaxAgeSeconds,
<a href="../util/annotation/Name.html" title="annotation in org.eclipse.jetty.util.annotation">@Name</a>("stsIncludeSubdomains")
boolean&nbsp;stsIncludeSubdomains)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sniRequired</code> - True if a SNI certificate is required.</dd>
<dd><code>sniHostCheck</code> - True if the SNI Host name must match.</dd>
<dd><code>stsMaxAgeSeconds</code> - The max age in seconds for a Strict-Transport-Security response header. If set less than zero then no header is sent.</dd>
<dd><code>stsIncludeSubdomains</code> - If true, a include subdomain property is sent with any Strict-Transport-Security header</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isSniHostCheck()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSniHostCheck</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSniHostCheck()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the SNI Host name must match when there is an SNI certificate.</dd>
</dl>
</li>
</ul>
<a id="setSniHostCheck(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSniHostCheck</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSniHostCheck&#8203;(boolean&nbsp;sniHostCheck)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sniHostCheck</code> - True if the SNI Host name must match when there is an SNI certificate.</dd>
</dl>
</li>
</ul>
<a id="isSniRequired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSniRequired</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSniRequired()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if SNI is required, else requests will be rejected with 400 response.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../util/ssl/SslContextFactory.Server.html#isSniRequired()"><code>SslContextFactory.Server.isSniRequired()</code></a></dd>
</dl>
</li>
</ul>
<a id="setSniRequired(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSniRequired</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSniRequired&#8203;(boolean&nbsp;sniRequired)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sniRequired</code> - True if SNI is required, else requests will be rejected with 400 response.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../util/ssl/SslContextFactory.Server.html#setSniRequired(boolean)"><code>SslContextFactory.Server.setSniRequired(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a id="getStsMaxAge()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStsMaxAge</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getStsMaxAge()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The max age in seconds for a Strict-Transport-Security response header. If set less than zero then no header is sent.</dd>
</dl>
</li>
</ul>
<a id="setStsMaxAge(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStsMaxAge</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setStsMaxAge&#8203;(long&nbsp;stsMaxAgeSeconds)</pre>
<div class="block">Set the Strict-Transport-Security max age.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stsMaxAgeSeconds</code> - The max age in seconds for a Strict-Transport-Security response header. If set less than zero then no header is sent.</dd>
</dl>
</li>
</ul>
<a id="setStsMaxAge(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStsMaxAge</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setStsMaxAge&#8203;(long&nbsp;period,
java.util.concurrent.TimeUnit&nbsp;units)</pre>
<div class="block">Convenience method to call <a href="#setStsMaxAge(long)"><code>setStsMaxAge(long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>period</code> - The period in units</dd>
<dd><code>units</code> - The <code>TimeUnit</code> of the period</dd>
</dl>
</li>
</ul>
<a id="isStsIncludeSubDomains()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStsIncludeSubDomains</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isStsIncludeSubDomains()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if a include subdomain property is sent with any Strict-Transport-Security header</dd>
</dl>
</li>
</ul>
<a id="setStsIncludeSubDomains(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStsIncludeSubDomains</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setStsIncludeSubDomains&#8203;(boolean&nbsp;stsIncludeSubDomains)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stsIncludeSubDomains</code> - If true, a include subdomain property is sent with any Strict-Transport-Security header</dd>
</dl>
</li>
</ul>
<a id="customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;customize&#8203;(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
<a href="HttpConfiguration.html" title="class in org.eclipse.jetty.server">HttpConfiguration</a>&nbsp;channelConfig,
<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="HttpConfiguration.Customizer.html#customize(org.eclipse.jetty.server.Connector,org.eclipse.jetty.server.HttpConfiguration,org.eclipse.jetty.server.Request)">customize</a></code>&nbsp;in interface&nbsp;<code><a href="HttpConfiguration.Customizer.html" title="interface in org.eclipse.jetty.server">HttpConfiguration.Customizer</a></code></dd>
</dl>
</li>
</ul>
<a id="customizeSecure(org.eclipse.jetty.server.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customizeSecure</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;customizeSecure&#8203;(<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</pre>
<div class="block">Customizes the request attributes for general secure settings.
The default impl calls <a href="Request.html#setSecure(boolean)"><code>Request.setSecure(boolean)</code></a> with true
and sets a response header if the Strict-Transport-Security options
are set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the request being customized</dd>
</dl>
</li>
</ul>
<a id="customize(javax.net.ssl.SSLEngine,org.eclipse.jetty.server.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>customize</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;customize&#8203;(javax.net.ssl.SSLEngine&nbsp;sslEngine,
<a href="Request.html" title="class in org.eclipse.jetty.server">Request</a>&nbsp;request)</pre>
<div class="block"><p>
Customizes the request attributes to be set for SSL requests.
</p>
<p>
The requirements of the Servlet specs are:
</p>
<ul>
<li>an attribute named "javax.servlet.request.ssl_session_id" of type String (since Servlet Spec 3.0).</li>
<li>an attribute named "javax.servlet.request.cipher_suite" of type String.</li>
<li>an attribute named "javax.servlet.request.key_size" of type Integer.</li>
<li>an attribute named "javax.servlet.request.X509Certificate" of type java.security.cert.X509Certificate[]. This
is an array of objects of type X509Certificate, the order of this array is defined as being in ascending order of
trust. The first certificate in the chain is the one set by the client, the next is the one used to authenticate
the first, and so on.</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslEngine</code> - the sslEngine to be customized.</dd>
<dd><code>request</code> - HttpRequest to be customized.</dd>
</dl>
</li>
</ul>
<a id="setSslSessionAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSslSessionAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSslSessionAttribute&#8203;(java.lang.String&nbsp;attribute)</pre>
</li>
</ul>
<a id="getSslSessionAttribute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSslSessionAttribute</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getSslSessionAttribute()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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/SecureRequestCustomizer.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>