| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>DefaultServlet (Eclipse Jetty API Doc - v10.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, class: DefaultServlet"> |
| <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/DefaultServlet.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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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</a></div> |
| <h1 title="Class DefaultServlet" class="title">Class DefaultServlet</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">javax.servlet.GenericServlet |
| <div class="inheritance">javax.servlet.http.HttpServlet |
| <div class="inheritance">org.eclipse.jetty.servlet.DefaultServlet</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code>javax.servlet.Servlet</code>, <code>javax.servlet.ServletConfig</code>, <code><a href="../server/ResourceService.WelcomeFactory.html" title="interface in org.eclipse.jetty.server">ResourceService.WelcomeFactory</a></code>, <code><a href="../util/resource/ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultServlet</span> |
| <span class="extends-implements">extends javax.servlet.http.HttpServlet |
| implements <a href="../util/resource/ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a>, <a href="../server/ResourceService.WelcomeFactory.html" title="interface in org.eclipse.jetty.server">ResourceService.WelcomeFactory</a></span></div> |
| <div class="block">The default servlet. |
| <p> |
| This servlet, normally mapped to /, provides the handling for static |
| content, OPTION and TRACE methods for the context. |
| The following initParameters are supported, these can be set either |
| on the servlet itself or as ServletContext initParameters with a prefix |
| of org.eclipse.jetty.servlet.Default. : |
| <pre> |
| acceptRanges If true, range requests and responses are |
| supported |
| |
| dirAllowed If true, directory listings are returned if no |
| welcome file is found. Else 403 Forbidden. |
| |
| welcomeServlets If true, attempt to dispatch to welcome files |
| that are servlets, but only after no matching static |
| resources could be found. If false, then a welcome |
| file must exist on disk. If "exact", then exact |
| servlet matches are supported without an existing file. |
| Default is false. |
| |
| This must be false if you want directory listings, |
| but have index.jsp in your welcome file list. |
| |
| redirectWelcome If true, welcome files are redirected rather than |
| forwarded to. |
| |
| gzip If set to true, then static content will be served as |
| gzip content encoded if a matching resource is |
| found ending with ".gz" (default false) |
| (deprecated: use precompressed) |
| |
| precompressed If set to a comma separated list of encoding types (that may be |
| listed in a requests Accept-Encoding header) to file |
| extension mappings to look for and serve. For example: |
| "br=.br,gzip=.gz,bzip2=.bz". |
| If set to a boolean True, then a default set of compressed formats |
| will be used, otherwise no precompressed formats. |
| |
| resourceBase Set to replace the context resource base |
| |
| resourceCache If set, this is a context attribute name, which the servlet |
| will use to look for a shared ResourceCache instance. |
| |
| relativeResourceBase |
| Set with a pathname relative to the base of the |
| servlet context root. Useful for only serving static content out |
| of only specific subdirectories. |
| |
| pathInfoOnly If true, only the path info will be applied to the resourceBase |
| |
| stylesheet Set with the location of an optional stylesheet that will be used |
| to decorate the directory listing html. |
| |
| etags If True, weak etags will be generated and handled. |
| |
| maxCacheSize The maximum total size of the cache or 0 for no cache. |
| maxCachedFileSize The maximum size of a file to cache |
| maxCachedFiles The maximum number of files to cache |
| |
| useFileMappedBuffer |
| If set to true, it will use mapped file buffer to serve static content |
| when using NIO connector. Setting this value to false means that |
| a direct buffer will be used instead of a mapped file buffer. |
| This is set to false by default by this class, but may be overridden |
| by eg webdefault.xml |
| |
| cacheControl If set, all static content will have this value set as the cache-control |
| header. |
| |
| otherGzipFileExtensions |
| Other file extensions that signify that a file is already compressed. Eg ".svgz" |
| |
| encodingHeaderCacheSize |
| Max entries in a cache of ACCEPT-ENCODING headers. |
| </pre></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.eclipse.jetty.servlet.DefaultServlet">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#CONTEXT_INIT" class="member-name-link">CONTEXT_INIT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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()" class="member-name-link">DefaultServlet</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.server.ResourceService)" class="member-name-link">DefaultServlet</a><wbr>(<a href="../server/ResourceService.html" title="class in org.eclipse.jetty.server">ResourceService</a> resourceService)</code></div> |
| <div class="col-last odd-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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#destroy()" class="member-name-link">destroy</a>()</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doGet(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)" class="member-name-link">doGet</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doHead(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)" class="member-name-link">doHead</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doOptions(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)" class="member-name-link">doOptions</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</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>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doPost(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)" class="member-name-link">doPost</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</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>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doTrace(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)" class="member-name-link">doTrace</a><wbr>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</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><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInitParameter(java.lang.String)" class="member-name-link">getInitParameter</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> name)</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="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResource(java.lang.String)" class="member-name-link">getResource</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> pathInContext)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">get Resource to serve.</div> |
| </div> |
| <div class="col-first even-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWelcomeFile(java.lang.String)" class="member-name-link">getWelcomeFile</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> pathInContext)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Finds a matching welcome file for the supplied <a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource"><code>Resource</code></a>.</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="#init()" class="member-name-link">init</a>()</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>protected <a href="../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initContextHandler(javax.servlet.ServletContext)" class="member-name-link">initContextHandler</a><wbr>(javax.servlet.ServletContext servletContext)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compute the field _contextHandler.<br> |
| In the case where the DefaultServlet is deployed on the HttpService it is likely that |
| this method needs to be overwritten to unwrap the ServletContext facade until we reach |
| the original jetty's ContextHandler.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-javax.servlet.http.HttpServlet">Methods inherited from class javax.servlet.http.HttpServlet</h3> |
| <code>doDelete, doPut, getLastModified, service, service</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-javax.servlet.GenericServlet">Methods inherited from class javax.servlet.GenericServlet</h3> |
| <code>getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log</code></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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="CONTEXT_INIT"> |
| <h3>CONTEXT_INIT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">CONTEXT_INIT</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.eclipse.jetty.servlet.DefaultServlet.CONTEXT_INIT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.server.ResourceService)"> |
| <h3>DefaultServlet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultServlet</span><wbr><span class="parameters">(<a href="../server/ResourceService.html" title="class in org.eclipse.jetty.server">ResourceService</a> resourceService)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>DefaultServlet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DefaultServlet</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="init()"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">init</span>() |
| throws <span class="exceptions">javax.servlet.UnavailableException</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>init</code> in class <code>javax.servlet.GenericServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.UnavailableException</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initContextHandler(javax.servlet.ServletContext)"> |
| <h3>initContextHandler</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../server/handler/ContextHandler.html" title="class in org.eclipse.jetty.server.handler">ContextHandler</a></span> <span class="element-name">initContextHandler</span><wbr><span class="parameters">(javax.servlet.ServletContext servletContext)</span></div> |
| <div class="block">Compute the field _contextHandler.<br> |
| In the case where the DefaultServlet is deployed on the HttpService it is likely that |
| this method needs to be overwritten to unwrap the ServletContext facade until we reach |
| the original jetty's ContextHandler.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>servletContext</code> - The servletContext of this servlet.</dd> |
| <dt>Returns:</dt> |
| <dd>the jetty's ContextHandler for this servletContext.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInitParameter(java.lang.String)"> |
| <h3>getInitParameter</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getInitParameter</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> name)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getInitParameter</code> in interface <code>javax.servlet.ServletConfig</code></dd> |
| <dt>Overrides:</dt> |
| <dd><code>getInitParameter</code> in class <code>javax.servlet.GenericServlet</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResource(java.lang.String)"> |
| <h3>getResource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource">Resource</a></span> <span class="element-name">getResource</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> pathInContext)</span></div> |
| <div class="block">get Resource to serve. |
| Map a path to a resource. The default implementation calls |
| HttpContext.getResource but derived servlets may provide |
| their own mapping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/resource/ResourceFactory.html#getResource(java.lang.String)">getResource</a></code> in interface <code><a href="../util/resource/ResourceFactory.html" title="interface in org.eclipse.jetty.util.resource">ResourceFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>pathInContext</code> - The path to find a resource for.</dd> |
| <dt>Returns:</dt> |
| <dd>The resource to serve.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doGet(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <h3>doGet</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doGet</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions">javax.servlet.ServletException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>doGet</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doPost(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <h3>doPost</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doPost</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions">javax.servlet.ServletException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>doPost</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doHead(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <h3>doHead</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doHead</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions">javax.servlet.ServletException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>doHead</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doTrace(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <h3>doTrace</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doTrace</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions">javax.servlet.ServletException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>doTrace</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doOptions(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)"> |
| <h3>doOptions</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">doOptions</span><wbr><span class="parameters">(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</span> |
| throws <span class="exceptions">javax.servlet.ServletException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>doOptions</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="destroy()"> |
| <h3>destroy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">destroy</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>destroy</code> in interface <code>javax.servlet.Servlet</code></dd> |
| <dt>Overrides:</dt> |
| <dd><code>destroy</code> in class <code>javax.servlet.GenericServlet</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWelcomeFile(java.lang.String)"> |
| <h3>getWelcomeFile</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getWelcomeFile</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> pathInContext)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../server/ResourceService.WelcomeFactory.html#getWelcomeFile(java.lang.String)">ResourceService.WelcomeFactory</a></code></span></div> |
| <div class="block">Finds a matching welcome file for the supplied <a href="../util/resource/Resource.html" title="class in org.eclipse.jetty.util.resource"><code>Resource</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../server/ResourceService.WelcomeFactory.html#getWelcomeFile(java.lang.String)">getWelcomeFile</a></code> in interface <code><a href="../server/ResourceService.WelcomeFactory.html" title="interface in org.eclipse.jetty.server">ResourceService.WelcomeFactory</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>pathInContext</code> - the path of the request</dd> |
| <dt>Returns:</dt> |
| <dd>The path of the matching welcome file in context or null.</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> |