blob: 4bb227d564444da0d93d1f4363fa684269070eab [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>BasicRestOperations (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="BasicRestOperations (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BasicRestObjectGroup.html" title="class in org.apache.juneau.rest.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.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/BasicRestOperations.html" target="_top">Frames</a></li>
<li><a href="BasicRestOperations.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>Constr&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>Constr&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="Interface BasicRestOperations" class="title">Interface BasicRestOperations</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</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/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet">BasicRestObject</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObjectGroup.html" title="class in org.apache.juneau.rest.servlet">BasicRestObjectGroup</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet">BasicRestServlet</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/rest/springboot/BasicSpringRestServlet.html" title="class in org.apache.juneau.rest.springboot">BasicSpringRestServlet</a>, <a href="../../../../../org/apache/juneau/rest/springboot/BasicSpringRestServletGroup.html" title="class in org.apache.juneau.rest.springboot">BasicSpringRestServletGroup</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/examples/rest/dto/DtoExamples.html" title="class in org.apache.juneau.examples.rest.dto">DtoExamples</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/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/microservice/springboot/template/HelloWorldResource.html" title="class in org.apache.juneau.microservice.springboot.template">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/springboot/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest.springboot">HelloWorldResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html" title="class in org.apache.juneau.examples.rest">HtmlBeansResource</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/examples/rest/RequestEchoResource.html" title="class in org.apache.juneau.examples.rest">RequestEchoResource</a>, <a href="../../../../../org/apache/juneau/microservice/jetty/template/RootResources.html" title="class in org.apache.juneau.microservice.jetty.template">RootResources</a>, <a href="../../../../../org/apache/juneau/examples/rest/RootResources.html" title="class in org.apache.juneau.examples.rest">RootResources</a>, <a href="../../../../../org/apache/juneau/microservice/springboot/template/RootResources.html" title="class in org.apache.juneau.microservice.springboot.template">RootResources</a>, <a href="../../../../../org/apache/juneau/examples/rest/springboot/RootResources.html" title="class in org.apache.juneau.examples.rest.springboot">RootResources</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/SampleRootResource.html" title="class in org.apache.juneau.microservice.resources">SampleRootResource</a>, <a href="../../../../../org/apache/juneau/microservice/resources/ShutdownResource.html" title="class in org.apache.juneau.microservice.resources">ShutdownResource</a>, <a href="../../../../../org/apache/juneau/examples/rest/UtilityBeansResource.html" title="class in org.apache.juneau.examples.rest">UtilityBeansResource</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestOperations.html#line.87">BasicRestOperations</a></pre>
<div class="block">Basic REST operation methods.
<p>
Defines 5 special use REST operation endpoints:
</p>
<p class='bjava'>
<ja>@RestGet</ja>(path=<js>"/api/*"</js></js>)
<jk>public</jk> <a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger"><code>Swagger</code></a> <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getSwagger-org.apache.juneau.rest.RestRequest-"><code>getSwagger</code></a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> <jv>req</jv>);
<ja>@RestGet</ja>(path=<js>"/htdocs/*"</js>)
<jk>public</jk> <a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource"><code>HttpResource</code></a> <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getHtdoc-java.lang.String-java.util.Locale-"><code>getHtdoc</code></a>(<ja>@Path</ja> String <jv>path</jv>, Locale <jv>locale</jv>);
<ja>@RestGet</ja>(path=<js>"favicon.ico"</js>)
<jk>public</jk> <a href="../../../../../org/apache/juneau/http/resource/HttpResource.html" title="interface in org.apache.juneau.http.resource"><code>HttpResource</code></a> <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getFavIcon--"><code>getFavIcon</code></a>();
<ja>@RestGet</ja>(path=<js>"/stats"</js>)
<jk>public</jk> <a href="../../../../../org/apache/juneau/rest/stats/RestContextStats.html" title="class in org.apache.juneau.rest.stats"><code>RestContextStats</code></a> <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#getStats-org.apache.juneau.rest.RestRequest-"><code>getStats</code></a>(<a href="../../../../../org/apache/juneau/rest/RestRequest.html" title="class in org.apache.juneau.rest"><code>RestRequest</code></a> <jv>req</jv>);
<ja>@RestOp</ja>(method=<jsf>ANY</jsf>, path=<js>"/error"</js>)
<jk>public void</jk> <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html#error--"><code>error</code></a>();
</p>
<p>
Implementations provided by the following classes:
</p>
<ul class='javatreec'>
<li class='jac'><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet"><code>BasicRestServlet</code></a>
<li class='jac'><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServletGroup.html" title="class in org.apache.juneau.rest.servlet"><code>BasicRestServletGroup</code></a>
<li class='jac'><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet"><code>BasicRestObject</code></a>
<li class='jac'><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObjectGroup.html" title="class in org.apache.juneau.rest.servlet"><code>BasicRestObjectGroup</code></a>
</ul>
<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/BasicRestOperations.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/BasicRestOperations.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/BasicRestOperations.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/BasicRestOperations.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/BasicRestOperations.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/BasicRestOperations.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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ 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><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/BasicRestOperations.html#line.119">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">[GET /api] - Show resource options.</div>
<dl>
<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><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/BasicRestOperations.html#line.133">getHtdoc</a>(<a href="../../../../../org/apache/juneau/http/annotation/Path.html" title="annotation in org.apache.juneau.http.annotation">@Path</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)</pre>
<div class="block">[GET /htdocs/*] - Retrieve static file.</div>
<dl>
<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>
</dl>
</li>
</ul>
<a name="getFavIcon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFavIcon</h4>
<pre><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/BasicRestOperations.html#line.145">getFavIcon</a>()</pre>
<div class="block">[GET favicon.ico] - Retrieve favorites icon image.</div>
<dl>
<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>void&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/servlet/BasicRestOperations.html#line.161">error</a>()</pre>
<div class="block">[* /error] - Error occurred.</div>
</li>
</ul>
<a name="getStats-org.apache.juneau.rest.RestRequest-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStats</h4>
<pre><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/BasicRestOperations.html#line.188">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">[GET /stats] - Timing statistics.
<p>
Timing statistics for method invocations on this resource.</div>
<dl>
<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/BasicRestObjectGroup.html" title="class in org.apache.juneau.rest.servlet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.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/BasicRestOperations.html" target="_top">Frames</a></li>
<li><a href="BasicRestOperations.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>Constr&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>Constr&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>