Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / org / apache / juneau / rest / servlet / BasicRestServlet.html
blob: 01116d8a968bf09f6560f551f1ebb8065e6dd542 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BasicRestServlet (Apache Juneau 9.0.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BasicRestServlet (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServletGroup.html" title="class in org.apache.juneau.rest.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/rest/servlet/BasicRestServlet.html" target="_top">Frames</a></li>
<li><a href="BasicRestServlet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.juneau.rest.servlet</div>
<h2 title="Class BasicRestServlet" class="title">Class BasicRestServlet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.servlet.GenericServlet</li>
<li>
<ul class="inheritance">
<li>javax.servlet.http.HttpServlet</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet">org.apache.juneau.rest.servlet.RestServlet</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.rest.servlet.BasicRestServlet</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, javax.servlet.Servlet, javax.servlet.ServletConfig, <a href="../../../../../org/apache/juneau/rest/config/BasicJsonConfig.html" title="interface in org.apache.juneau.rest.config">BasicJsonConfig</a>, <a href="../../../../../org/apache/juneau/rest/config/DefaultConfig.html" title="interface in org.apache.juneau.rest.config">DefaultConfig</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/juneau/examples/rest/dto/AtomFeedResource.html" title="class in org.apache.juneau.examples.rest.dto">AtomFeedResource</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServletGroup.html" title="class in org.apache.juneau.rest.servlet">BasicRestServletGroup</a>, <a href="../../../../../org/apache/juneau/microservice/resources/ConfigResource.html" title="class in org.apache.juneau.microservice.resources">ConfigResource</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/resources/DebugResource.html" title="class in org.apache.juneau.microservice.jetty.resources">DebugResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/DirectoryResource.html" title="class in org.apache.juneau.microservice.resources">DirectoryResource</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/template/HelloWorldResource.html" title="class in org.apache.juneau.microservice.jetty.template">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/dto/JsonSchemaResource.html" title="class in org.apache.juneau.examples.rest.dto">JsonSchemaResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/LogsResource.html" title="class in org.apache.juneau.microservice.resources">LogsResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/PhotosResource.html" title="class in org.apache.juneau.examples.rest">PhotosResource</a>, <a href="../../../../../org/apache/juneau/rest/remote/RrpcServlet.html" title="class in org.apache.juneau.rest.remote">RrpcServlet</a>, <a href="../../../../../org/apache/juneau/microservice/resources/ShutdownResource.html" title="class in org.apache.juneau.microservice.resources">ShutdownResource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.48">BasicRestServlet</a>
extends <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet">RestServlet</a>
implements <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a>, <a href="../../../../../org/apache/juneau/rest/config/BasicJsonConfig.html" title="interface in org.apache.juneau.rest.config">BasicJsonConfig</a></pre>
<div class="block">Subclass of <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet"><code>RestServlet</code></a> with default settings and standard methods defined.
<p>
Meant as a base class for top-level REST resources in servlet containers.
<p>
Provides basic JSON support by implementing the <a href="../../../../../org/apache/juneau/rest/config/BasicJsonConfig.html" title="interface in org.apache.juneau.rest.config"><code>BasicJsonConfig</code></a> interface.
Other language types can be added via the <a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#serializers--"><code>@Rest(serializers)</code></a>/<a href="../../../../../org/apache/juneau/rest/annotation/Rest.html#parsers--"><code>@Rest(parsers)</code></a> annotations
or by adding one of the predefined interfaces in <a href="../../../../../org/apache/juneau/rest/config/package-summary.html"><code>org.apache.juneau.rest.config</code></a>.
<p>
Implements the basic REST endpoints defined in <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet"><code>BasicRestOperations</code></a>.
<ul class='seealso'>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.jrs.AnnotatedClasses'>Overview &gt; juneau-rest-server &gt; @Rest-Annotated Classes</a>
<li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/servlet/BasicRestServlet.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#BasicRestServlet--">BasicRestServlet</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#error--">error</a></span>()</code>
<div class="block">[* /error] - Error occurred.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource">HttpResource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getFavIcon--">getFavIcon</a></span>()</code>
<div class="block">[GET favicon.ico] - Retrieve favorites icon image.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource">HttpResource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getHtdoc-java.lang.String-java.util.Locale-">getHtdoc</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">[GET /htdocs/*] - Retrieve static file.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/stats/RestContextStats.html" title="class in org.apache.juneau.rest.stats">RestContextStats</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getStats-org.apache.juneau.rest.RestRequest-">getStats</a></span>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req)</code>
<div class="block">[GET /stats] - Timing statistics.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getSwagger-org.apache.juneau.rest.RestRequest-">getSwagger</a></span>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req)</code>
<div class="block">[GET /api] - Show resource options.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.servlet.RestServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.rest.servlet.<a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet">RestServlet</a></h3>
<code><a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#createBeanStore-java.util.Optional-">createBeanStore</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#destroy--">destroy</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#doLog-java.util.logging.Level-java.lang.Throwable-java.util.function.Supplier-">doLog</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getContext--">getContext</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getPath--">getPath</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getRequest--">getRequest</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getResponse--">getResponse</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#init-javax.servlet.ServletConfig-">init</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.util.logging.Level-java.lang.Throwable-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.lang.String-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.lang.String-java.lang.Throwable-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onDestroy-org.apache.juneau.rest.RestContext-">onDestroy</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onEndCall-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">onEndCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onInit-org.apache.juneau.rest.RestContext.Builder-">onInit</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onPostCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPostCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onPostInit-org.apache.juneau.rest.RestContext-">onPostInit</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onPostInitChildFirst-org.apache.juneau.rest.RestContext-">onPostInitChildFirst</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onPreCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPreCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#onStartCall-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">onStartCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">service</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestServlet.html#setContext-org.apache.juneau.rest.RestContext-">setContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.http.HttpServlet</h3>
<code>doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.servlet.GenericServlet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.GenericServlet</h3>
<code>getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BasicRestServlet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BasicRestServlet</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.48">BasicRestServlet</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSwagger-org.apache.juneau.rest.RestRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSwagger</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.56">getSwagger</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getSwagger-org.apache.juneau.rest.RestRequest-">BasicRestOperations</a></code></span></div>
<div class="block">[GET /api] - Show resource options.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getSwagger-org.apache.juneau.rest.RestRequest-">getSwagger</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - The HTTP request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A bean containing the contents for the OPTIONS page.</dd>
</dl>
</li>
</ul>
<a name="getHtdoc-java.lang.String-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHtdoc</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource">HttpResource</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.61">getHtdoc</a>(<a href="../../../../../org/apache/juneau/http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation">@Path</a>(<a href="../../../../../org/apache/juneau/http/annotation/Path.html#value--">value</a>="/*")
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)
throws <a href="../../../../../org/apache/juneau/http/response/NotFound.html" title="class in org.apache.juneau.http.response">NotFound</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getHtdoc-java.lang.String-java.util.Locale-">BasicRestOperations</a></code></span></div>
<div class="block">[GET /htdocs/*] - Retrieve static file.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getHtdoc-java.lang.String-java.util.Locale-">getHtdoc</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - The path to retrieve.</dd>
<dd><code>locale</code> - The locale of the HTTP request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An HTTP resource representing the static file.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/http/response/NotFound.html" title="class in org.apache.juneau.http.response">NotFound</a></code></dd>
</dl>
</li>
</ul>
<a name="getFavIcon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFavIcon</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource">HttpResource</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.66">getFavIcon</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getFavIcon--">BasicRestOperations</a></code></span></div>
<div class="block">[GET favicon.ico] - Retrieve favorites icon image.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getFavIcon--">getFavIcon</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A bean containing the contents for the OPTIONS page.</dd>
</dl>
</li>
</ul>
<a name="error--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.72">error</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#error--">BasicRestOperations</a></code></span></div>
<div class="block">[* /error] - Error occurred.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#error--">error</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></code></dd>
</dl>
</li>
</ul>
<a name="getStats-org.apache.juneau.rest.RestRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStats</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/stats/RestContextStats.html" title="class in org.apache.juneau.rest.stats">RestContextStats</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestServlet.html#line.75">getStats</a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest">RestRequest</a>&nbsp;req)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getStats-org.apache.juneau.rest.RestRequest-">BasicRestOperations</a></code></span></div>
<div class="block">[GET /stats] - Timing statistics.
<p>
Timing statistics for method invocations on this resource.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getStats-org.apache.juneau.rest.RestRequest-">getStats</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - The HTTP request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A collection of timing statistics for each annotated method on this resource.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServletGroup.html" title="class in org.apache.juneau.rest.servlet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/rest/servlet/BasicRestServlet.html" target="_top">Frames</a></li>
<li><a href="BasicRestServlet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>