| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:41:33 CST 2022 --> |
| <title>ContainerInitializer.ServletContainerInitializerServletContextListener (Eclipse Jetty API Doc - v11.0.8)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-02-08"> |
| <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="ContainerInitializer.ServletContainerInitializerServletContextListener (Eclipse Jetty API Doc - v11.0.8)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All 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: </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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.servlet.listener</a></div> |
| <h2 title="Class ContainerInitializer.ServletContainerInitializerServletContextListener" class="title">Class ContainerInitializer.ServletContainerInitializerServletContextListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.servlet.listener.ContainerInitializer.ServletContainerInitializerServletContextListener</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>jakarta.servlet.ServletContextListener</code>, <code>java.util.EventListener</code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="ContainerInitializer.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer</a></dd> |
| </dl> |
| <hr> |
| <pre>public static class <span class="typeNameLabel">ContainerInitializer.ServletContainerInitializerServletContextListener</span> |
| extends java.lang.Object |
| implements jakarta.servlet.ServletContextListener</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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(jakarta.servlet.ServletContainerInitializer)">ServletContainerInitializerServletContextListener</a></span>​(jakarta.servlet.ServletContainerInitializer sci)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addClasses(java.lang.Class...)">addClasses</a></span>​(java.lang.Class<?>... classes)</code></th> |
| <td class="colLast"> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addClasses(java.lang.String...)">addClasses</a></span>​(java.lang.String... classNames)</code></th> |
| <td class="colLast"> |
| <div class="block">Add classes to be passed to the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterStartup(java.util.function.Consumer)">afterStartup</a></span>​(java.util.function.Consumer<jakarta.servlet.ServletContext> consumer)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a optional consumer to execute once the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> has |
| been called successfully.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextDestroyed(jakarta.servlet.ServletContextEvent)">contextDestroyed</a></span>​(jakarta.servlet.ServletContextEvent sce)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contextInitialized(jakarta.servlet.ServletContextEvent)">contextInitialized</a></span>​(jakarta.servlet.ServletContextEvent sce)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.Class<?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClasses()">getClasses</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(jakarta.servlet.ServletContainerInitializer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServletContainerInitializerServletContextListener</h4> |
| <pre>public ServletContainerInitializerServletContextListener​(jakarta.servlet.ServletContainerInitializer sci)</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="addClasses(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addClasses</h4> |
| <pre class="methodSignature">public <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a> addClasses​(java.lang.String... classNames)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classNames</code> - the class names to load and pass into the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call</dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="addClasses(java.lang.Class...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addClasses</h4> |
| <pre class="methodSignature">public <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a> addClasses​(java.lang.Class<?>... classes)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classes</code> - the classes to pass into the <code>ServletContainerInitializer.onStartup(Set, ServletContext)</code> call</dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="afterStartup(java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>afterStartup</h4> |
| <pre class="methodSignature">public <a href="ContainerInitializer.ServletContainerInitializerServletContextListener.html" title="class in org.eclipse.jetty.servlet.listener">ContainerInitializer.ServletContainerInitializerServletContextListener</a> afterStartup​(java.util.function.Consumer<jakarta.servlet.ServletContext> consumer)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>consumer</code> - the consumer to execute after the SCI has executed</dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </li> |
| </ul> |
| <a id="contextInitialized(jakarta.servlet.ServletContextEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contextInitialized</h4> |
| <pre class="methodSignature">public void contextInitialized​(jakarta.servlet.ServletContextEvent sce)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>contextInitialized</code> in interface <code>jakarta.servlet.ServletContextListener</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClasses</h4> |
| <pre class="methodSignature">public java.util.Set<java.lang.Class<?>> getClasses()</pre> |
| </li> |
| </ul> |
| <a id="contextDestroyed(jakarta.servlet.ServletContextEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>contextDestroyed</h4> |
| <pre class="methodSignature">public void contextDestroyed​(jakarta.servlet.ServletContextEvent sce)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>contextDestroyed</code> in interface <code>jakarta.servlet.ServletContextListener</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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All 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: </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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |