| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Feb 22 09:41:51 CST 2021 --> |
| <title>Configuration (Eclipse Jetty API Doc - v10.0.1)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-22"> |
| <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="Configuration (Eclipse Jetty API Doc - v10.0.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18,"i5":18,"i6":18,"i7":18,"i8":18,"i9":6,"i10":6,"i11":6,"i12":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Configuration.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.webapp</a></div> |
| <h2 title="Interface Configuration" class="title">Interface Configuration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractConfiguration.html" title="class in org.eclipse.jetty.webapp">AbstractConfiguration</a></code>, <code><a href="../annotations/AnnotationConfiguration.html" title="class in org.eclipse.jetty.annotations">AnnotationConfiguration</a></code>, <code><a href="../osgi/annotations/AnnotationConfiguration.html" title="class in org.eclipse.jetty.osgi.annotations">AnnotationConfiguration</a></code>, <code><a href="../ant/AntMetaInfConfiguration.html" title="class in org.eclipse.jetty.ant">AntMetaInfConfiguration</a></code>, <code><a href="../ant/AntWebInfConfiguration.html" title="class in org.eclipse.jetty.ant">AntWebInfConfiguration</a></code>, <code><a href="../ant/AntWebXmlConfiguration.html" title="class in org.eclipse.jetty.ant">AntWebXmlConfiguration</a></code>, <code><a href="../cdi/CdiConfiguration.html" title="class in org.eclipse.jetty.cdi">CdiConfiguration</a></code>, <code><a href="Configuration.Wrapper.html" title="class in org.eclipse.jetty.webapp">Configuration.Wrapper</a></code>, <code><a href="../plus/webapp/EnvConfiguration.html" title="class in org.eclipse.jetty.plus.webapp">EnvConfiguration</a></code>, <code><a href="FragmentConfiguration.html" title="class in org.eclipse.jetty.webapp">FragmentConfiguration</a></code>, <code><a href="JaasConfiguration.html" title="class in org.eclipse.jetty.webapp">JaasConfiguration</a></code>, <code><a href="../websocket/javax/server/config/JavaxWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.javax.server.config">JavaxWebSocketConfiguration</a></code>, <code><a href="../websocket/client/config/JettyWebSocketClientConfiguration.html" title="class in org.eclipse.jetty.websocket.client.config">JettyWebSocketClientConfiguration</a></code>, <code><a href="../websocket/server/config/JettyWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server.config">JettyWebSocketConfiguration</a></code>, <code><a href="JettyWebXmlConfiguration.html" title="class in org.eclipse.jetty.webapp">JettyWebXmlConfiguration</a></code>, <code><a href="JmxConfiguration.html" title="class in org.eclipse.jetty.webapp">JmxConfiguration</a></code>, <code><a href="JndiConfiguration.html" title="class in org.eclipse.jetty.webapp">JndiConfiguration</a></code>, <code><a href="JspConfiguration.html" title="class in org.eclipse.jetty.webapp">JspConfiguration</a></code>, <code><a href="../maven/plugin/MavenMetaInfConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenMetaInfConfiguration</a></code>, <code><a href="../maven/plugin/MavenQuickStartConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenQuickStartConfiguration</a></code>, <code><a href="../maven/plugin/MavenWebInfConfiguration.html" title="class in org.eclipse.jetty.maven.plugin">MavenWebInfConfiguration</a></code>, <code><a href="MetaInfConfiguration.html" title="class in org.eclipse.jetty.webapp">MetaInfConfiguration</a></code>, <code><a href="../osgi/boot/OSGiMetaInfConfiguration.html" title="class in org.eclipse.jetty.osgi.boot">OSGiMetaInfConfiguration</a></code>, <code><a href="../osgi/boot/OSGiWebInfConfiguration.html" title="class in org.eclipse.jetty.osgi.boot">OSGiWebInfConfiguration</a></code>, <code><a href="../plus/webapp/PlusConfiguration.html" title="class in org.eclipse.jetty.plus.webapp">PlusConfiguration</a></code>, <code><a href="../quickstart/QuickStartConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartConfiguration</a></code>, <code><a href="../quickstart/QuickStartGeneratorConfiguration.html" title="class in org.eclipse.jetty.quickstart">QuickStartGeneratorConfiguration</a></code>, <code><a href="ServletsConfiguration.html" title="class in org.eclipse.jetty.webapp">ServletsConfiguration</a></code>, <code><a href="WebAppConfiguration.html" title="class in org.eclipse.jetty.webapp">WebAppConfiguration</a></code>, <code><a href="WebInfConfiguration.html" title="class in org.eclipse.jetty.webapp">WebInfConfiguration</a></code>, <code><a href="WebXmlConfiguration.html" title="class in org.eclipse.jetty.webapp">WebXmlConfiguration</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Configuration</span></pre> |
| <div class="block">A pluggable Configuration for <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a>s. |
| <p> |
| A <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a> is configured by the application of one or more <a href="Configuration.html" title="interface in org.eclipse.jetty.webapp"><code>Configuration</code></a> |
| instances. Typically each implemented Configuration is responsible for an aspect of the |
| servlet specification (eg <a href="WebXmlConfiguration.html" title="class in org.eclipse.jetty.webapp"><code>WebXmlConfiguration</code></a>, <a href="FragmentConfiguration.html" title="class in org.eclipse.jetty.webapp"><code>FragmentConfiguration</code></a>, etc.) |
| or feature (eg <code>JavaxWebSocketConfiguration</code>, <code>JmxConfiguration</code> etc.) |
| </p> |
| <p>Configuration instances are discovered by the <a href="Configurations.html" title="class in org.eclipse.jetty.webapp"><code>Configurations</code></a> class using either the |
| <code>ServiceLoader</code> mechanism or by an explicit call to <a href="Configurations.html#setKnown(java.lang.String...)"><code>Configurations.setKnown(String...)</code></a>. |
| By default, all Configurations that do not return false from <a href="#isEnabledByDefault()"><code>isEnabledByDefault()</code></a> |
| are applied to all <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a>s within the JVM. However a Server wide default <a href="Configurations.html" title="class in org.eclipse.jetty.webapp"><code>Configurations</code></a> |
| collection may also be defined with <a href="Configurations.html#setServerDefault(org.eclipse.jetty.server.Server)"><code>Configurations.setServerDefault(org.eclipse.jetty.server.Server)</code></a>. |
| Furthermore, each individual Context may have its Configurations list explicitly set and/or amended with |
| <a href="WebAppContext.html#setConfigurations(org.eclipse.jetty.webapp.Configuration%5B%5D)"><code>WebAppContext.setConfigurations(Configuration[])</code></a>, <a href="WebAppContext.html#addConfiguration(org.eclipse.jetty.webapp.Configuration...)"><code>WebAppContext.addConfiguration(Configuration...)</code></a> |
| or <a href="WebAppContext.html#getConfigurations()"><code>WebAppContext.getConfigurations()</code></a>. |
| </p> |
| <p>Since Jetty-9.4, Configurations are self ordering using the <a href="#getDependencies()"><code>getDependencies()</code></a> and |
| <a href="#getDependents()"><code>getDependents()</code></a> methods for a <a href="../util/TopologicalSort.html" title="class in org.eclipse.jetty.util"><code>TopologicalSort</code></a> initiated by <a href="Configurations.html#sort()"><code>Configurations.sort()</code></a> |
| when a <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a> is started. This means that feature configurations |
| (eg <a href="JndiConfiguration.html" title="class in org.eclipse.jetty.webapp"><code>JndiConfiguration</code></a>, <a href="JaasConfiguration.html" title="class in org.eclipse.jetty.webapp"><code>JaasConfiguration</code></a>} etc.) can be added or removed without concern |
| for ordering. |
| </p> |
| <p>Also since Jetty-9.4, Configurations are responsible for providing <a href="#getServerClasses()"><code>getServerClasses()</code></a> and |
| <a href="#getSystemClasses()"><code>getSystemClasses()</code></a> to configure the <a href="WebAppClassLoader.html" title="class in org.eclipse.jetty.webapp"><code>WebAppClassLoader</code></a> for each context. |
| </p></div> |
| </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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Configuration.Wrapper.html" title="class in org.eclipse.jetty.webapp">Configuration.Wrapper</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Configuration.WrapperFunction.html" title="interface in org.eclipse.jetty.webapp">Configuration.WrapperFunction</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Experimental Wrapper mechanism for WebApp Configuration components.</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"> </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="#ATTR">ATTR</a></span></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abort(org.eclipse.jetty.webapp.WebAppContext)">abort</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.eclipse.jetty.webapp.WebAppContext)">configure</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Configure WebApp.</div> |
| </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="#deconfigure(org.eclipse.jetty.webapp.WebAppContext)">deconfigure</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">DeConfigure WebApp.</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="#destroy(org.eclipse.jetty.webapp.WebAppContext)">destroy</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Destroy WebApp.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default java.util.Collection<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDependencies()">getDependencies</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get known Configuration Dependencies.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default java.util.Collection<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDependents()">getDependents</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get known Configuration Dependents.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default <a href="ClassMatcher.html" title="class in org.eclipse.jetty.webapp">ClassMatcher</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerClasses()">getServerClasses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the system classes associated with this Configuration.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default <a href="ClassMatcher.html" title="class in org.eclipse.jetty.webapp">ClassMatcher</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSystemClasses()">getSystemClasses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the system classes associated with this Configuration.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAvailable()">isAvailable</a></span>()</code></th> |
| <td class="colLast"> </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="#isEnabledByDefault()">isEnabledByDefault</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#postConfigure(org.eclipse.jetty.webapp.WebAppContext)">postConfigure</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Clear down after configuration.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preConfigure(org.eclipse.jetty.webapp.WebAppContext)">preConfigure</a></span>​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Set up for configuration.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default java.lang.Class<? extends <a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaces()">replaces</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get a class that this class replaces/extends.</div> |
| </td> |
| </tr> |
| </table> |
| </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"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ATTR</h4> |
| <pre>static final java.lang.String ATTR</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.webapp.Configuration.ATTR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="isAvailable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAvailable</h4> |
| <pre class="methodSignature">default boolean isAvailable()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the feature this configuration represents is available and has all its dependencies.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replaces()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaces</h4> |
| <pre class="methodSignature">default java.lang.Class<? extends <a href="Configuration.html" title="interface in org.eclipse.jetty.webapp">Configuration</a>> replaces()</pre> |
| <div class="block">Get a class that this class replaces/extends. |
| If this is added to <a href="Configurations.html" title="class in org.eclipse.jetty.webapp"><code>Configurations</code></a> collection that already contains a |
| configuration of the replaced class or that reports to replace the same class, then |
| it is replaced with this instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The class this Configuration replaces/extends or null if it replaces no other configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDependencies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDependencies</h4> |
| <pre class="methodSignature">default java.util.Collection<java.lang.String> getDependencies()</pre> |
| <div class="block">Get known Configuration Dependencies.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The names of Configurations that <a href="../util/TopologicalSort.html" title="class in org.eclipse.jetty.util"><code>TopologicalSort</code></a> must order |
| before this configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDependents()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDependents</h4> |
| <pre class="methodSignature">default java.util.Collection<java.lang.String> getDependents()</pre> |
| <div class="block">Get known Configuration Dependents.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The names of Configurations that <a href="../util/TopologicalSort.html" title="class in org.eclipse.jetty.util"><code>TopologicalSort</code></a> must order |
| after this configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSystemClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSystemClasses</h4> |
| <pre class="methodSignature">default <a href="ClassMatcher.html" title="class in org.eclipse.jetty.webapp">ClassMatcher</a> getSystemClasses()</pre> |
| <div class="block">Get the system classes associated with this Configuration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClassMatcher of system classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServerClasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerClasses</h4> |
| <pre class="methodSignature">default <a href="ClassMatcher.html" title="class in org.eclipse.jetty.webapp">ClassMatcher</a> getServerClasses()</pre> |
| <div class="block">Get the system classes associated with this Configuration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ClassMatcher of server classes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="preConfigure(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preConfigure</h4> |
| <pre class="methodSignature">void preConfigure​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context) |
| throws java.lang.Exception</pre> |
| <div class="block">Set up for configuration. |
| <p> |
| Typically this step discovers configuration resources. |
| Calls to preConfigure may alter the Configurations configured on the |
| WebAppContext, so long as configurations prior to this configuration |
| are not altered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to configure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to pre configure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="configure(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre class="methodSignature">void configure​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context) |
| throws java.lang.Exception</pre> |
| <div class="block">Configure WebApp. |
| <p> |
| Typically this step applies the discovered configuration resources to |
| either the <a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp"><code>WebAppContext</code></a> or the associated <a href="MetaData.html" title="class in org.eclipse.jetty.webapp"><code>MetaData</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to configure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to configure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="postConfigure(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postConfigure</h4> |
| <pre class="methodSignature">void postConfigure​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context) |
| throws java.lang.Exception</pre> |
| <div class="block">Clear down after configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to configure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to post configure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deconfigure(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deconfigure</h4> |
| <pre class="methodSignature">void deconfigure​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context) |
| throws java.lang.Exception</pre> |
| <div class="block">DeConfigure WebApp. |
| This method is called to undo all configuration done. This is |
| called to allow the context to work correctly over a stop/start cycle</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to configure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to deconfigure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="destroy(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre class="methodSignature">void destroy​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context) |
| throws java.lang.Exception</pre> |
| <div class="block">Destroy WebApp. |
| This method is called to destroy a webappcontext. It is typically called when a context |
| is removed from a server handler hierarchy by the deployer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to configure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if unable to destroy</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isEnabledByDefault()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnabledByDefault</h4> |
| <pre class="methodSignature">boolean isEnabledByDefault()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if configuration is enabled by default</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="abort(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>abort</h4> |
| <pre class="methodSignature">boolean abort​(<a href="WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> context)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if configuration should be aborted</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/Configuration.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |