blob: 22d262e95d262e21be87d034c7f11d80d0162b71 [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 java.util.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.servlet.http.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.juneau.dto.swagger.Swagger;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.juneau.rest.*;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.juneau.rest.annotation.*;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.juneau.rest.config.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.juneau.rest.stats.*;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.juneau.http.annotation.*;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.juneau.http.resource.*;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.juneau.http.response.*;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Identical to {@link BasicRestServlet} but doesn't extend from {@link HttpServlet}.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Meant as a base class for child REST resources in servlet containers and Spring Boot environments.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Provides support for JSON, XML, HTML, URL-Encoding, UON, XML, OpenAPI, and MessagePack. See {@link BasicUniversalConfig}<a name="line.35"></a>
<span class="sourceLineNo">036</span> * for details.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Implements the basic REST endpoints defined in {@link BasicRestOperations}.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;ul class='seealso'&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;li class='link'&gt;{@doc jrs.AnnotatedClasses}<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;li class='extlink'&gt;{@source}<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;/ul&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>@Rest<a name="line.46"></a>
<span class="sourceLineNo">047</span>public abstract class BasicRestObject extends RestObject implements BasicRestOperations, BasicUniversalConfig {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.49"></a>
<span class="sourceLineNo">050</span> // BasicRestConfig methods<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> @Override /* BasicRestOperations */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public Swagger getSwagger(RestRequest req) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> return req.getSwagger().orElseThrow(NotFound::new);<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override /* BasicRestOperations */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public HttpResource getHtdoc(@Path("/*") String path, Locale locale) throws NotFound {<a name="line.59"></a>
<span class="sourceLineNo">060</span> return getContext().getStaticFiles().resolve(path, locale).orElseThrow(NotFound::new);<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> @Override /* BasicRestOperations */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public HttpResource getFavIcon() {<a name="line.64"></a>
<span class="sourceLineNo">065</span> String favIcon = getContext().getConfig().get("REST/favicon").orElse("images/juneau.png");<a name="line.65"></a>
<span class="sourceLineNo">066</span> return getHtdoc(favIcon, null);<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override /* BasicRestOperations */<a name="line.69"></a>
<span class="sourceLineNo">070</span> public void error() {}<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> @Override /* BasicRestOperations */<a name="line.72"></a>
<span class="sourceLineNo">073</span> public RestContextStats getStats(RestRequest req) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return req.getContext().getStats();<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span>}<a name="line.76"></a>
</pre>
</div>
</body>
</html>