Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / websocket / jsr356 / server / deploy / WebSocketServerContainerInitializer.html
blob: 33dea172d8c3d7572063eeda57504a88b3454cb3 [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>WebSocketServerContainerInitializer (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="WebSocketServerContainerInitializer (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":41,"i2":41,"i3":9,"i4":9,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/WebSocketServerContainerInitializer.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><a href="#nested.class.summary">Nested</a>&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.websocket.jsr356.server.deploy</a></div>
<h2 title="Class WebSocketServerContainerInitializer" class="title">Class WebSocketServerContainerInitializer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.ServletContainerInitializer</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketServerContainerInitializer</span>
extends java.lang.Object
implements javax.servlet.ServletContainerInitializer</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="WebSocketServerContainerInitializer.Configurator.html" title="interface in org.eclipse.jetty.websocket.jsr356.server.deploy">WebSocketServerContainerInitializer.Configurator</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="WebSocketServerContainerInitializer.ContextDestroyListener.html" title="class in org.eclipse.jetty.websocket.jsr356.server.deploy">WebSocketServerContainerInitializer.ContextDestroyListener</a></span></code></th>
<td class="colLast">
<div class="block">DestroyListener</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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="#ADD_DYNAMIC_FILTER_KEY">ADD_DYNAMIC_FILTER_KEY</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="#ATTR_JAVAX_SERVER_CONTAINER">ATTR_JAVAX_SERVER_CONTAINER</a></span></code></th>
<td class="colLast">
<div class="block">The ServletContext attribute key name for the
ServerContainer per javax.websocket spec 1.0 final section 6.4 Programmatic Server Deployment</div>
</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="#ENABLE_KEY">ENABLE_KEY</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="#HTTPCLIENT_ATTRIBUTE">HTTPCLIENT_ATTRIBUTE</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()">WebSocketServerContainerInitializer</a></span>()</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)">configure</a></span>&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context,
<a href="WebSocketServerContainerInitializer.Configurator.html" title="interface in org.eclipse.jetty.websocket.jsr356.server.deploy">WebSocketServerContainerInitializer.Configurator</a>&nbsp;configurator)</code></th>
<td class="colLast">
<div class="block">Configure the <a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to call <a href="#onStartup(java.util.Set,javax.servlet.ServletContext)"><code>onStartup(Set, ServletContext)</code></a>
during the <code>ServletContext</code> initialization phase.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureContext(javax.servlet.ServletContext,org.eclipse.jetty.servlet.ServletContextHandler)">configureContext</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;jettyContext)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)"><code>configure(ServletContextHandler, Configurator)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureContext(org.eclipse.jetty.servlet.ServletContextHandler)">configureContext</a></span>&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)"><code>configure(ServletContextHandler, Configurator)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.eclipse.jetty.servlet.ServletContextHandler)">initialize</a></span>&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Immediately initialize the <code>ServletContext</code> with the default (and empty) <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEnabledViaContext(javax.servlet.ServletContext,java.lang.String,boolean)">isEnabledViaContext</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;keyName,
boolean&nbsp;defValue)</code></th>
<td class="colLast">
<div class="block">Test a ServletContext for <code>init-param</code> or <code>attribute</code> at <code>keyName</code> for
true or false setting that determines if the specified feature is enabled (or not).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onStartup(java.util.Set,javax.servlet.ServletContext)">onStartup</a></span>&#8203;(java.util.Set&lt;java.lang.Class&lt;?&gt;&gt;&nbsp;c,
javax.servlet.ServletContext&nbsp;context)</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, toString, 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="ATTR_JAVAX_SERVER_CONTAINER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ATTR_JAVAX_SERVER_CONTAINER</h4>
<pre>public static final&nbsp;java.lang.String ATTR_JAVAX_SERVER_CONTAINER</pre>
<div class="block">The ServletContext attribute key name for the
ServerContainer per javax.websocket spec 1.0 final section 6.4 Programmatic Server Deployment</div>
</li>
</ul>
<a id="ENABLE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENABLE_KEY</h4>
<pre>public static final&nbsp;java.lang.String ENABLE_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.ENABLE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ADD_DYNAMIC_FILTER_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ADD_DYNAMIC_FILTER_KEY</h4>
<pre>public static final&nbsp;java.lang.String ADD_DYNAMIC_FILTER_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.ADD_DYNAMIC_FILTER_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="HTTPCLIENT_ATTRIBUTE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HTTPCLIENT_ATTRIBUTE</h4>
<pre>public static final&nbsp;java.lang.String HTTPCLIENT_ATTRIBUTE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.HTTPCLIENT_ATTRIBUTE">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="blockListLast">
<li class="blockList">
<h4>WebSocketServerContainerInitializer</h4>
<pre>public&nbsp;WebSocketServerContainerInitializer()</pre>
</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="isEnabledViaContext(javax.servlet.ServletContext,java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabledViaContext</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isEnabledViaContext&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;keyName,
boolean&nbsp;defValue)</pre>
<div class="block">Test a ServletContext for <code>init-param</code> or <code>attribute</code> at <code>keyName</code> for
true or false setting that determines if the specified feature is enabled (or not).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the context to search</dd>
<dd><code>keyName</code> - the key name</dd>
<dd><code>defValue</code> - the default value, if the value is not specified in the context</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value for the feature key</dd>
</dl>
</li>
</ul>
<a id="configureContext(org.eclipse.jetty.servlet.ServletContextHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre class="methodSignature">@Deprecated
public static&nbsp;<a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a>&nbsp;configureContext&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)"><code>configure(ServletContextHandler, Configurator)</code></a> instead</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the <a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a configured <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code> - if the <a href="../../../server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> cannot be configured</dd>
</dl>
</li>
</ul>
<a id="configureContext(javax.servlet.ServletContext,org.eclipse.jetty.servlet.ServletContextHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre class="methodSignature">@Deprecated
public static&nbsp;<a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a>&nbsp;configureContext&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;jettyContext)
throws javax.servlet.ServletException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)"><code>configure(ServletContextHandler, Configurator)</code></a> instead</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - not used</dd>
<dd><code>jettyContext</code> - the <a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a configured <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code> - if the <a href="../../../server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> cannot be configured</dd>
</dl>
</li>
</ul>
<a id="initialize(org.eclipse.jetty.servlet.ServletContextHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public static&nbsp;<a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server">ServerContainer</a>&nbsp;initialize&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="block">Immediately initialize the <code>ServletContext</code> with the default (and empty) <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a>.
<p>
This method is typically called from <a href="#onStartup(java.util.Set,javax.servlet.ServletContext)"><code>onStartup(Set, ServletContext)</code></a> itself or from
another dependent <code>ServletContainerInitializer</code> that requires minimal setup to
be performed.
</p>
<p>
This method SHOULD NOT BE CALLED by users of Jetty.
Use the <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)"><code>configure(ServletContextHandler, Configurator)</code></a> method instead.
</p>
<p>
There is no enablement check here, and no automatic deployment of endpoints at this point
in time. It merely sets up the <code>ServletContext</code> so with the basics needed to start
configuring for `javax.websocket.server` based endpoints.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the context to work with</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a> for this context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a id="configure(org.eclipse.jetty.servlet.ServletContextHandler,org.eclipse.jetty.websocket.jsr356.server.deploy.WebSocketServerContainerInitializer.Configurator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;configure&#8203;(<a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context,
<a href="WebSocketServerContainerInitializer.Configurator.html" title="interface in org.eclipse.jetty.websocket.jsr356.server.deploy">WebSocketServerContainerInitializer.Configurator</a>&nbsp;configurator)</pre>
<div class="block">Configure the <a href="../../../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to call <a href="#onStartup(java.util.Set,javax.servlet.ServletContext)"><code>onStartup(Set, ServletContext)</code></a>
during the <code>ServletContext</code> initialization phase.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the context to add listener to</dd>
<dd><code>configurator</code> - the lambda that is called to allow the <a href="../ServerContainer.html" title="class in org.eclipse.jetty.websocket.jsr356.server"><code>ServerContainer</code></a> to
be configured during the <code>ServletContext</code> initialization phase</dd>
</dl>
</li>
</ul>
<a id="onStartup(java.util.Set,javax.servlet.ServletContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onStartup</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onStartup&#8203;(java.util.Set&lt;java.lang.Class&lt;?&gt;&gt;&nbsp;c,
javax.servlet.ServletContext&nbsp;context)
throws javax.servlet.ServletException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onStartup</code>&nbsp;in interface&nbsp;<code>javax.servlet.ServletContainerInitializer</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</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/WebSocketServerContainerInitializer.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><a href="#nested.class.summary">Nested</a>&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>