Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.4.31.v20200723 / org / eclipse / jetty / websocket / common / extensions / WebSocketExtensionFactory.html
blob: b40f6f34f71dfbdfd8cb5e72eb7bc567cab3abf0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Wed Jul 29 16:44:05 EDT 2020 -->
<title>WebSocketExtensionFactory (Jetty :: Project 9.4.31.v20200723 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-07-29">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-migrate-3.0.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="WebSocketExtensionFactory (Jetty :: Project 9.4.31.v20200723 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,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":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/WebSocketExtensionFactory.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>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">org.eclipse.jetty.websocket.common.extensions</a></div>
<h2 title="Class WebSocketExtensionFactory" class="title">Class WebSocketExtensionFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">org.eclipse.jetty.websocket.api.extensions.ExtensionFactory</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.common.extensions.WebSocketExtensionFactory</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Iterable&lt;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;</code>, <code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketExtensionFactory</span>
extends <a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a>
implements <a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a>, <a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></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>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../../util/component/Dumpable.html#KEY">KEY</a></code></li>
</ul>
</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(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">WebSocketExtensionFactory</a></span>&#8203;(<a href="../scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;container)</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a></span>&#8203;(<a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump()">dump</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code></th>
<td class="colLast">
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</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="#dumpSelf()">dumpSelf</a></span>()</code></th>
<td class="colLast">
<div class="block">The description of this/self found in the dump.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAvailableExtensions()">getAvailableExtensions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtension(java.lang.String)">getExtension</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensionNames()">getExtensionNames</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="#isAvailable(java.lang.String)">isAvailable</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFailed()">isFailed</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRunning()">isRunning</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStarted()">isStarted</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStarting()">isStarting</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStopped()">isStopped</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStopping()">isStopping</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newInstance(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">newInstance</a></span>&#8203;(<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(java.lang.String,java.lang.Class)">register</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&nbsp;extension)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a></span>&#8203;(<a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">
<div class="block">Starts the component.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">
<div class="block">Stops the component.</div>
</td>
</tr>
<tr id="i20" 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>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unregister(java.lang.String)">unregister</a></span>&#8203;(java.lang.String&nbsp;name)</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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.Iterable</h3>
<code>forEach, spliterator</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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;(org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketExtensionFactory</h4>
<pre>public&nbsp;WebSocketExtensionFactory&#8203;(<a href="../scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>&nbsp;container)</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="getAvailableExtensions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableExtensions</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;&nbsp;getAvailableExtensions()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#getAvailableExtensions()">getAvailableExtensions</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="getExtension(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtension</h4>
<pre class="methodSignature">public&nbsp;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&nbsp;getExtension&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#getExtension(java.lang.String)">getExtension</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="getExtensionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensionNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getExtensionNames()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#getExtensionNames()">getExtensionNames</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="isAvailable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAvailable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isAvailable&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#isAvailable(java.lang.String)">isAvailable</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="newInstance(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre class="methodSignature">public&nbsp;<a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&nbsp;newInstance&#8203;(<a href="../../api/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>&nbsp;config)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#newInstance(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig)">newInstance</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="register(java.lang.String,java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;register&#8203;(java.lang.String&nbsp;name,
java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&nbsp;extension)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#register(java.lang.String,java.lang.Class)">register</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="unregister(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregister</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unregister&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#unregister(java.lang.String)">unregister</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre class="methodSignature">public&nbsp;java.util.Iterator&lt;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;&nbsp;iterator()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;java.lang.Class&lt;? extends <a href="../../api/extensions/Extension.html" title="interface in org.eclipse.jetty.websocket.api.extensions">Extension</a>&gt;&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../api/extensions/ExtensionFactory.html#iterator()">iterator</a></code>&nbsp;in class&nbsp;<code><a href="../../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/component/LifeCycle.html#start()">LifeCycle</a></code></span></div>
<div class="block">Starts the component.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#start()">start</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - If the component fails to start</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#isStarted()"><code>LifeCycle.isStarted()</code></a>,
<a href="../../../util/component/LifeCycle.html#stop()"><code>LifeCycle.stop()</code></a>,
<a href="../../../util/component/LifeCycle.html#isFailed()"><code>LifeCycle.isFailed()</code></a></dd>
</dl>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/component/LifeCycle.html#stop()">LifeCycle</a></code></span></div>
<div class="block">Stops the component.
The component may wait for current activities to complete
normally, but it can be interrupted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#stop()">stop</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - If the component fails to stop</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#isStopped()"><code>LifeCycle.isStopped()</code></a>,
<a href="../../../util/component/LifeCycle.html#start()"><code>LifeCycle.start()</code></a>,
<a href="../../../util/component/LifeCycle.html#isFailed()"><code>LifeCycle.isFailed()</code></a></dd>
</dl>
</li>
</ul>
<a id="isRunning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRunning()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isRunning()">isRunning</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component is starting or has been started.</dd>
</dl>
</li>
</ul>
<a id="isStarted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStarted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isStarted()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isStarted()">isStarted</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component has been started.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#start()"><code>LifeCycle.start()</code></a>,
<a href="../../../util/component/LifeCycle.html#isStarting()"><code>LifeCycle.isStarting()</code></a></dd>
</dl>
</li>
</ul>
<a id="isStarting()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStarting</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isStarting()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isStarting()">isStarting</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component is starting.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#isStarted()"><code>LifeCycle.isStarted()</code></a></dd>
</dl>
</li>
</ul>
<a id="isStopping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStopping</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isStopping()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isStopping()">isStopping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component is stopping.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#isStopped()"><code>LifeCycle.isStopped()</code></a></dd>
</dl>
</li>
</ul>
<a id="isStopped()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStopped</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isStopped()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isStopped()">isStopped</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component has been stopped.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../util/component/LifeCycle.html#stop()"><code>LifeCycle.stop()</code></a>,
<a href="../../../util/component/LifeCycle.html#isStopping()"><code>LifeCycle.isStopping()</code></a></dd>
</dl>
</li>
</ul>
<a id="isFailed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFailed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFailed()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#isFailed()">isFailed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the component has failed to start or has failed to stop.</dd>
</dl>
</li>
</ul>
<a id="addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLifeCycleListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addLifeCycleListener&#8203;(<a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
</dl>
</li>
</ul>
<a id="removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLifeCycleListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeLifeCycleListener&#8203;(<a href="../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/LifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code></dd>
</dl>
</li>
</ul>
<a id="dump()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;dump()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/Dumpable.html#dump()">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
</dl>
</li>
</ul>
<a id="dumpSelf()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpSelf</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;dumpSelf()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/component/Dumpable.html#dumpSelf()">Dumpable</a></code></span></div>
<div class="block">The description of this/self found in the dump.
Allows for alternative representation of Object other then .toString()
where the long form output of toString() is represented in a cleaner way
within the dump infrastructure.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the representation of self</dd>
</dl>
</li>
</ul>
<a id="dump(java.lang.Appendable,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;dump&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div>
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.
The indent should not be applied to the first object dumped.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - The appendable to dump to</dd>
<dd><code>indent</code> - The indent to apply after any new lines.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to write to Appendable</dd>
</dl>
</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/WebSocketExtensionFactory.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>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>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>