Google Git
Sign in
apache / juneau-website / 407f32cb31b8cf22db0e91937f587fbeac3b04fd / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / rest / servlet / BasicRestServletGroup.html
blob: 7fd75f574db96377f4c7219957bf1da36b85fe06 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a>
<span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.rest.servlet;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.apache.juneau.rest.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.apache.juneau.rest.annotation.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.apache.juneau.rest.beans.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.apache.juneau.rest.config.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Specialized subclass of {@link BasicRestServlet} for showing "group" pages.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Meant as a base class for top-level REST resources in servlet containers.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Provides support for JSON, XML, HTML, URL-Encoding, UON, XML, OpenAPI, and MessagePack. See {@link BasicUniversalConfig}<a name="line.27"></a>
<span class="sourceLineNo">028</span> * for details.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Implements the basic REST endpoints defined in {@link BasicRestOperations} and {@link BasicGroupOperations}.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Children are attached to this resource using the {@link Rest#children() @Rest(children)} annotation.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;ul class='seealso'&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;li class='link'&gt;{@doc jrs.AnnotatedClasses}<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;li class='extlink'&gt;{@source}<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;/ul&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @serial exclude<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@Rest<a name="line.43"></a>
<span class="sourceLineNo">044</span>public abstract class BasicRestServletGroup extends BasicRestServlet implements BasicGroupOperations {<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final long serialVersionUID = 1L;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> @Override /* BasicGroupOperations */<a name="line.48"></a>
<span class="sourceLineNo">049</span> public ChildResourceDescriptions getChildren(RestRequest req) {<a name="line.49"></a>
<span class="sourceLineNo">050</span> return ChildResourceDescriptions.of(req);<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span>}<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
</pre>
</div>
</body>
</html>