| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>ContainerInitializer.ServletContainerInitializerServletContextListener (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.servlet.listener, class: ContainerInitializer, class: ServletContainerInitializerServletContextListener"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ContainerInitializer.ServletContainerInitializerServletContextListener.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.servlet.listener</a></div> |
| <h1 title="Class ContainerInitializer.ServletContainerInitializerServletContextListener" class="title">Class ContainerInitializer.ServletContainerInitializerServletContextListener</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.jetty.servlet.listener.ContainerInitializer.ServletContainerInitializerServletContextListener</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>jakarta.servlet.ServletContextListener</code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="ContainerInitializer.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">ContainerInitializer.ServletContainerInitializerServletContextListener</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements jakarta.servlet.ServletContextListener</span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(jakarta.servlet.ServletContainerInitializer)" class="member-name-link">ServletContainerInitializerServletContextListener</a><wbr>(jakarta.servlet.ServletContainerInitializer sci)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addClasses(java.lang.Class...)" class="member-name-link">addClasses</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?>... classes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addClasses(java.lang.String...)" class="member-name-link">addClasses</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... classNames)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#afterStartup(java.util.function.Consumer)" class="member-name-link">afterStartup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><jakarta.servlet.ServletContext> consumer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a optional consumer to execute once the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> has |
| been called successfully.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextDestroyed(jakarta.servlet.ServletContextEvent)" class="member-name-link">contextDestroyed</a><wbr>(jakarta.servlet.ServletContextEvent sce)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextInitialized(jakarta.servlet.ServletContextEvent)" class="member-name-link">contextInitialized</a><wbr>(jakarta.servlet.ServletContextEvent sce)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClasses()" class="member-name-link">getClasses</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(jakarta.servlet.ServletContainerInitializer)"> |
| <h3>ServletContainerInitializerServletContextListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ServletContainerInitializerServletContextListener</span><wbr><span class="parameters">(jakarta.servlet.ServletContainerInitializer sci)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addClasses(java.lang.String...)"> |
| <h3>addClasses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></span> <span class="element-name">addClasses</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... classNames)</span></div> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call. |
| <p> |
| Note that these classes will be loaded using the context classloader for the ServletContext |
| initialization phase. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>classNames</code> - the class names to load and pass into the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call</dd> |
| <dt>Returns:</dt> |
| <dd>this configured <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener"><code>ContainerInitializer.ServletContainerInitializerServletContextListener</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addClasses(java.lang.Class...)"> |
| <h3>addClasses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></span> <span class="element-name">addClasses</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?>... classes)</span></div> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call. |
| <p> |
| Note that these classes will exist on the classloader that was used to call this method. |
| If you want the classes to be loaded using the context classloader for the ServletContext |
| then use the String form of the classes via the <a href="#addClasses(java.lang.String...)"><code>addClasses(String...)</code></a> method. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>classes</code> - the classes to pass into the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call</dd> |
| <dt>Returns:</dt> |
| <dd>this configured <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener"><code>ContainerInitializer.ServletContainerInitializerServletContextListener</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="afterStartup(java.util.function.Consumer)"> |
| <h3>afterStartup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></span> <span class="element-name">afterStartup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><jakarta.servlet.ServletContext> consumer)</span></div> |
| <div class="block">Add a optional consumer to execute once the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> has |
| been called successfully. |
| <p> |
| This would be for actions to perform on a ServletContext once this specific SCI has completed |
| its execution. Actions that would require specific configurations that the SCI provides to be present on the |
| ServletContext to function properly. |
| </p> |
| <p> |
| This consumer is typically used for Embedded Jetty users to configure Jetty for their specific needs. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>consumer</code> - the consumer to execute after the SCI has executed</dd> |
| <dt>Returns:</dt> |
| <dd>this configured <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener"><code>ContainerInitializer.ServletContainerInitializerServletContextListener</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contextInitialized(jakarta.servlet.ServletContextEvent)"> |
| <h3>contextInitialized</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">contextInitialized</span><wbr><span class="parameters">(jakarta.servlet.ServletContextEvent sce)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>contextInitialized</code> in interface <code>jakarta.servlet.ServletContextListener</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClasses()"> |
| <h3>getClasses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?>></span> <span class="element-name">getClasses</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contextDestroyed(jakarta.servlet.ServletContextEvent)"> |
| <h3>contextDestroyed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">contextDestroyed</span><wbr><span class="parameters">(jakarta.servlet.ServletContextEvent sce)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>contextDestroyed</code> in interface <code>jakarta.servlet.ServletContextListener</code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
