| <!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;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static javax.servlet.http.HttpServletResponse.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static org.apache.juneau.internal.CollectionUtils.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import static org.apache.juneau.internal.ObjectUtils.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import static org.apache.juneau.internal.IOUtils.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import static org.apache.juneau.rest.util.RestUtils.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import static org.apache.juneau.rest.Enablement.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import static org.apache.juneau.rest.HttpRuntimeException.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import static org.apache.juneau.BasicIllegalArgumentException.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.io.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.lang.reflect.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.lang.reflect.Method;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.nio.charset.*;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.time.*;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.*;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.*;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.concurrent.atomic.*;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.stream.*;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import javax.activation.*;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import javax.servlet.*;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import javax.servlet.http.*;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.juneau.*;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.juneau.annotation.*;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.juneau.collections.*;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.juneau.config.*;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.juneau.cp.*;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.juneau.cp.Messages;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.juneau.encoders.*;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.juneau.html.*;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.juneau.html.annotation.*;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.juneau.http.*;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.juneau.http.annotation.*;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.juneau.http.annotation.Body;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.juneau.http.annotation.FormData;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.juneau.http.annotation.HasFormData;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.juneau.http.annotation.HasQuery;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.juneau.http.annotation.Header;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.juneau.http.annotation.Path;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.juneau.http.annotation.Query;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>import org.apache.juneau.http.annotation.Response;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.juneau.httppart.*;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.juneau.httppart.bean.*;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>import org.apache.juneau.json.*;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>import org.apache.juneau.jsonschema.*;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>import org.apache.juneau.msgpack.*;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>import org.apache.juneau.mstat.*;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span>import org.apache.juneau.oapi.*;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span>import org.apache.juneau.parser.*;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span>import org.apache.juneau.plaintext.*;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span>import org.apache.juneau.reflect.*;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>import org.apache.juneau.rest.annotation.*;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>import org.apache.juneau.rest.converters.*;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span>import org.apache.juneau.http.exception.*;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span>import org.apache.juneau.http.remote.*;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span>import org.apache.juneau.rest.reshandlers.*;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span>import org.apache.juneau.rest.util.*;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span>import org.apache.juneau.rest.vars.*;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span>import org.apache.juneau.serializer.*;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span>import org.apache.juneau.soap.*;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span>import org.apache.juneau.svl.*;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span>import org.apache.juneau.uon.*;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span>import org.apache.juneau.urlencoding.*;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span>import org.apache.juneau.utils.*;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span>import org.apache.juneau.xml.*;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span>/**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Contains all the configuration on a REST resource and the entry points for handling REST calls.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <ul class='seealso'><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <li class='link'>{@doc RestContext}<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * </ul><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span>@ConfigurableContext(nocache=true)<a name="line.90"></a> |
| <span class="sourceLineNo">091</span>public class RestContext extends BeanContext {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /** Represents a null value for the {@link Rest#context()} annotation.*/<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> @SuppressWarnings("javadoc")<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> public static final class Null extends RestContext {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public Null(RestContextBuilder builder) throws Exception {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> super(builder);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> // Configurable properties<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> static final String PREFIX = "RestContext";<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Configuration property: Allow body URL parameter.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <h5 class='section'>Property:</h5><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <ul class='spaced-list'><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_allowBodyParam REST_allowBodyParam}<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <li><b>Name:</b> <js>"RestContext.allowBodyParam.b"</js><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <li><b>Data type:</b> <jk>boolean</jk><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * <li><b>System property:</b> <c>RestContext.allowBodyParam</c><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ALLOWBODYPARAM</c><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <li><b>Default:</b> <jk>true</jk><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <li><b>Annotations:</b><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * <ul><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#allowBodyParam()}<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * </ul><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * <li><b>Methods:</b><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <ul><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#allowBodyParam(boolean)}<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#dontAllowBodyParam()}<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * </ul><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * </ul><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <h5 class='section'>Description:</h5><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * <p><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * When enabled, the HTTP body content on PUT and POST requests can be passed in as text using the <js>"body"</js><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * URL parameter.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * <br><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * For example:<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <p class='bcode w800'><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * ?body=(name='John%20Smith',age=45)<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * </p><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> *<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * <h5 class='section'>Example:</h5><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <p class='bcode w800'><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * <ja>@Rest</ja>(allowBodyParam=<js>"$C{REST/allowBodyParam,false}"</js>)<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * <jk>public class</jk> MyResource {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> *<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * <jc>// Using method on builder.</jc><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * builder.allowBodyParam(<jk>false</jk>);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> *<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <jc>// Same, but using property.</jc><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * builder.set(<jsf>REST_allowBodyParam</jsf>, <jk>false</jk>);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> *<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * builder.allowBodyParam(<jk>false</jk>);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * </p><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> *<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * <ul class='notes'><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * <li><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * <js>'body'</js> parameter name is case-insensitive.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * <li><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Useful for debugging PUT and POST methods using only a browser.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * </ul><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public static final String REST_allowBodyParam = PREFIX + ".allowBodyParam.b";<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> /**<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * Configuration property: Allowed header URL parameters.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> *<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * <h5 class='section'>Property:</h5><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <ul class='spaced-list'><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_allowedHeaderParams REST_allowedHeaderParams}<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <li><b>Name:</b> <js>"RestContext.allowedHeaderParams.s"</js><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * <li><b>Data type:</b> <c>String</c> (comma-delimited)<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * <li><b>System property:</b> <c>RestContext.allowedHeaderParams</c><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ALLOWHEADERPARAMS</c><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * <li><b>Default:</b> <js>"Accept,Content-Type"</js><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * <li><b>Annotations:</b><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <ul><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#allowedHeaderParams()}<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * </ul><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * <li><b>Methods:</b><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * <ul><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#allowedHeaderParams(String)}<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * </ul><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * </ul><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> *<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * <h5 class='section'>Description:</h5><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * <p><a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * When specified, allows headers such as <js>"Accept"</js> and <js>"Content-Type"</js> to be passed in as URL query<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * parameters.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * <br><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * For example:<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * <p class='bcode w800'><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * ?Accept=text/json&amp;Content-Type=text/json<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * </p><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> *<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * <h5 class='section'>Example:</h5><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * <p class='bcode w800'><a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * <ja>@Rest</ja>(allowedHeaderParams=<js>"Accept,Content-Type"</js>)<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * <jk>public class</jk> MyResource {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> *<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> *<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * <jc>// Using method on builder.</jc><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * builder.allowedHeaderParams(<js>"Accept,Content-Type"</js>);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> *<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * <jc>// Same, but using property.</jc><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * builder.set(<jsf>REST_allowedHeaderParams</jsf>, <js>"Accept,Content-Type"</js>);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> *<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * builder.allowedHeaderParams(<js>"Accept,Content-Type"</js>);<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * </p><a name="line.227"></a> |
| <span class="sourceLineNo">228</span> *<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * <ul class='notes'><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * <li><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * Useful for debugging REST interface using only a browser so that you can quickly simulate header values<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * in the URL bar.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * <li><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * Header names are case-insensitive.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * <li><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Use <js>"*"</js> to allow any headers to be specified as URL parameters.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <li><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Use <js>"NONE"</js> (case insensitive) to suppress inheriting a value from a parent class.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * </ul><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> */<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> public static final String REST_allowedHeaderParams = PREFIX + ".allowedHeaderParams.s";<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> /**<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * Configuration property: Allowed method headers.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> *<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * <h5 class='section'>Property:</h5><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * <ul class='spaced-list'><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_allowedMethodHeaders REST_allowedMethodHeaders}<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * <li><b>Name:</b> <js>"RestContext.allowedMethodHeaders.s"</js><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * <li><b>Data type:</b> <c>String</c> (comma-delimited)<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * <li><b>System property:</b> <c>RestContext.allowedMethodHeaders</c><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ALLOWEDMETHODHEADERS</c><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * <li><b>Default:</b> empty string<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * <li><b>Annotations:</b><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <ul><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#allowedMethodHeaders()}<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * </ul><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * <li><b>Methods:</b><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * <ul><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#allowedMethodHeaders(String)}<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * </ul><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * </ul><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> *<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * <h5 class='section'>Description:</h5><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <p><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * A comma-delimited list of HTTP method names that are allowed to be passed as values in an <c>X-Method</c> HTTP header<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * to override the real HTTP method name.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * <p><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * Allows you to override the actual HTTP method with a simulated method.<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * <br>For example, if an HTTP Client API doesn't support <c>PATCH</c> but does support <c>POST</c> (because<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <c>PATCH</c> is not part of the original HTTP spec), you can add a <c>X-Method: PATCH</c> header on a normal<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * <c>HTTP POST /foo</c> request call which will make the HTTP call look like a <c>PATCH</c> request in any of the REST APIs.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> *<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * <h5 class='section'>Example:</h5><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * <p class='bcode w800'><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * <ja>@Rest</ja>(allowedMethodHeaders=<js>"PATCH"</js>)<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * <jk>public class</jk> MyResource {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> *<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> *<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * <jc>// Using method on builder.</jc><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * builder.allowedMethodHeaders(<js>"PATCH"</js>);<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> *<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * <jc>// Same, but using property.</jc><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * builder.set(<jsf>REST_allowedMethodHeaders</jsf>, <js>"PATCH"</js>);<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * }<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> *<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * builder.allowedMethodHeaders(<js>"PATCH"</js>);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * </p><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> *<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * <ul class='notes'><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * <li><a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * Method names are case-insensitive.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * <li><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * Use <js>"*"</js> to represent all methods.<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * <li><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * Use <js>"NONE"</js> (case insensitive) to suppress inheriting a value from a parent class.<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * </ul><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> */<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> public static final String REST_allowedMethodHeaders = PREFIX + ".allowedMethodHeaders.s";<a name="line.308"></a> |
| <span class="sourceLineNo">309</span><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> /**<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * Configuration property: Allowed method URL parameters.<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> *<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * <h5 class='section'>Property:</h5><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * <ul class='spaced-list'><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_allowedMethodParams REST_allowedMethodParams}<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * <li><b>Name:</b> <js>"RestContext.allowedMethodParams.s"</js><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * <li><b>Data type:</b> <c>String</c> (comma-delimited)<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * <li><b>System property:</b> <c>RestContext.allowedMethodParams</c><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ALLOWEDMETHODPARAMS</c><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * <li><b>Default:</b> <js>"HEAD,OPTIONS"</js><a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * <li><b>Annotations:</b><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * <ul><a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#allowedMethodParams()}<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * </ul><a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * <li><b>Methods:</b><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * <ul><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#allowedMethodParams(String)}<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * </ul><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * </ul><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> *<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * <h5 class='section'>Description:</h5><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * <p><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * When specified, the HTTP method can be overridden by passing in a <js>"method"</js> (case-insensitive) URL parameter on a regular<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * GET request.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * <br><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * For example:<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * <p class='bcode w800'><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * /myservlet/myendpoint?method=OPTIONS<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * </p><a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * <p><a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * Useful in cases where you want to simulate a non-GET request in a browser by simply adding a parameter.<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * <br>Also useful if you want to construct hyperlinks to non-GET REST endpoints such as links to <c>OPTIONS</c><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * pages.<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> *<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * <p><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * Note that per the {@doc ExtRFC2616.section9 HTTP specification}, special care should<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * be taken when allowing non-safe (<c>POST</c>, <c>PUT</c>, <c>DELETE</c>) methods to be invoked through GET requests.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> *<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> *<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * <h5 class='section'>Example:</h5><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * <p class='bcode w800'><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * <ja>@Rest</ja>(allowedMethodParams=<js>"HEAD,OPTIONS,PUT"</js>)<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * <jk>public class</jk> MyResource {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> *<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> *<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * <jc>// Using method on builder.</jc><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * builder.allowedMethodParams(<js>"HEAD,OPTIONS,PUT"</js>);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> *<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * <jc>// Same, but using property.</jc><a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * builder.set(<jsf>REST_allowedMethodParams</jsf>, <js>"HEAD,OPTIONS,PUT"</js>);<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * }<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> *<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * builder.allowedMethodParams(<js>"HEAD,OPTIONS,PUT"</js>);<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * }<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * </p><a name="line.373"></a> |
| <span class="sourceLineNo">374</span> *<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * <ul class='notes'><a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * <li><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * Format is a comma-delimited list of HTTP method names that can be passed in as a method parameter.<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * <li><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <js>'method'</js> parameter name is case-insensitive.<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * <li><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * Use <js>"*"</js> to represent all methods.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * <li><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * Use <js>"NONE"</js> (case insensitive) to suppress inheriting a value from a parent class.<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * </ul><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> */<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> public static final String REST_allowedMethodParams = PREFIX + ".allowedMethodParams.s";<a name="line.386"></a> |
| <span class="sourceLineNo">387</span><a name="line.387"></a> |
| <span class="sourceLineNo">388</span> /**<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * Configuration property: Allow header URL parameters.<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> *<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * <div class='warn'><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * <b>Deprecated</b> - Use {@link #REST_allowedHeaderParams}<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * </div><a name="line.393"></a> |
| <span class="sourceLineNo">394</span> */<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> @Deprecated<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> public static final String REST_allowHeaderParams = PREFIX + ".allowHeaderParams.b";<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> /**<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * Configuration property: REST call handler.<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> *<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * <div class='warn'><a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * <b>Deprecated</b> - Use {@link RestContext#REST_context} and override methods.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * </div><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> */<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> @Deprecated<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> public static final String REST_callHandler = PREFIX + ".callHandler.o";<a name="line.406"></a> |
| <span class="sourceLineNo">407</span><a name="line.407"></a> |
| <span class="sourceLineNo">408</span> /**<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * Configuration property: REST call logger.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> *<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * <h5 class='section'>Property:</h5><a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * <ul class='spaced-list'><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_callLogger REST_callLogger}<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * <li><b>Name:</b> <js>"RestContext.callLogger.o"</js><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * <li><b>Data type:</b><a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * <ul><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * <li>{@link org.apache.juneau.rest.RestCallLogger}<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * <li><c>Class&lt;{@link org.apache.juneau.rest.RestCallLogger}&gt;</c><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> * </ul><a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.BasicRestCallLogger}<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.421"></a> |
| <span class="sourceLineNo">422</span> * <li><b>Annotations:</b><a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * <ul><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#callLogger()}<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * </ul><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * <li><b>Methods:</b><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * <ul><a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#callLogger(Class)}<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#callLogger(RestCallLogger)}<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * </ul><a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * </ul><a name="line.431"></a> |
| <span class="sourceLineNo">432</span> *<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> * <h5 class='section'>Description:</h5><a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * <p><a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * Specifies the logger to use for logging of HTTP requests and responses.<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> *<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * <h5 class='section'>Example:</h5><a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * <p class='bcode w800'><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * <jc>// Our customized logger.</jc><a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * <jk>public class</jk> MyLogger <jk>extends</jk> BasicRestCallLogger {<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> *<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * <ja>@Override</ja><a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * <jk>public void</jk> log(RestCallLoggerConfig config, HttpServletRequest req, HttpServletResponse res) {<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * <jc>// Handle logging ourselves.</jc><a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * }<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * }<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> *<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * <jc>// Option #1 - Registered via annotation resolving to a config file setting with default value.</jc><a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * <ja>@Rest</ja>(callLogger=MyLogger.<jk>class</jk>)<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * <jk>public class</jk> MyResource {<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> *<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.452"></a> |
| <span class="sourceLineNo">453</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> *<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> * <jc>// Using method on builder.</jc><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> * builder.callLogger(MyLogger.<jk>class</jk>);<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> *<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * <jc>// Same, but using property.</jc><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * builder.set(<jsf>REST_callLogger</jsf>, MyLogger.<jk>class</jk>);<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> *<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * builder.callLogger(MyLogger.<jk>class</jk>);<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * }<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * }<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * </p><a name="line.468"></a> |
| <span class="sourceLineNo">469</span> *<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> * <ul class='notes'><a name="line.470"></a> |
| <span class="sourceLineNo">471</span> * <li><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> * The default call logger if not specified is {@link BasicRestCallLogger}.<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * <li><a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * The resource class itself will be used if it implements the {@link RestCallLogger} interface and not<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * explicitly overridden via this annotation.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * <li><a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * The {@link RestServlet} and {@link BasicRest} classes implement the {@link RestCallLogger} interface with the same<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * that gets used if not overridden by this annotation.<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * <br>Subclasses can also alter the behavior by overriding these methods.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * <li><a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * <ul><a name="line.482"></a> |
| <span class="sourceLineNo">483</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.483"></a> |
| <span class="sourceLineNo">484</span> * <li><code><jk>public</jk> T()</code><a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * </ul><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * <li><a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * Inner classes of the REST resource class are allowed.<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * </ul><a name="line.490"></a> |
| <span class="sourceLineNo">491</span> *<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * <ul class='seealso'><a name="line.492"></a> |
| <span class="sourceLineNo">493</span> * <li class='link'>{@doc RestLoggingAndDebugging}<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> * </ul><a name="line.494"></a> |
| <span class="sourceLineNo">495</span> */<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> public static final String REST_callLogger = PREFIX + ".callLogger.o";<a name="line.496"></a> |
| <span class="sourceLineNo">497</span><a name="line.497"></a> |
| <span class="sourceLineNo">498</span> /**<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * Configuration property: REST call logging rules.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> *<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * <h5 class='section'>Property:</h5><a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * <ul class='spaced-list'><a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_callLoggerConfig REST_callLoggerConfig}<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> * <li><b>Name:</b> <js>"RestContext.callLoggerConfig.o"</js><a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * <li><b>Data type:</b> {@link org.apache.juneau.rest.RestCallLoggerConfig}<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.RestCallLoggerConfig#DEFAULT_NOOP}<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * <li><b>Annotations:</b><a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * <ul><a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#logging()}<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * </ul><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * <li><b>Methods:</b><a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * <ul><a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#callLoggerConfig(RestCallLoggerConfig)}<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * </ul><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * </ul><a name="line.516"></a> |
| <span class="sourceLineNo">517</span> *<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * <h5 class='section'>Description:</h5><a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * <p><a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * Specifies rules on how to handle logging of HTTP requests/responses.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> *<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> * <h5 class='section'>Example:</h5><a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * <p class='bcode w800'><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * <ja>@Rest</ja>(<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * logging=<ja>@Logging</ja>(<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * level=<js>"INFO"</js>,<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * rules={<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * <ja>@LoggingRule</ja>(codes=<js>"400-499"</js>, level=<js>"WARNING"</js>, req=<js>"SHORT"</js>, res=<js>"MEDIUM"</js>),<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> * <ja>@LoggingRule</ja>(codes=<js>">=500"</js>, level=<js>"SEVERE"</js>, req=<js>"LONG"</js>, res=<js>"LONG"</js>)<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * }<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * }<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * )<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * <jk>public class</jk> MyResource {<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> *<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> *<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> * <jc>// Using method on builder.</jc><a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * builder.callLoggerConfig(<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * RestCallLoggerConfig<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * .<jsm>create</jsm>()<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> * .level(Level.<jsf>INFO</jsf>)<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * .rules(<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * RestCallLoggingRule<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> * .<jsm>create</jsm>()<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> * .codes(<js>"400-499"</js>)<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> * .level(<jsf>WARNING</jsf>)<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * .req(<jsf>SHORT</jsf>)<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> * .res(<jsf>MEDIUM</jsf>)<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> * .build(),<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> * RestCallLoggingRule<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * .<jsm>create</jsm>()<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> * .codes(<js>">=500"</js>)<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> * .level(<jsf>SEVERE</jsf>)<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * .req(<jsf>LONG</jsf>)<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * .res(<jsf>LONG</jsf>)<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * .build()<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> * )<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * .build()<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * );<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> *<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * <jc>// Same, but using property with JSON value.</jc><a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * builder.set(<jsf>REST_callLoggerConfig</jsf>, <js>"{level:'INFO',rules:[{codes:'400-499',level:'WARNING',...},...]}"</js>);<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> * }<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> * }<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * </p><a name="line.567"></a> |
| <span class="sourceLineNo">568</span> *<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> * <ul class='seealso'><a name="line.569"></a> |
| <span class="sourceLineNo">570</span> * <li class='link'>{@doc RestLoggingAndDebugging}<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * </ul><a name="line.571"></a> |
| <span class="sourceLineNo">572</span> */<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> public static final String REST_callLoggerConfig = PREFIX + ".callLoggerConfig.o";<a name="line.573"></a> |
| <span class="sourceLineNo">574</span><a name="line.574"></a> |
| <span class="sourceLineNo">575</span> /**<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> * Configuration property: Children.<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> *<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * <h5 class='section'>Property:</h5><a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * <ul class='spaced-list'><a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_children REST_children}<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> * <li><b>Name:</b> <js>"RestContext.children.lo"</js><a name="line.581"></a> |
| <span class="sourceLineNo">582</span> * <li><b>Data type:</b> <c>List&lt;Class|Object|{@link org.apache.juneau.rest.RestChild}&gt;</c><a name="line.582"></a> |
| <span class="sourceLineNo">583</span> * <li><b>Default:</b> empty list<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * <li><b>Annotations:</b><a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * <ul><a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#children()}<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * </ul><a name="line.588"></a> |
| <span class="sourceLineNo">589</span> * <li><b>Methods:</b><a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * <ul><a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#child(String,Object)}<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#children(Class...)}<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#children(Object...)}<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> * </ul><a name="line.594"></a> |
| <span class="sourceLineNo">595</span> * </ul><a name="line.595"></a> |
| <span class="sourceLineNo">596</span> *<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> * <h5 class='section'>Description:</h5><a name="line.597"></a> |
| <span class="sourceLineNo">598</span> * <p><a name="line.598"></a> |
| <span class="sourceLineNo">599</span> * Defines children of this resource.<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> *<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * <p><a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * A REST child resource is simply another servlet or object that is initialized as part of the ascendant resource and has a<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * servlet path directly under the ascendant resource object path.<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * <br>The main advantage to defining servlets as REST children is that you do not need to define them in the<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> * <c>web.xml</c> file of the web application.<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> * <br>This can cut down on the number of entries that show up in the <c>web.xml</c> file if you are defining<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> * large numbers of servlets.<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> *<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> * <p><a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * Child resources must specify a value for {@link Rest#path() @Rest(path)} that identifies the subpath of the child resource<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * relative to the ascendant path UNLESS you use the {@link RestContextBuilder#child(String, Object)} method to register it.<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> *<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> * <p><a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * Child resources can be nested arbitrarily deep using this technique (i.e. children can also have children).<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> *<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> * <dl><a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * <dt>Servlet initialization:</dt><a name="line.617"></a> |
| <span class="sourceLineNo">618</span> * <dd><a name="line.618"></a> |
| <span class="sourceLineNo">619</span> * <p><a name="line.619"></a> |
| <span class="sourceLineNo">620</span> * A child resource will be initialized immediately after the ascendant servlet/resource is initialized.<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> * <br>The child resource receives the same servlet config as the ascendant servlet/resource.<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> * <br>This allows configuration information such as servlet initialization parameters to filter to child<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> * resources.<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * </p><a name="line.624"></a> |
| <span class="sourceLineNo">625</span> * </dd><a name="line.625"></a> |
| <span class="sourceLineNo">626</span> * <dt>Runtime behavior:</dt><a name="line.626"></a> |
| <span class="sourceLineNo">627</span> * <dd><a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * <p><a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * As a rule, methods defined on the <c>HttpServletRequest</c> object will behave as if the child<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * servlet were deployed as a top-level resource under the child's servlet path.<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * <br>For example, the <c>getServletPath()</c> and <c>getPathInfo()</c> methods on the<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> * <c>HttpServletRequest</c> object will behave as if the child resource were deployed using the<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> * child's servlet path.<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * <br>Therefore, the runtime behavior should be equivalent to deploying the child servlet in the<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * <c>web.xml</c> file of the web application.<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * </p><a name="line.636"></a> |
| <span class="sourceLineNo">637</span> * </dd><a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * </dl><a name="line.638"></a> |
| <span class="sourceLineNo">639</span> *<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> * <h5 class='section'>Example:</h5><a name="line.640"></a> |
| <span class="sourceLineNo">641</span> * <p class='bcode w800'><a name="line.641"></a> |
| <span class="sourceLineNo">642</span> * <jc>// Our child resource.</jc><a name="line.642"></a> |
| <span class="sourceLineNo">643</span> * <ja>@Rest</ja>(path=<js>"/child"</js>)<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> * <jk>public class</jk> MyChildResource {...}<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> *<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * <ja>@Rest</ja>(children={MyChildResource.<jk>class</jk>})<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * <jk>public class</jk> MyResource {<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> *<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> *<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> * <jc>// Using method on builder.</jc><a name="line.653"></a> |
| <span class="sourceLineNo">654</span> * builder.children(MyChildResource.<jk>class</jk>);<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> *<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> * <jc>// Same, but using property.</jc><a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * builder.addTo(<jsf>REST_children</jsf>, MyChildResource.<jk>class</jk>));<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> *<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * <jc>// Use a pre-instantiated object instead.</jc><a name="line.659"></a> |
| <span class="sourceLineNo">660</span> * builder.child(<js>"/child"</js>, <jk>new</jk> MyChildResource());<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * }<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> *<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.663"></a> |
| <span class="sourceLineNo">664</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> * builder.children(MyChildResource.<jk>class</jk>);<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> * }<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * }<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * </p><a name="line.669"></a> |
| <span class="sourceLineNo">670</span> *<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * <ul class='notes'><a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * <li><a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * When defined as classes, instances are resolved using the registered {@link #REST_resourceResolver} which<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * by default is {@link BasicRestResourceResolver} which requires the class have one of the following<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * constructors:<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> * <ul><a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * <li><code><jk>public</jk> T(RestContextBuilder)</code><a name="line.677"></a> |
| <span class="sourceLineNo">678</span> * <li><code><jk>public</jk> T()</code><a name="line.678"></a> |
| <span class="sourceLineNo">679</span> * </ul><a name="line.679"></a> |
| <span class="sourceLineNo">680</span> * </ul><a name="line.680"></a> |
| <span class="sourceLineNo">681</span> *<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * <ul class='seealso'><a name="line.682"></a> |
| <span class="sourceLineNo">683</span> * <li class='link'>{@doc RestChildren}<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> * </ul><a name="line.684"></a> |
| <span class="sourceLineNo">685</span> */<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> public static final String REST_children = PREFIX + ".children.lo";<a name="line.686"></a> |
| <span class="sourceLineNo">687</span><a name="line.687"></a> |
| <span class="sourceLineNo">688</span> /**<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * Configuration property: Classpath resource finder.<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> *<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * <h5 class='section'>Property:</h5><a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * <ul class='spaced-list'><a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_classpathResourceFinder REST_classpathResourceFinder}<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> * <li><b>Name:</b> <js>"RestContext.classpathResourceFinder.o"</js><a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * <li><b>Data type:</b> {@link org.apache.juneau.cp.ResourceFinder}<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * <li><b>Default:</b> {@link org.apache.juneau.cp.BasicResourceFinder}<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * <li><b>Annotations:</b><a name="line.698"></a> |
| <span class="sourceLineNo">699</span> * <ul><a name="line.699"></a> |
| <span class="sourceLineNo">700</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#classpathResourceFinder()}<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> * </ul><a name="line.701"></a> |
| <span class="sourceLineNo">702</span> * <li><b>Methods:</b><a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * <ul><a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#classpathResourceFinder(Class)}<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#classpathResourceFinder(ResourceFinder)}<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> * </ul><a name="line.706"></a> |
| <span class="sourceLineNo">707</span> * </ul><a name="line.707"></a> |
| <span class="sourceLineNo">708</span> *<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> * <h5 class='section'>Description:</h5><a name="line.709"></a> |
| <span class="sourceLineNo">710</span> * <p><a name="line.710"></a> |
| <span class="sourceLineNo">711</span> * Used to retrieve localized files from the classpath.<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> *<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> * <p><a name="line.713"></a> |
| <span class="sourceLineNo">714</span> * Used by the following methods:<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> * <ul class='javatree'><a name="line.715"></a> |
| <span class="sourceLineNo">716</span> * <li class='jc'>{@link RestContext}<a name="line.716"></a> |
| <span class="sourceLineNo">717</span> * <ul><a name="line.717"></a> |
| <span class="sourceLineNo">718</span> * <li class='jm'>{@link #getClasspathResource(String,Locale) getClasspathResource(String,Locale)}<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * <li class='jm'>{@link #getClasspathResource(Class,MediaType,String,Locale) getClasspathResource(Class,MediaType,String,Locale)}<a name="line.719"></a> |
| <span class="sourceLineNo">720</span> * <li class='jm'>{@link #getClasspathResourceAsString(String,Locale) getClasspathResourceAsString(String,Locale)}<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * <li class='jm'>{@link #getStaticFile(String) resolveStaticFile(String)}<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * </ul><a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * <li class='jc'>{@link RestRequest}<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> * <ul><a name="line.724"></a> |
| <span class="sourceLineNo">725</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String) getClasspathHttpResource(String)}<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String,boolean) getClasspathHttpResource(String,boolean)}<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String,boolean,MediaType,boolean) getClasspathHttpResource(String,boolean,MediaType,boolean)}<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * </ul><a name="line.728"></a> |
| <span class="sourceLineNo">729</span> * </ul><a name="line.729"></a> |
| <span class="sourceLineNo">730</span> *<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * <p><a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * It also affects the behavior of the {@link #REST_staticFiles} property.<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> *<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> * <h5 class='section'>Example:</h5><a name="line.734"></a> |
| <span class="sourceLineNo">735</span> * <p class='bcode w800'><a name="line.735"></a> |
| <span class="sourceLineNo">736</span> * <jc>// Our customized classpath resource finder.</jc><a name="line.736"></a> |
| <span class="sourceLineNo">737</span> * <jk>public class</jk> MyClasspathResourceFinder <jk>extends</jk> ClasspathResourceFinderBasic {<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> * <ja>@Override</ja><a name="line.738"></a> |
| <span class="sourceLineNo">739</span> * <jk>public</jk> InputStream findResource(Class&lt;?&gt; baseClass, String name, Locale locale) <jk>throws</jk> IOException {<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> * <jc>// Do your own resolution.</jc><a name="line.740"></a> |
| <span class="sourceLineNo">741</span> * }<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> * }<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> *<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * <ja>@Rest</ja>(classpathResourceFinder=MyClasspathResourceFinder.<jk>class</jk>)<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> * <jk>public class</jk> MyResource {<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> *<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.748"></a> |
| <span class="sourceLineNo">749</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> *<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> * <jc>// Using method on builder.</jc><a name="line.751"></a> |
| <span class="sourceLineNo">752</span> * builder.classpathResourceFinder(MyClasspathResourceFinder.<jk>class</jk>);<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> *<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> * <jc>// Same, but using property.</jc><a name="line.754"></a> |
| <span class="sourceLineNo">755</span> * builder.set(<jsf>REST_classpathResourceFinder</jsf>, MyClasspathResourceFinder.<jk>class</jk>));<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> *<a name="line.756"></a> |
| <span class="sourceLineNo">757</span> * <jc>// Use a pre-instantiated object instead.</jc><a name="line.757"></a> |
| <span class="sourceLineNo">758</span> * builder.classpathResourceFinder(<jk>new</jk> MyClasspathResourceFinder());<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> * }<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> *<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.761"></a> |
| <span class="sourceLineNo">762</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * builder.classpathResourceFinder(MyClasspathResourceFinder.<jk>class</jk>);<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> * }<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> * }<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> * </p><a name="line.767"></a> |
| <span class="sourceLineNo">768</span> *<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> * <ul class='notes'><a name="line.769"></a> |
| <span class="sourceLineNo">770</span> * <li><a name="line.770"></a> |
| <span class="sourceLineNo">771</span> * The default value is {@link BasicResourceFinder} which provides basic support for finding localized<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * resources on the classpath and JVM working directory.<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> * <br>The {@link RecursiveResourceFinder} is another option that also recursively searches for resources<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * up the class-hierarchy.<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * <br>Each of these classes can be extended to provide customized handling of resource retrieval.<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * <li><a name="line.776"></a> |
| <span class="sourceLineNo">777</span> * The resource class itself will be used if it implements the {@link ResourceFinder} interface and not<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> * explicitly overridden via this annotation.<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> * <li><a name="line.779"></a> |
| <span class="sourceLineNo">780</span> * The {@link RestServlet} and {@link BasicRest} classes implement the {@link ResourceFinder} interface with the same<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> * functionality as {@link BasicResourceFinder} that gets used if not overridden by this annotation.<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> * <br>Subclasses can also alter the behavior by overriding these methods.<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> * <li><a name="line.783"></a> |
| <span class="sourceLineNo">784</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> * <ul><a name="line.785"></a> |
| <span class="sourceLineNo">786</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.786"></a> |
| <span class="sourceLineNo">787</span> * <li><code><jk>public</jk> T()</code><a name="line.787"></a> |
| <span class="sourceLineNo">788</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.788"></a> |
| <span class="sourceLineNo">789</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.789"></a> |
| <span class="sourceLineNo">790</span> * </ul><a name="line.790"></a> |
| <span class="sourceLineNo">791</span> * <li><a name="line.791"></a> |
| <span class="sourceLineNo">792</span> * Inner classes of the REST resource class are allowed.<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> * </ul><a name="line.793"></a> |
| <span class="sourceLineNo">794</span> */<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> public static final String REST_classpathResourceFinder = PREFIX + ".classpathResourceFinder.o";<a name="line.795"></a> |
| <span class="sourceLineNo">796</span><a name="line.796"></a> |
| <span class="sourceLineNo">797</span> /**<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> * Configuration property: Client version header.<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> *<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> * <h5 class='section'>Property:</h5><a name="line.800"></a> |
| <span class="sourceLineNo">801</span> * <ul class='spaced-list'><a name="line.801"></a> |
| <span class="sourceLineNo">802</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_clientVersionHeader REST_clientVersionHeader}<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> * <li><b>Name:</b> <js>"RestContext.clientVersionHeader.s"</js><a name="line.803"></a> |
| <span class="sourceLineNo">804</span> * <li><b>Data type:</b> <c>String</c><a name="line.804"></a> |
| <span class="sourceLineNo">805</span> * <li><b>System property:</b> <c>RestContext.clientVersionHeader</c><a name="line.805"></a> |
| <span class="sourceLineNo">806</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_CLIENTVERSIONHEADER</c><a name="line.806"></a> |
| <span class="sourceLineNo">807</span> * <li><b>Default:</b> <js>"X-Client-Version"</js><a name="line.807"></a> |
| <span class="sourceLineNo">808</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.808"></a> |
| <span class="sourceLineNo">809</span> * <li><b>Annotations:</b><a name="line.809"></a> |
| <span class="sourceLineNo">810</span> * <ul><a name="line.810"></a> |
| <span class="sourceLineNo">811</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#clientVersionHeader()}<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> * </ul><a name="line.812"></a> |
| <span class="sourceLineNo">813</span> * <li><b>Methods:</b><a name="line.813"></a> |
| <span class="sourceLineNo">814</span> * <ul><a name="line.814"></a> |
| <span class="sourceLineNo">815</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#clientVersionHeader(String)}<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> * </ul><a name="line.816"></a> |
| <span class="sourceLineNo">817</span> * </ul><a name="line.817"></a> |
| <span class="sourceLineNo">818</span> *<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> * <h5 class='section'>Description:</h5><a name="line.819"></a> |
| <span class="sourceLineNo">820</span> * <p><a name="line.820"></a> |
| <span class="sourceLineNo">821</span> * Specifies the name of the header used to denote the client version on HTTP requests.<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> *<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> * <p><a name="line.823"></a> |
| <span class="sourceLineNo">824</span> * The client version is used to support backwards compatibility for breaking REST interface changes.<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * <br>Used in conjunction with {@link RestMethod#clientVersion() @RestMethod(clientVersion)} annotation.<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> *<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * <h5 class='section'>Example:</h5><a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * <p class='bcode w800'><a name="line.828"></a> |
| <span class="sourceLineNo">829</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.829"></a> |
| <span class="sourceLineNo">830</span> * <ja>@Rest</ja>(clientVersionHeader=<js>"$C{REST/clientVersionHeader,Client-Version}"</js>)<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * <jk>public class</jk> MyResource {<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> *<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.833"></a> |
| <span class="sourceLineNo">834</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.834"></a> |
| <span class="sourceLineNo">835</span> *<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> * <jc>// Using method on builder.</jc><a name="line.836"></a> |
| <span class="sourceLineNo">837</span> * builder.clientVersionHeader(<js>"Client-Version"</js>);<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> *<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> * <jc>// Same, but using property.</jc><a name="line.839"></a> |
| <span class="sourceLineNo">840</span> * builder.set(<jsf>REST_clientVersionHeader</jsf>, <js>"Client-Version"</js>);<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> * }<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> *<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.843"></a> |
| <span class="sourceLineNo">844</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> * builder.clientVersionHeader(<js>"Client-Version"</js>);<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> * }<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> * }<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> * </p><a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * <p class='bcode w800'><a name="line.850"></a> |
| <span class="sourceLineNo">851</span> * <jc>// Call this method if Client-Version is at least 2.0.<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> * // Note that this also matches 2.0.1.</jc><a name="line.852"></a> |
| <span class="sourceLineNo">853</span> * <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> * <jk>public</jk> Object method1() {<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> * ...<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> * }<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> *<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> * <jc>// Call this method if Client-Version is at least 1.1, but less than 2.0.</jc><a name="line.858"></a> |
| <span class="sourceLineNo">859</span> * <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"[1.1,2.0)"</js>)<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> * <jk>public</jk> Object method2() {<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> * ...<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> * }<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> *<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> * <jc>// Call this method if Client-Version is less than 1.1.</jc><a name="line.864"></a> |
| <span class="sourceLineNo">865</span> * <ja>@RestMethod</ja>(name=<jsf>GET</jsf>, path=<js>"/foobar"</js>, clientVersion=<js>"[0,1.1)"</js>)<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> * <jk>public</jk> Object method3() {<a name="line.866"></a> |
| <span class="sourceLineNo">867</span> * ...<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> * }<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> * </p><a name="line.869"></a> |
| <span class="sourceLineNo">870</span> */<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> public static final String REST_clientVersionHeader = PREFIX + ".clientVersionHeader.s";<a name="line.871"></a> |
| <span class="sourceLineNo">872</span><a name="line.872"></a> |
| <span class="sourceLineNo">873</span> /**<a name="line.873"></a> |
| <span class="sourceLineNo">874</span> * Configuration property: Class-level response converters.<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> *<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> * <h5 class='section'>Property:</h5><a name="line.876"></a> |
| <span class="sourceLineNo">877</span> * <ul class='spaced-list'><a name="line.877"></a> |
| <span class="sourceLineNo">878</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_converters REST_converters}<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> * <li><b>Name:</b> <js>"RestContext.converters.lo"</js><a name="line.879"></a> |
| <span class="sourceLineNo">880</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.rest.RestConverter}|Class&lt;{@link org.apache.juneau.rest.RestConverter}&gt;&gt;</c><a name="line.880"></a> |
| <span class="sourceLineNo">881</span> * <li><b>Default:</b> empty list<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.882"></a> |
| <span class="sourceLineNo">883</span> * <li><b>Annotations:</b><a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * <ul><a name="line.884"></a> |
| <span class="sourceLineNo">885</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#converters()}<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#converters()}<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> * </ul><a name="line.887"></a> |
| <span class="sourceLineNo">888</span> * <li><b>Methods:</b><a name="line.888"></a> |
| <span class="sourceLineNo">889</span> * <ul><a name="line.889"></a> |
| <span class="sourceLineNo">890</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#converters(Class...)}<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#converters(RestConverter...)}<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> * </ul><a name="line.892"></a> |
| <span class="sourceLineNo">893</span> * </ul><a name="line.893"></a> |
| <span class="sourceLineNo">894</span> *<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> * <h5 class='section'>Description:</h5><a name="line.895"></a> |
| <span class="sourceLineNo">896</span> * <p><a name="line.896"></a> |
| <span class="sourceLineNo">897</span> * Associates one or more {@link RestConverter converters} with a resource class.<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> * <br>These converters get called immediately after execution of the REST method in the same order specified in the<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> * annotation.<a name="line.899"></a> |
| <span class="sourceLineNo">900</span> * <br>The object passed into this converter is the object returned from the Java method or passed into<a name="line.900"></a> |
| <span class="sourceLineNo">901</span> * the {@link RestResponse#setOutput(Object)} method.<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> *<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> * <p><a name="line.903"></a> |
| <span class="sourceLineNo">904</span> * Can be used for performing post-processing on the response object before serialization.<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> *<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> * <p><a name="line.906"></a> |
| <span class="sourceLineNo">907</span> * When multiple converters are specified, they're executed in the order they're specified in the annotation<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> * (e.g. first the results will be traversed, then the resulting node will be searched/sorted).<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> *<a name="line.909"></a> |
| <span class="sourceLineNo">910</span> * <h5 class='section'>Example:</h5><a name="line.910"></a> |
| <span class="sourceLineNo">911</span> * <p class='bcode w800'><a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * <jc>// Our converter.</jc><a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * <jk>public class</jk> MyConverter <jk>implements</jk> RestConverter {<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> * <ja>@Override</ja><a name="line.914"></a> |
| <span class="sourceLineNo">915</span> * <jk>public</jk> Object convert(RestRequest req, Object o) {<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> * <jc>// Do something with object and return another object.</jc><a name="line.916"></a> |
| <span class="sourceLineNo">917</span> * <jc>// Or just return the same object for a no-op.</jc><a name="line.917"></a> |
| <span class="sourceLineNo">918</span> * }<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> * }<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> *<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> * <jc>// Option #1 - Registered via annotation resolving to a config file setting with default value.</jc><a name="line.921"></a> |
| <span class="sourceLineNo">922</span> * <ja>@Rest</ja>(converters={MyConverter.<jk>class</jk>})<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> * <jk>public class</jk> MyResource {<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> *<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.925"></a> |
| <span class="sourceLineNo">926</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> *<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> * <jc>// Using method on builder.</jc><a name="line.928"></a> |
| <span class="sourceLineNo">929</span> * builder.converters(MyConverter.<jk>class</jk>);<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> *<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> * <jc>// Same, but using property.</jc><a name="line.931"></a> |
| <span class="sourceLineNo">932</span> * builder.set(<jsf>REST_converters</jsf>, MyConverter.<jk>class</jk>);<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> *<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> * <jc>// Pass in an instance instead.</jc><a name="line.934"></a> |
| <span class="sourceLineNo">935</span> * builder.converters(<jk>new</jk> MyConverter());<a name="line.935"></a> |
| <span class="sourceLineNo">936</span> * }<a name="line.936"></a> |
| <span class="sourceLineNo">937</span> *<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.938"></a> |
| <span class="sourceLineNo">939</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> * builder.converters(MyConverter.<jk>class</jk>);<a name="line.941"></a> |
| <span class="sourceLineNo">942</span> * }<a name="line.942"></a> |
| <span class="sourceLineNo">943</span> * }<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> * </p><a name="line.944"></a> |
| <span class="sourceLineNo">945</span> *<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> * <ul class='seealso'><a name="line.946"></a> |
| <span class="sourceLineNo">947</span> * <li class='jc'>{@link Traversable} - Allows URL additional path info to address individual elements in a POJO tree.<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> * <li class='jc'>{@link Queryable} - Allows query/view/sort functions to be performed on POJOs.<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> * <li class='jc'>{@link Introspectable} - Allows Java public methods to be invoked on the returned POJOs.<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> * <li class='link'>{@doc RestConverters}<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> * </ul><a name="line.951"></a> |
| <span class="sourceLineNo">952</span> *<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> * <ul class='notes'><a name="line.953"></a> |
| <span class="sourceLineNo">954</span> * <li><a name="line.954"></a> |
| <span class="sourceLineNo">955</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> * <ul><a name="line.956"></a> |
| <span class="sourceLineNo">957</span> * <li><code><jk>public</jk> T(BeanContext)</code><a name="line.957"></a> |
| <span class="sourceLineNo">958</span> * <li><code><jk>public</jk> T()</code><a name="line.958"></a> |
| <span class="sourceLineNo">959</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.959"></a> |
| <span class="sourceLineNo">960</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.960"></a> |
| <span class="sourceLineNo">961</span> * </ul><a name="line.961"></a> |
| <span class="sourceLineNo">962</span> * <li><a name="line.962"></a> |
| <span class="sourceLineNo">963</span> * Inner classes of the REST resource class are allowed.<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> * </ul><a name="line.964"></a> |
| <span class="sourceLineNo">965</span> */<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> public static final String REST_converters = PREFIX + ".converters.lo";<a name="line.966"></a> |
| <span class="sourceLineNo">967</span><a name="line.967"></a> |
| <span class="sourceLineNo">968</span> /**<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> * Configuration property: Debug mode.<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> *<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> * <h5 class='section'>Property:</h5><a name="line.971"></a> |
| <span class="sourceLineNo">972</span> * <ul class='spaced-list'><a name="line.972"></a> |
| <span class="sourceLineNo">973</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_debug REST_debug}<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> * <li><b>Name:</b> <js>"RestContext.debug.s"</js><a name="line.974"></a> |
| <span class="sourceLineNo">975</span> * <li><b>Data type:</b> {@link org.apache.juneau.rest.Enablement}<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> * <li><b>System property:</b> <c>RestContext.debug</c><a name="line.976"></a> |
| <span class="sourceLineNo">977</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_DEBUG</c><a name="line.977"></a> |
| <span class="sourceLineNo">978</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.Enablement#FALSE}<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.979"></a> |
| <span class="sourceLineNo">980</span> * <li><b>Annotations:</b><a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * <ul><a name="line.981"></a> |
| <span class="sourceLineNo">982</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#debug()}<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> * </ul><a name="line.983"></a> |
| <span class="sourceLineNo">984</span> * <li><b>Methods:</b><a name="line.984"></a> |
| <span class="sourceLineNo">985</span> * <ul><a name="line.985"></a> |
| <span class="sourceLineNo">986</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#debug()}<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> * </ul><a name="line.987"></a> |
| <span class="sourceLineNo">988</span> * </ul><a name="line.988"></a> |
| <span class="sourceLineNo">989</span> *<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> * <h5 class='section'>Description:</h5><a name="line.990"></a> |
| <span class="sourceLineNo">991</span> * <p><a name="line.991"></a> |
| <span class="sourceLineNo">992</span> * Enables the following:<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> * <ul class='spaced-list'><a name="line.993"></a> |
| <span class="sourceLineNo">994</span> * <li><a name="line.994"></a> |
| <span class="sourceLineNo">995</span> * HTTP request/response bodies are cached in memory for logging purposes.<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> * <li><a name="line.996"></a> |
| <span class="sourceLineNo">997</span> * Request/response messages are automatically logged always or per request.<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> * </ul><a name="line.998"></a> |
| <span class="sourceLineNo">999</span> */<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> public static final String REST_debug = PREFIX + ".debug.s";<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span><a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> /**<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> * Configuration property: Debug mode on specified classes/methods.<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> *<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> * <h5 class='section'>Property:</h5><a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> * <ul class='spaced-list'><a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_debugOn REST_debugOn}<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> * <li><b>Name:</b> <js>"RestContext.debugOn.s"</js><a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> * <li><b>Data type:</b> <c>String</c> (comma-delimited)<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> * <li><b>System property:</b> <c>RestContext.debugOn</c><a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_DEBUGON</c><a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> * <li><b>Default:</b> Empty string<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> * <li><b>Annotations:</b><a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> * <ul><a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#debugOn()}<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> * </ul><a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> * <li><b>Methods:</b><a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> * <ul><a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#debugOn(String)}<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span> * </ul><a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> * </ul><a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span> *<a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> * <h5 class='section'>Description:</h5><a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> * <p><a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> * Enables the following:<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * <ul class='spaced-list'><a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * <li><a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> * HTTP request/response bodies are cached in memory for logging purposes.<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> * <li><a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> * Request/response messages are automatically logged always or per request.<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> * </ul><a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> */<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> public static final String REST_debugOn = PREFIX + ".debugOn.s";<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span><a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> /**<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> * Configuration property: Default character encoding.<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> *<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> * <h5 class='section'>Property:</h5><a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> * <ul class='spaced-list'><a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_defaultCharset REST_defaultCharset}<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> * <li><b>Name:</b> <js>"RestContext.defaultCharset.s"</js><a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span> * <li><b>Data type:</b> <c>String</c><a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> * <li><b>System property:</b> <c>RestContext.defaultCharset</c><a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_DEFAULTCHARSET</c><a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> * <li><b>Default:</b> <js>"utf-8"</js><a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> * <li><b>Annotations:</b><a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> * <ul><a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#defaultCharset()}<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#defaultCharset()}<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> * </ul><a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> * <li><b>Methods:</b><a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> * <ul><a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#defaultCharset(String)}<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#defaultCharset(Charset)}<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> * </ul><a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> * </ul><a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span> *<a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> * <h5 class='section'>Description:</h5><a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> * <p><a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> * The default character encoding for the request and response if not specified on the request.<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> *<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> * <h5 class='section'>Example:</h5><a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> * <p class='bcode w800'><a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> * <ja>@Rest</ja>(defaultCharset=<js>"$C{REST/defaultCharset,US-ASCII}"</js>)<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> * <jk>public class</jk> MyResource {<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> *<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span> *<a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> * <jc>// Using method on builder.</jc><a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span> * builder.defaultCharset(<js>"US-ASCII"</js>);<a name="line.1074"></a> |
| <span class="sourceLineNo">1075</span> *<a name="line.1075"></a> |
| <span class="sourceLineNo">1076</span> * <jc>// Same, but using property.</jc><a name="line.1076"></a> |
| <span class="sourceLineNo">1077</span> * builder.set(<jsf>REST_defaultCharset</jsf>, <js>"US-ASCII"</js>);<a name="line.1077"></a> |
| <span class="sourceLineNo">1078</span> * }<a name="line.1078"></a> |
| <span class="sourceLineNo">1079</span> *<a name="line.1079"></a> |
| <span class="sourceLineNo">1080</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1080"></a> |
| <span class="sourceLineNo">1081</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1081"></a> |
| <span class="sourceLineNo">1082</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1082"></a> |
| <span class="sourceLineNo">1083</span> * builder.defaultCharset(<js>"US-ASCII"</js>);<a name="line.1083"></a> |
| <span class="sourceLineNo">1084</span> * }<a name="line.1084"></a> |
| <span class="sourceLineNo">1085</span> *<a name="line.1085"></a> |
| <span class="sourceLineNo">1086</span> * <jc>// Override at the method level.</jc><a name="line.1086"></a> |
| <span class="sourceLineNo">1087</span> * <ja>@RestMethod</ja>(defaultCharset=<js>"UTF-16"</js>)<a name="line.1087"></a> |
| <span class="sourceLineNo">1088</span> * public Object myMethod() {...}<a name="line.1088"></a> |
| <span class="sourceLineNo">1089</span> * }<a name="line.1089"></a> |
| <span class="sourceLineNo">1090</span> * </p><a name="line.1090"></a> |
| <span class="sourceLineNo">1091</span> */<a name="line.1091"></a> |
| <span class="sourceLineNo">1092</span> public static final String REST_defaultCharset = PREFIX + ".defaultCharset.s";<a name="line.1092"></a> |
| <span class="sourceLineNo">1093</span><a name="line.1093"></a> |
| <span class="sourceLineNo">1094</span> /**<a name="line.1094"></a> |
| <span class="sourceLineNo">1095</span> * Configuration property: Default request attributes.<a name="line.1095"></a> |
| <span class="sourceLineNo">1096</span> *<a name="line.1096"></a> |
| <span class="sourceLineNo">1097</span> * <div class='warn'><a name="line.1097"></a> |
| <span class="sourceLineNo">1098</span> * <b>Deprecated</b> - Use {@link #REST_reqAttrs}<a name="line.1098"></a> |
| <span class="sourceLineNo">1099</span> * </div><a name="line.1099"></a> |
| <span class="sourceLineNo">1100</span> */<a name="line.1100"></a> |
| <span class="sourceLineNo">1101</span> @Deprecated<a name="line.1101"></a> |
| <span class="sourceLineNo">1102</span> public static final String REST_attrs = PREFIX + ".reqAttrs.smo";<a name="line.1102"></a> |
| <span class="sourceLineNo">1103</span><a name="line.1103"></a> |
| <span class="sourceLineNo">1104</span> /**<a name="line.1104"></a> |
| <span class="sourceLineNo">1105</span> * Configuration property: Default request headers.<a name="line.1105"></a> |
| <span class="sourceLineNo">1106</span> *<a name="line.1106"></a> |
| <span class="sourceLineNo">1107</span> * <div class='warn'><a name="line.1107"></a> |
| <span class="sourceLineNo">1108</span> * <b>Deprecated</b> - Use {@link #REST_reqHeaders}<a name="line.1108"></a> |
| <span class="sourceLineNo">1109</span> * </div><a name="line.1109"></a> |
| <span class="sourceLineNo">1110</span> */<a name="line.1110"></a> |
| <span class="sourceLineNo">1111</span> @Deprecated<a name="line.1111"></a> |
| <span class="sourceLineNo">1112</span> public static final String REST_defaultRequestHeaders = PREFIX + ".reqHeaders.smo";<a name="line.1112"></a> |
| <span class="sourceLineNo">1113</span><a name="line.1113"></a> |
| <span class="sourceLineNo">1114</span> /**<a name="line.1114"></a> |
| <span class="sourceLineNo">1115</span> * Configuration property: Default response headers.<a name="line.1115"></a> |
| <span class="sourceLineNo">1116</span> *<a name="line.1116"></a> |
| <span class="sourceLineNo">1117</span> * <div class='warn'><a name="line.1117"></a> |
| <span class="sourceLineNo">1118</span> * <b>Deprecated</b> - Use {@link #REST_resHeaders}<a name="line.1118"></a> |
| <span class="sourceLineNo">1119</span> * </div><a name="line.1119"></a> |
| <span class="sourceLineNo">1120</span> */<a name="line.1120"></a> |
| <span class="sourceLineNo">1121</span> @Deprecated<a name="line.1121"></a> |
| <span class="sourceLineNo">1122</span> public static final String REST_defaultResponseHeaders = PREFIX + ".resHeaders.omo";<a name="line.1122"></a> |
| <span class="sourceLineNo">1123</span><a name="line.1123"></a> |
| <span class="sourceLineNo">1124</span> /**<a name="line.1124"></a> |
| <span class="sourceLineNo">1125</span> * Configuration property: Compression encoders.<a name="line.1125"></a> |
| <span class="sourceLineNo">1126</span> *<a name="line.1126"></a> |
| <span class="sourceLineNo">1127</span> * <h5 class='section'>Property:</h5><a name="line.1127"></a> |
| <span class="sourceLineNo">1128</span> * <ul class='spaced-list'><a name="line.1128"></a> |
| <span class="sourceLineNo">1129</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_encoders REST_encoders}<a name="line.1129"></a> |
| <span class="sourceLineNo">1130</span> * <li><b>Name:</b> <js>"RestContext.encoders.o"</js><a name="line.1130"></a> |
| <span class="sourceLineNo">1131</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.encoders.Encoder}|Class&lt;{@link org.apache.juneau.encoders.Encoder}&gt;&gt;</c><a name="line.1131"></a> |
| <span class="sourceLineNo">1132</span> * <li><b>Default:</b> empty list<a name="line.1132"></a> |
| <span class="sourceLineNo">1133</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1133"></a> |
| <span class="sourceLineNo">1134</span> * <li><b>Annotations:</b><a name="line.1134"></a> |
| <span class="sourceLineNo">1135</span> * <ul><a name="line.1135"></a> |
| <span class="sourceLineNo">1136</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#encoders()}<a name="line.1136"></a> |
| <span class="sourceLineNo">1137</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#encoders()}<a name="line.1137"></a> |
| <span class="sourceLineNo">1138</span> * </ul><a name="line.1138"></a> |
| <span class="sourceLineNo">1139</span> * <li><b>Methods:</b><a name="line.1139"></a> |
| <span class="sourceLineNo">1140</span> * <ul><a name="line.1140"></a> |
| <span class="sourceLineNo">1141</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#encoders(Class...)}<a name="line.1141"></a> |
| <span class="sourceLineNo">1142</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#encoders(Encoder...)}<a name="line.1142"></a> |
| <span class="sourceLineNo">1143</span> * </ul><a name="line.1143"></a> |
| <span class="sourceLineNo">1144</span> * </ul><a name="line.1144"></a> |
| <span class="sourceLineNo">1145</span> *<a name="line.1145"></a> |
| <span class="sourceLineNo">1146</span> * <h5 class='section'>Description:</h5><a name="line.1146"></a> |
| <span class="sourceLineNo">1147</span> * <p><a name="line.1147"></a> |
| <span class="sourceLineNo">1148</span> * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.<a name="line.1148"></a> |
| <span class="sourceLineNo">1149</span> *<a name="line.1149"></a> |
| <span class="sourceLineNo">1150</span> * <h5 class='section'>Example:</h5><a name="line.1150"></a> |
| <span class="sourceLineNo">1151</span> * <p class='bcode w800'><a name="line.1151"></a> |
| <span class="sourceLineNo">1152</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.1152"></a> |
| <span class="sourceLineNo">1153</span> * <ja>@Rest</ja>(encoders={GzipEncoder.<jk>class</jk>})<a name="line.1153"></a> |
| <span class="sourceLineNo">1154</span> * <jk>public class</jk> MyResource {<a name="line.1154"></a> |
| <span class="sourceLineNo">1155</span> *<a name="line.1155"></a> |
| <span class="sourceLineNo">1156</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.1156"></a> |
| <span class="sourceLineNo">1157</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1157"></a> |
| <span class="sourceLineNo">1158</span> *<a name="line.1158"></a> |
| <span class="sourceLineNo">1159</span> * <jc>// Using method on builder.</jc><a name="line.1159"></a> |
| <span class="sourceLineNo">1160</span> * builder.encoders(GzipEncoder.<jk>class</jk>);<a name="line.1160"></a> |
| <span class="sourceLineNo">1161</span> *<a name="line.1161"></a> |
| <span class="sourceLineNo">1162</span> * <jc>// Same, but using property.</jc><a name="line.1162"></a> |
| <span class="sourceLineNo">1163</span> * builder.addTo(<jsf>REST_encoders</jsf>, GzipEncoder.<jk>class</jk>);<a name="line.1163"></a> |
| <span class="sourceLineNo">1164</span> * }<a name="line.1164"></a> |
| <span class="sourceLineNo">1165</span> *<a name="line.1165"></a> |
| <span class="sourceLineNo">1166</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.1166"></a> |
| <span class="sourceLineNo">1167</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1167"></a> |
| <span class="sourceLineNo">1168</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1168"></a> |
| <span class="sourceLineNo">1169</span> * builder.encoders(GzipEncoder.<jk>class</jk>);<a name="line.1169"></a> |
| <span class="sourceLineNo">1170</span> * }<a name="line.1170"></a> |
| <span class="sourceLineNo">1171</span> *<a name="line.1171"></a> |
| <span class="sourceLineNo">1172</span> * <jc>// Override at the method level.</jc><a name="line.1172"></a> |
| <span class="sourceLineNo">1173</span> * <ja>@RestMethod</ja>(encoders={MySpecialEncoder.<jk>class</jk>}, inherit={<js>"ENCODERS"</js>})<a name="line.1173"></a> |
| <span class="sourceLineNo">1174</span> * public Object myMethod() {...}<a name="line.1174"></a> |
| <span class="sourceLineNo">1175</span> * }<a name="line.1175"></a> |
| <span class="sourceLineNo">1176</span> * </p><a name="line.1176"></a> |
| <span class="sourceLineNo">1177</span> *<a name="line.1177"></a> |
| <span class="sourceLineNo">1178</span> * <ul class='notes'><a name="line.1178"></a> |
| <span class="sourceLineNo">1179</span> * <li><a name="line.1179"></a> |
| <span class="sourceLineNo">1180</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.1180"></a> |
| <span class="sourceLineNo">1181</span> * <ul><a name="line.1181"></a> |
| <span class="sourceLineNo">1182</span> * <li><code><jk>public</jk> T(BeanContext)</code><a name="line.1182"></a> |
| <span class="sourceLineNo">1183</span> * <li><code><jk>public</jk> T()</code><a name="line.1183"></a> |
| <span class="sourceLineNo">1184</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.1184"></a> |
| <span class="sourceLineNo">1185</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.1185"></a> |
| <span class="sourceLineNo">1186</span> * </ul><a name="line.1186"></a> |
| <span class="sourceLineNo">1187</span> * <li><a name="line.1187"></a> |
| <span class="sourceLineNo">1188</span> * Inner classes of the REST resource class are allowed.<a name="line.1188"></a> |
| <span class="sourceLineNo">1189</span> * </ul><a name="line.1189"></a> |
| <span class="sourceLineNo">1190</span> *<a name="line.1190"></a> |
| <span class="sourceLineNo">1191</span> * <ul class='seealso'><a name="line.1191"></a> |
| <span class="sourceLineNo">1192</span> * <li class='link'>{@doc RestEncoders}<a name="line.1192"></a> |
| <span class="sourceLineNo">1193</span> * </ul><a name="line.1193"></a> |
| <span class="sourceLineNo">1194</span> */<a name="line.1194"></a> |
| <span class="sourceLineNo">1195</span> public static final String REST_encoders = PREFIX + ".encoders.lo";<a name="line.1195"></a> |
| <span class="sourceLineNo">1196</span><a name="line.1196"></a> |
| <span class="sourceLineNo">1197</span> /**<a name="line.1197"></a> |
| <span class="sourceLineNo">1198</span> * Configuration property: Class-level guards.<a name="line.1198"></a> |
| <span class="sourceLineNo">1199</span> *<a name="line.1199"></a> |
| <span class="sourceLineNo">1200</span> * <h5 class='section'>Property:</h5><a name="line.1200"></a> |
| <span class="sourceLineNo">1201</span> * <ul class='spaced-list'><a name="line.1201"></a> |
| <span class="sourceLineNo">1202</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_guards REST_guards}<a name="line.1202"></a> |
| <span class="sourceLineNo">1203</span> * <li><b>Name:</b> <js>"RestContext.guards.lo"</js><a name="line.1203"></a> |
| <span class="sourceLineNo">1204</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.rest.RestGuard}|Class&lt;{@link org.apache.juneau.rest.RestGuard}&gt;&gt;</c><a name="line.1204"></a> |
| <span class="sourceLineNo">1205</span> * <li><b>Default:</b> empty list<a name="line.1205"></a> |
| <span class="sourceLineNo">1206</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1206"></a> |
| <span class="sourceLineNo">1207</span> * <li><b>Annotations:</b><a name="line.1207"></a> |
| <span class="sourceLineNo">1208</span> * <ul><a name="line.1208"></a> |
| <span class="sourceLineNo">1209</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#guards()}<a name="line.1209"></a> |
| <span class="sourceLineNo">1210</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#guards()}<a name="line.1210"></a> |
| <span class="sourceLineNo">1211</span> * </ul><a name="line.1211"></a> |
| <span class="sourceLineNo">1212</span> * <li><b>Methods:</b><a name="line.1212"></a> |
| <span class="sourceLineNo">1213</span> * <ul><a name="line.1213"></a> |
| <span class="sourceLineNo">1214</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#guards(Class...)}<a name="line.1214"></a> |
| <span class="sourceLineNo">1215</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#guards(RestGuard...)}<a name="line.1215"></a> |
| <span class="sourceLineNo">1216</span> * </ul><a name="line.1216"></a> |
| <span class="sourceLineNo">1217</span> * </ul><a name="line.1217"></a> |
| <span class="sourceLineNo">1218</span> *<a name="line.1218"></a> |
| <span class="sourceLineNo">1219</span> * <h5 class='section'>Description:</h5><a name="line.1219"></a> |
| <span class="sourceLineNo">1220</span> * <p><a name="line.1220"></a> |
| <span class="sourceLineNo">1221</span> * Associates one or more {@link RestGuard RestGuards} with all REST methods defined in this class.<a name="line.1221"></a> |
| <span class="sourceLineNo">1222</span> * <br>These guards get called immediately before execution of any REST method in this class.<a name="line.1222"></a> |
| <span class="sourceLineNo">1223</span> *<a name="line.1223"></a> |
| <span class="sourceLineNo">1224</span> * <p><a name="line.1224"></a> |
| <span class="sourceLineNo">1225</span> * If multiple guards are specified, <b>ALL</b> guards must pass.<a name="line.1225"></a> |
| <span class="sourceLineNo">1226</span> * <br>Note that this is different than matchers where only ONE matcher needs to pass.<a name="line.1226"></a> |
| <span class="sourceLineNo">1227</span> *<a name="line.1227"></a> |
| <span class="sourceLineNo">1228</span> * <h5 class='section'>Example:</h5><a name="line.1228"></a> |
| <span class="sourceLineNo">1229</span> * <p class='bcode w800'><a name="line.1229"></a> |
| <span class="sourceLineNo">1230</span> * <jc>// Define a guard that only lets Billy make a request.</jc><a name="line.1230"></a> |
| <span class="sourceLineNo">1231</span> * <jk>public</jk> BillyGuard <jk>extends</jk> RestGuard {<a name="line.1231"></a> |
| <span class="sourceLineNo">1232</span> * <ja>@Override</ja><a name="line.1232"></a> |
| <span class="sourceLineNo">1233</span> * <jk>public boolean</jk> isRequestAllowed(RestRequest req) {<a name="line.1233"></a> |
| <span class="sourceLineNo">1234</span> * <jk>return</jk> req.getUserPrincipal().getName().equals(<js>"Billy"</js>);<a name="line.1234"></a> |
| <span class="sourceLineNo">1235</span> * }<a name="line.1235"></a> |
| <span class="sourceLineNo">1236</span> * }<a name="line.1236"></a> |
| <span class="sourceLineNo">1237</span> *<a name="line.1237"></a> |
| <span class="sourceLineNo">1238</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.1238"></a> |
| <span class="sourceLineNo">1239</span> * <ja>@Rest</ja>(guards={BillyGuard.<jk>class</jk>})<a name="line.1239"></a> |
| <span class="sourceLineNo">1240</span> * <jk>public class</jk> MyResource {<a name="line.1240"></a> |
| <span class="sourceLineNo">1241</span> *<a name="line.1241"></a> |
| <span class="sourceLineNo">1242</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.1242"></a> |
| <span class="sourceLineNo">1243</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1243"></a> |
| <span class="sourceLineNo">1244</span> *<a name="line.1244"></a> |
| <span class="sourceLineNo">1245</span> * <jc>// Using method on builder.</jc><a name="line.1245"></a> |
| <span class="sourceLineNo">1246</span> * builder.guards(BillyGuard.<jk>class</jk>);<a name="line.1246"></a> |
| <span class="sourceLineNo">1247</span> *<a name="line.1247"></a> |
| <span class="sourceLineNo">1248</span> * <jc>// Same, but using property.</jc><a name="line.1248"></a> |
| <span class="sourceLineNo">1249</span> * builder.addTo(<jsf>REST_guards</jsf>, BillyGuard.<jk>class</jk>);<a name="line.1249"></a> |
| <span class="sourceLineNo">1250</span> * }<a name="line.1250"></a> |
| <span class="sourceLineNo">1251</span> *<a name="line.1251"></a> |
| <span class="sourceLineNo">1252</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.1252"></a> |
| <span class="sourceLineNo">1253</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1253"></a> |
| <span class="sourceLineNo">1254</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1254"></a> |
| <span class="sourceLineNo">1255</span> * builder.guards(BillyGuard.<jk>class</jk>);<a name="line.1255"></a> |
| <span class="sourceLineNo">1256</span> * }<a name="line.1256"></a> |
| <span class="sourceLineNo">1257</span> *<a name="line.1257"></a> |
| <span class="sourceLineNo">1258</span> * <jc>// Override at the method level.</jc><a name="line.1258"></a> |
| <span class="sourceLineNo">1259</span> * <ja>@RestMethod</ja>(guards={SomeOtherGuard.<jk>class</jk>})<a name="line.1259"></a> |
| <span class="sourceLineNo">1260</span> * public Object myMethod() {...}<a name="line.1260"></a> |
| <span class="sourceLineNo">1261</span> * }<a name="line.1261"></a> |
| <span class="sourceLineNo">1262</span> * </p><a name="line.1262"></a> |
| <span class="sourceLineNo">1263</span> *<a name="line.1263"></a> |
| <span class="sourceLineNo">1264</span> * <ul class='notes'><a name="line.1264"></a> |
| <span class="sourceLineNo">1265</span> * <li><a name="line.1265"></a> |
| <span class="sourceLineNo">1266</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.1266"></a> |
| <span class="sourceLineNo">1267</span> * <ul><a name="line.1267"></a> |
| <span class="sourceLineNo">1268</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.1268"></a> |
| <span class="sourceLineNo">1269</span> * <li><code><jk>public</jk> T()</code><a name="line.1269"></a> |
| <span class="sourceLineNo">1270</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.1270"></a> |
| <span class="sourceLineNo">1271</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.1271"></a> |
| <span class="sourceLineNo">1272</span> * </ul><a name="line.1272"></a> |
| <span class="sourceLineNo">1273</span> * <li><a name="line.1273"></a> |
| <span class="sourceLineNo">1274</span> * Inner classes of the REST resource class are allowed.<a name="line.1274"></a> |
| <span class="sourceLineNo">1275</span> * </ul><a name="line.1275"></a> |
| <span class="sourceLineNo">1276</span> *<a name="line.1276"></a> |
| <span class="sourceLineNo">1277</span> * <ul class='seealso'><a name="line.1277"></a> |
| <span class="sourceLineNo">1278</span> * <li class='link'>{@doc RestGuards}<a name="line.1278"></a> |
| <span class="sourceLineNo">1279</span> * </ul><a name="line.1279"></a> |
| <span class="sourceLineNo">1280</span> */<a name="line.1280"></a> |
| <span class="sourceLineNo">1281</span> public static final String REST_guards = PREFIX + ".guards.lo";<a name="line.1281"></a> |
| <span class="sourceLineNo">1282</span><a name="line.1282"></a> |
| <span class="sourceLineNo">1283</span> /**<a name="line.1283"></a> |
| <span class="sourceLineNo">1284</span> * Configuration property: REST info provider.<a name="line.1284"></a> |
| <span class="sourceLineNo">1285</span> *<a name="line.1285"></a> |
| <span class="sourceLineNo">1286</span> * <h5 class='section'>Property:</h5><a name="line.1286"></a> |
| <span class="sourceLineNo">1287</span> * <ul class='spaced-list'><a name="line.1287"></a> |
| <span class="sourceLineNo">1288</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_infoProvider REST_infoProvider}<a name="line.1288"></a> |
| <span class="sourceLineNo">1289</span> * <li><b>Name:</b> <js>"RestContext.infoProvider.o"</js><a name="line.1289"></a> |
| <span class="sourceLineNo">1290</span> * <li><b>Data type:</b><a name="line.1290"></a> |
| <span class="sourceLineNo">1291</span> * <ul><a name="line.1291"></a> |
| <span class="sourceLineNo">1292</span> * <li>{@link org.apache.juneau.rest.RestInfoProvider}<a name="line.1292"></a> |
| <span class="sourceLineNo">1293</span> * <li><c>Class&lt;{@link org.apache.juneau.rest.RestInfoProvider}&gt;</c><a name="line.1293"></a> |
| <span class="sourceLineNo">1294</span> * </ul><a name="line.1294"></a> |
| <span class="sourceLineNo">1295</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.BasicRestInfoProvider}<a name="line.1295"></a> |
| <span class="sourceLineNo">1296</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1296"></a> |
| <span class="sourceLineNo">1297</span> * <li><b>Annotations:</b><a name="line.1297"></a> |
| <span class="sourceLineNo">1298</span> * <ul><a name="line.1298"></a> |
| <span class="sourceLineNo">1299</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#infoProvider()}<a name="line.1299"></a> |
| <span class="sourceLineNo">1300</span> * </ul><a name="line.1300"></a> |
| <span class="sourceLineNo">1301</span> * <li><b>Methods:</b><a name="line.1301"></a> |
| <span class="sourceLineNo">1302</span> * <ul><a name="line.1302"></a> |
| <span class="sourceLineNo">1303</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#infoProvider(Class)}<a name="line.1303"></a> |
| <span class="sourceLineNo">1304</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#infoProvider(RestInfoProvider)}<a name="line.1304"></a> |
| <span class="sourceLineNo">1305</span> * </ul><a name="line.1305"></a> |
| <span class="sourceLineNo">1306</span> * </ul><a name="line.1306"></a> |
| <span class="sourceLineNo">1307</span> *<a name="line.1307"></a> |
| <span class="sourceLineNo">1308</span> * <h5 class='section'>Description:</h5><a name="line.1308"></a> |
| <span class="sourceLineNo">1309</span> * <p><a name="line.1309"></a> |
| <span class="sourceLineNo">1310</span> * Class used to retrieve title/description/swagger information about a resource.<a name="line.1310"></a> |
| <span class="sourceLineNo">1311</span> *<a name="line.1311"></a> |
| <span class="sourceLineNo">1312</span> * <h5 class='section'>Example:</h5><a name="line.1312"></a> |
| <span class="sourceLineNo">1313</span> * <p class='bcode w800'><a name="line.1313"></a> |
| <span class="sourceLineNo">1314</span> * <jc>// Our customized info provider.</jc><a name="line.1314"></a> |
| <span class="sourceLineNo">1315</span> * <jc>// Extend from the default implementation and selectively override values.</jc><a name="line.1315"></a> |
| <span class="sourceLineNo">1316</span> * <jk>public class</jk> MyRestInfoProvider <jk>extends</jk> BasicRestInfoProvider {<a name="line.1316"></a> |
| <span class="sourceLineNo">1317</span> *<a name="line.1317"></a> |
| <span class="sourceLineNo">1318</span> * <jc>// Must provide this constructor!</jc><a name="line.1318"></a> |
| <span class="sourceLineNo">1319</span> * <jk>public</jk> MyRestInfoProvider(RestContext context) {<a name="line.1319"></a> |
| <span class="sourceLineNo">1320</span> * <jk>super</jk>(context);<a name="line.1320"></a> |
| <span class="sourceLineNo">1321</span> * }<a name="line.1321"></a> |
| <span class="sourceLineNo">1322</span> *<a name="line.1322"></a> |
| <span class="sourceLineNo">1323</span> * <ja>@Override</ja><a name="line.1323"></a> |
| <span class="sourceLineNo">1324</span> * <jk>public</jk> Swagger getSwaggerFromFile(RestRequest req) <jk>throws</jk> RestException {<a name="line.1324"></a> |
| <span class="sourceLineNo">1325</span> * <jc>// Provide our own method of retrieving swagger from file system.</jc><a name="line.1325"></a> |
| <span class="sourceLineNo">1326</span> * }<a name="line.1326"></a> |
| <span class="sourceLineNo">1327</span> *<a name="line.1327"></a> |
| <span class="sourceLineNo">1328</span> * <ja>@Override</ja><a name="line.1328"></a> |
| <span class="sourceLineNo">1329</span> * <jk>public</jk> Swagger getSwagger(RestRequest req) <jk>throws</jk> RestException {<a name="line.1329"></a> |
| <span class="sourceLineNo">1330</span> * Swagger s = <jk>super</jk>.getSwagger(req);<a name="line.1330"></a> |
| <span class="sourceLineNo">1331</span> * <jc>// Made inline modifications to generated swagger.</jc><a name="line.1331"></a> |
| <span class="sourceLineNo">1332</span> * <jk>return</jk> s;<a name="line.1332"></a> |
| <span class="sourceLineNo">1333</span> * }<a name="line.1333"></a> |
| <span class="sourceLineNo">1334</span> *<a name="line.1334"></a> |
| <span class="sourceLineNo">1335</span> * <ja>@Override</ja><a name="line.1335"></a> |
| <span class="sourceLineNo">1336</span> * <jk>public</jk> String getSiteName(RestRequest req) {<a name="line.1336"></a> |
| <span class="sourceLineNo">1337</span> * <jc>// Override the site name.</jc><a name="line.1337"></a> |
| <span class="sourceLineNo">1338</span> * }<a name="line.1338"></a> |
| <span class="sourceLineNo">1339</span> * }<a name="line.1339"></a> |
| <span class="sourceLineNo">1340</span> *<a name="line.1340"></a> |
| <span class="sourceLineNo">1341</span> * <jc>// Option #1 - Registered via annotation resolving to a config file setting with default value.</jc><a name="line.1341"></a> |
| <span class="sourceLineNo">1342</span> * <ja>@Rest</ja>(infoProvider=MyRestInfoProvider.<jk>class</jk>)<a name="line.1342"></a> |
| <span class="sourceLineNo">1343</span> * <jk>public class</jk> MyResource {<a name="line.1343"></a> |
| <span class="sourceLineNo">1344</span> *<a name="line.1344"></a> |
| <span class="sourceLineNo">1345</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.1345"></a> |
| <span class="sourceLineNo">1346</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1346"></a> |
| <span class="sourceLineNo">1347</span> *<a name="line.1347"></a> |
| <span class="sourceLineNo">1348</span> * <jc>// Using method on builder.</jc><a name="line.1348"></a> |
| <span class="sourceLineNo">1349</span> * builder.infoProvider(MyRestInfoProvider.<jk>class</jk>);<a name="line.1349"></a> |
| <span class="sourceLineNo">1350</span> *<a name="line.1350"></a> |
| <span class="sourceLineNo">1351</span> * <jc>// Same, but using property.</jc><a name="line.1351"></a> |
| <span class="sourceLineNo">1352</span> * builder.set(<jsf>REST_infoProvider</jsf>, MyRestInfoProvider.<jk>class</jk>);<a name="line.1352"></a> |
| <span class="sourceLineNo">1353</span> * }<a name="line.1353"></a> |
| <span class="sourceLineNo">1354</span> *<a name="line.1354"></a> |
| <span class="sourceLineNo">1355</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.1355"></a> |
| <span class="sourceLineNo">1356</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1356"></a> |
| <span class="sourceLineNo">1357</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1357"></a> |
| <span class="sourceLineNo">1358</span> * builder.infoProvider(MyRestInfoProvider.<jk>class</jk>);<a name="line.1358"></a> |
| <span class="sourceLineNo">1359</span> * }<a name="line.1359"></a> |
| <span class="sourceLineNo">1360</span> * }<a name="line.1360"></a> |
| <span class="sourceLineNo">1361</span> * </p><a name="line.1361"></a> |
| <span class="sourceLineNo">1362</span> *<a name="line.1362"></a> |
| <span class="sourceLineNo">1363</span> * <ul class='notes'><a name="line.1363"></a> |
| <span class="sourceLineNo">1364</span> * <li><a name="line.1364"></a> |
| <span class="sourceLineNo">1365</span> * The default info provider if not specified is {@link BasicRestInfoProvider}.<a name="line.1365"></a> |
| <span class="sourceLineNo">1366</span> * <li><a name="line.1366"></a> |
| <span class="sourceLineNo">1367</span> * The resource class itself will be used if it implements the {@link RestInfoProvider} interface and not<a name="line.1367"></a> |
| <span class="sourceLineNo">1368</span> * explicitly overridden via this annotation.<a name="line.1368"></a> |
| <span class="sourceLineNo">1369</span> * <li><a name="line.1369"></a> |
| <span class="sourceLineNo">1370</span> * The{@link RestServlet} and {@link BasicRest} classes implement the {@link RestInfoProvider} interface with the same<a name="line.1370"></a> |
| <span class="sourceLineNo">1371</span> * functionality as {@link BasicRestInfoProvider} that gets used if not overridden by this annotation.<a name="line.1371"></a> |
| <span class="sourceLineNo">1372</span> * <br>Subclasses can also alter the behavior by overriding these methods.<a name="line.1372"></a> |
| <span class="sourceLineNo">1373</span> * <li><a name="line.1373"></a> |
| <span class="sourceLineNo">1374</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.1374"></a> |
| <span class="sourceLineNo">1375</span> * <ul><a name="line.1375"></a> |
| <span class="sourceLineNo">1376</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.1376"></a> |
| <span class="sourceLineNo">1377</span> * <li><code><jk>public</jk> T()</code><a name="line.1377"></a> |
| <span class="sourceLineNo">1378</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.1378"></a> |
| <span class="sourceLineNo">1379</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.1379"></a> |
| <span class="sourceLineNo">1380</span> * </ul><a name="line.1380"></a> |
| <span class="sourceLineNo">1381</span> * <li><a name="line.1381"></a> |
| <span class="sourceLineNo">1382</span> * Inner classes of the REST resource class are allowed.<a name="line.1382"></a> |
| <span class="sourceLineNo">1383</span> * </ul><a name="line.1383"></a> |
| <span class="sourceLineNo">1384</span> */<a name="line.1384"></a> |
| <span class="sourceLineNo">1385</span> public static final String REST_infoProvider = PREFIX + ".infoProvider.o";<a name="line.1385"></a> |
| <span class="sourceLineNo">1386</span><a name="line.1386"></a> |
| <span class="sourceLineNo">1387</span> /**<a name="line.1387"></a> |
| <span class="sourceLineNo">1388</span> * Configuration property: REST logger.<a name="line.1388"></a> |
| <span class="sourceLineNo">1389</span> *<a name="line.1389"></a> |
| <span class="sourceLineNo">1390</span> * <div class='warn'><a name="line.1390"></a> |
| <span class="sourceLineNo">1391</span> * <b>Deprecated</b> - Use {@link #REST_callLogger}<a name="line.1391"></a> |
| <span class="sourceLineNo">1392</span> * </div><a name="line.1392"></a> |
| <span class="sourceLineNo">1393</span> */<a name="line.1393"></a> |
| <span class="sourceLineNo">1394</span> @Deprecated<a name="line.1394"></a> |
| <span class="sourceLineNo">1395</span> public static final String REST_logger = PREFIX + ".logger.o";<a name="line.1395"></a> |
| <span class="sourceLineNo">1396</span><a name="line.1396"></a> |
| <span class="sourceLineNo">1397</span> /**<a name="line.1397"></a> |
| <span class="sourceLineNo">1398</span> * Configuration property: The maximum allowed input size (in bytes) on HTTP requests.<a name="line.1398"></a> |
| <span class="sourceLineNo">1399</span> *<a name="line.1399"></a> |
| <span class="sourceLineNo">1400</span> * <h5 class='section'>Property:</h5><a name="line.1400"></a> |
| <span class="sourceLineNo">1401</span> * <ul class='spaced-list'><a name="line.1401"></a> |
| <span class="sourceLineNo">1402</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_maxInput REST_maxInput}<a name="line.1402"></a> |
| <span class="sourceLineNo">1403</span> * <li><b>Name:</b> <js>"RestContext.maxInput.s"</js><a name="line.1403"></a> |
| <span class="sourceLineNo">1404</span> * <li><b>Data type:</b> <c>String</c><a name="line.1404"></a> |
| <span class="sourceLineNo">1405</span> * <li><b>System property:</b> <c>RestContext.maxInput</c><a name="line.1405"></a> |
| <span class="sourceLineNo">1406</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_MAXINPUT</c><a name="line.1406"></a> |
| <span class="sourceLineNo">1407</span> * <li><b>Default:</b> <js>"100M"</js><a name="line.1407"></a> |
| <span class="sourceLineNo">1408</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1408"></a> |
| <span class="sourceLineNo">1409</span> * <li><b>Annotations:</b><a name="line.1409"></a> |
| <span class="sourceLineNo">1410</span> * <ul><a name="line.1410"></a> |
| <span class="sourceLineNo">1411</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#maxInput()}<a name="line.1411"></a> |
| <span class="sourceLineNo">1412</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#maxInput()}<a name="line.1412"></a> |
| <span class="sourceLineNo">1413</span> * </ul><a name="line.1413"></a> |
| <span class="sourceLineNo">1414</span> * <li><b>Methods:</b><a name="line.1414"></a> |
| <span class="sourceLineNo">1415</span> * <ul><a name="line.1415"></a> |
| <span class="sourceLineNo">1416</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#maxInput(String)}<a name="line.1416"></a> |
| <span class="sourceLineNo">1417</span> * </ul><a name="line.1417"></a> |
| <span class="sourceLineNo">1418</span> * </ul><a name="line.1418"></a> |
| <span class="sourceLineNo">1419</span> *<a name="line.1419"></a> |
| <span class="sourceLineNo">1420</span> * <h5 class='section'>Description:</h5><a name="line.1420"></a> |
| <span class="sourceLineNo">1421</span> * <p><a name="line.1421"></a> |
| <span class="sourceLineNo">1422</span> * Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting<a name="line.1422"></a> |
| <span class="sourceLineNo">1423</span> * in out-of-memory errors which could affect system stability.<a name="line.1423"></a> |
| <span class="sourceLineNo">1424</span> *<a name="line.1424"></a> |
| <span class="sourceLineNo">1425</span> * <h5 class='section'>Example:</h5><a name="line.1425"></a> |
| <span class="sourceLineNo">1426</span> * <p class='bcode w800'><a name="line.1426"></a> |
| <span class="sourceLineNo">1427</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.1427"></a> |
| <span class="sourceLineNo">1428</span> * <ja>@Rest</ja>(maxInput=<js>"$C{REST/maxInput,10M}"</js>)<a name="line.1428"></a> |
| <span class="sourceLineNo">1429</span> * <jk>public class</jk> MyResource {<a name="line.1429"></a> |
| <span class="sourceLineNo">1430</span> *<a name="line.1430"></a> |
| <span class="sourceLineNo">1431</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1431"></a> |
| <span class="sourceLineNo">1432</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1432"></a> |
| <span class="sourceLineNo">1433</span> *<a name="line.1433"></a> |
| <span class="sourceLineNo">1434</span> * <jc>// Using method on builder.</jc><a name="line.1434"></a> |
| <span class="sourceLineNo">1435</span> * builder.maxInput(<js>"10M"</js>);<a name="line.1435"></a> |
| <span class="sourceLineNo">1436</span> *<a name="line.1436"></a> |
| <span class="sourceLineNo">1437</span> * <jc>// Same, but using property.</jc><a name="line.1437"></a> |
| <span class="sourceLineNo">1438</span> * builder.set(<jsf>REST_maxInput</jsf>, <js>"10M"</js>);<a name="line.1438"></a> |
| <span class="sourceLineNo">1439</span> * }<a name="line.1439"></a> |
| <span class="sourceLineNo">1440</span> *<a name="line.1440"></a> |
| <span class="sourceLineNo">1441</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1441"></a> |
| <span class="sourceLineNo">1442</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1442"></a> |
| <span class="sourceLineNo">1443</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1443"></a> |
| <span class="sourceLineNo">1444</span> * builder.maxInput(<js>"10M"</js>);<a name="line.1444"></a> |
| <span class="sourceLineNo">1445</span> * }<a name="line.1445"></a> |
| <span class="sourceLineNo">1446</span> *<a name="line.1446"></a> |
| <span class="sourceLineNo">1447</span> * <jc>// Override at the method level.</jc><a name="line.1447"></a> |
| <span class="sourceLineNo">1448</span> * <ja>@RestMethod</ja>(maxInput=<js>"10M"</js>)<a name="line.1448"></a> |
| <span class="sourceLineNo">1449</span> * public Object myMethod() {...}<a name="line.1449"></a> |
| <span class="sourceLineNo">1450</span> * }<a name="line.1450"></a> |
| <span class="sourceLineNo">1451</span> * </p><a name="line.1451"></a> |
| <span class="sourceLineNo">1452</span> *<a name="line.1452"></a> |
| <span class="sourceLineNo">1453</span> * <ul class='notes'><a name="line.1453"></a> |
| <span class="sourceLineNo">1454</span> * <li><a name="line.1454"></a> |
| <span class="sourceLineNo">1455</span> * String value that gets resolved to a <jk>long</jk>.<a name="line.1455"></a> |
| <span class="sourceLineNo">1456</span> * <li><a name="line.1456"></a> |
| <span class="sourceLineNo">1457</span> * Can be suffixed with any of the following representing kilobytes, megabytes, and gigabytes:<a name="line.1457"></a> |
| <span class="sourceLineNo">1458</span> * <js>'K'</js>, <js>'M'</js>, <js>'G'</js>.<a name="line.1458"></a> |
| <span class="sourceLineNo">1459</span> * <li><a name="line.1459"></a> |
| <span class="sourceLineNo">1460</span> * A value of <js>"-1"</js> can be used to represent no limit.<a name="line.1460"></a> |
| <span class="sourceLineNo">1461</span> * </ul><a name="line.1461"></a> |
| <span class="sourceLineNo">1462</span> */<a name="line.1462"></a> |
| <span class="sourceLineNo">1463</span> public static final String REST_maxInput = PREFIX + ".maxInput.s";<a name="line.1463"></a> |
| <span class="sourceLineNo">1464</span><a name="line.1464"></a> |
| <span class="sourceLineNo">1465</span> /**<a name="line.1465"></a> |
| <span class="sourceLineNo">1466</span> * Configuration property: Messages.<a name="line.1466"></a> |
| <span class="sourceLineNo">1467</span> *<a name="line.1467"></a> |
| <span class="sourceLineNo">1468</span> * <h5 class='section'>Property:</h5><a name="line.1468"></a> |
| <span class="sourceLineNo">1469</span> * <ul class='spaced-list'><a name="line.1469"></a> |
| <span class="sourceLineNo">1470</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_messages REST_messages}<a name="line.1470"></a> |
| <span class="sourceLineNo">1471</span> * <li><b>Name:</b> <js>"RestContext.messages.lo"</js><a name="line.1471"></a> |
| <span class="sourceLineNo">1472</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.utils.Tuple2}&lt;Class,String&gt;&gt;</c><a name="line.1472"></a> |
| <span class="sourceLineNo">1473</span> * <li><b>Default:</b> <jk>null</jk><a name="line.1473"></a> |
| <span class="sourceLineNo">1474</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1474"></a> |
| <span class="sourceLineNo">1475</span> * <li><b>Annotations:</b><a name="line.1475"></a> |
| <span class="sourceLineNo">1476</span> * <ul><a name="line.1476"></a> |
| <span class="sourceLineNo">1477</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#messages()}<a name="line.1477"></a> |
| <span class="sourceLineNo">1478</span> * </ul><a name="line.1478"></a> |
| <span class="sourceLineNo">1479</span> * <li><b>Methods:</b><a name="line.1479"></a> |
| <span class="sourceLineNo">1480</span> * <ul><a name="line.1480"></a> |
| <span class="sourceLineNo">1481</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#messages(String)},<a name="line.1481"></a> |
| <span class="sourceLineNo">1482</span> * </ul><a name="line.1482"></a> |
| <span class="sourceLineNo">1483</span> * </ul><a name="line.1483"></a> |
| <span class="sourceLineNo">1484</span> *<a name="line.1484"></a> |
| <span class="sourceLineNo">1485</span> * <h5 class='section'>Description:</h5><a name="line.1485"></a> |
| <span class="sourceLineNo">1486</span> * <p><a name="line.1486"></a> |
| <span class="sourceLineNo">1487</span> * Identifies the location of the resource bundle for this class if it's different from the class name.<a name="line.1487"></a> |
| <span class="sourceLineNo">1488</span> *<a name="line.1488"></a> |
| <span class="sourceLineNo">1489</span> * <p><a name="line.1489"></a> |
| <span class="sourceLineNo">1490</span> * By default, the resource bundle name is assumed to match the class name. For example, given the class<a name="line.1490"></a> |
| <span class="sourceLineNo">1491</span> * <c>MyClass.java</c>, the resource bundle is assumed to be <c>MyClass.properties</c>. This property<a name="line.1491"></a> |
| <span class="sourceLineNo">1492</span> * allows you to override this setting to specify a different location such as <c>MyMessages.properties</c> by<a name="line.1492"></a> |
| <span class="sourceLineNo">1493</span> * specifying a value of <js>"MyMessages"</js>.<a name="line.1493"></a> |
| <span class="sourceLineNo">1494</span> *<a name="line.1494"></a> |
| <span class="sourceLineNo">1495</span> * <p><a name="line.1495"></a> |
| <span class="sourceLineNo">1496</span> * Resource bundles are searched using the following base name patterns:<a name="line.1496"></a> |
| <span class="sourceLineNo">1497</span> * <ul><a name="line.1497"></a> |
| <span class="sourceLineNo">1498</span> * <li><js>"{package}.{name}"</js><a name="line.1498"></a> |
| <span class="sourceLineNo">1499</span> * <li><js>"{package}.i18n.{name}"</js><a name="line.1499"></a> |
| <span class="sourceLineNo">1500</span> * <li><js>"{package}.nls.{name}"</js><a name="line.1500"></a> |
| <span class="sourceLineNo">1501</span> * <li><js>"{package}.messages.{name}"</js><a name="line.1501"></a> |
| <span class="sourceLineNo">1502</span> * </ul><a name="line.1502"></a> |
| <span class="sourceLineNo">1503</span> *<a name="line.1503"></a> |
| <span class="sourceLineNo">1504</span> * <p><a name="line.1504"></a> |
| <span class="sourceLineNo">1505</span> * This annotation is used to provide request-localized (based on <c>Accept-Language</c>) messages for the following methods:<a name="line.1505"></a> |
| <span class="sourceLineNo">1506</span> * <ul class='javatree'><a name="line.1506"></a> |
| <span class="sourceLineNo">1507</span> * <li class='jm'>{@link RestRequest#getMessage(String, Object...)}<a name="line.1507"></a> |
| <span class="sourceLineNo">1508</span> * <li class='jm'>{@link RestContext#getMessages() RestContext.getMessages()}<a name="line.1508"></a> |
| <span class="sourceLineNo">1509</span> * </ul><a name="line.1509"></a> |
| <span class="sourceLineNo">1510</span> *<a name="line.1510"></a> |
| <span class="sourceLineNo">1511</span> * <p><a name="line.1511"></a> |
| <span class="sourceLineNo">1512</span> * Request-localized messages are also available by passing either of the following parameter types into your Java method:<a name="line.1512"></a> |
| <span class="sourceLineNo">1513</span> * <ul class='javatree'><a name="line.1513"></a> |
| <span class="sourceLineNo">1514</span> * <li class='jc'>{@link ResourceBundle} - Basic Java resource bundle.<a name="line.1514"></a> |
| <span class="sourceLineNo">1515</span> * <li class='jc'>{@link Messages} - Extended resource bundle with several convenience methods.<a name="line.1515"></a> |
| <span class="sourceLineNo">1516</span> * </ul><a name="line.1516"></a> |
| <span class="sourceLineNo">1517</span> *<a name="line.1517"></a> |
| <span class="sourceLineNo">1518</span> * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the resource bundle<a name="line.1518"></a> |
| <span class="sourceLineNo">1519</span> * <js>"com.foo.sample.nls.Messages"</js> if the resource class is in <js>"com.foo.sample"</js>, or it can be an<a name="line.1519"></a> |
| <span class="sourceLineNo">1520</span> * absolute path like <js>"com.foo.sample.nls.Messages"</js><a name="line.1520"></a> |
| <span class="sourceLineNo">1521</span> *<a name="line.1521"></a> |
| <span class="sourceLineNo">1522</span> * <h5 class='section'>Examples:</h5><a name="line.1522"></a> |
| <span class="sourceLineNo">1523</span> * <p class='bcode w800'><a name="line.1523"></a> |
| <span class="sourceLineNo">1524</span> * <cc># Contents of org/apache/foo/nls/MyMessages.properties</cc><a name="line.1524"></a> |
| <span class="sourceLineNo">1525</span> *<a name="line.1525"></a> |
| <span class="sourceLineNo">1526</span> * <ck>HelloMessage</ck> = <cv>Hello {0}!</cv><a name="line.1526"></a> |
| <span class="sourceLineNo">1527</span> * </p><a name="line.1527"></a> |
| <span class="sourceLineNo">1528</span> * <p class='bcode w800'><a name="line.1528"></a> |
| <span class="sourceLineNo">1529</span> * <jc>// Contents of org/apache/foo/MyResource.java</jc><a name="line.1529"></a> |
| <span class="sourceLineNo">1530</span> *<a name="line.1530"></a> |
| <span class="sourceLineNo">1531</span> * <ja>@Rest</ja>(messages=<js>"nls/MyMessages"</js>)<a name="line.1531"></a> |
| <span class="sourceLineNo">1532</span> * <jk>public class</jk> MyResource {...}<a name="line.1532"></a> |
| <span class="sourceLineNo">1533</span> *<a name="line.1533"></a> |
| <span class="sourceLineNo">1534</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/hello/{you}"</js>)<a name="line.1534"></a> |
| <span class="sourceLineNo">1535</span> * <jk>public</jk> Object helloYou(RestRequest <jv>req</jv>, Messages <jv>messages</jv>, <ja>@Path</ja>(<js>"name"</js>) String <jv>you</jv>) {<a name="line.1535"></a> |
| <span class="sourceLineNo">1536</span> * String <jv>s</jv>;<a name="line.1536"></a> |
| <span class="sourceLineNo">1537</span> *<a name="line.1537"></a> |
| <span class="sourceLineNo">1538</span> * <jc>// Get it from the RestRequest object.</jc><a name="line.1538"></a> |
| <span class="sourceLineNo">1539</span> * <jv>s</jv> = <jv>req</jv>.getMessage(<js>"HelloMessage"</js>, <jv>you</jv>);<a name="line.1539"></a> |
| <span class="sourceLineNo">1540</span> *<a name="line.1540"></a> |
| <span class="sourceLineNo">1541</span> * <jc>// Or get it from the method parameter.</jc><a name="line.1541"></a> |
| <span class="sourceLineNo">1542</span> * <jv>s</jv> = <jv>messages</jv>.getString(<js>"HelloMessage"</js>, <jv>you</jv>);<a name="line.1542"></a> |
| <span class="sourceLineNo">1543</span> *<a name="line.1543"></a> |
| <span class="sourceLineNo">1544</span> * <jc>// Or get the message in a locale different from the request.</jc><a name="line.1544"></a> |
| <span class="sourceLineNo">1545</span> * <jv>s</jv> = <jv>messages</jv>.forLocale(Locale.<jsf>UK</jsf>).getString(<js>"HelloMessage"</js>, <jv>you</jv>);<a name="line.1545"></a> |
| <span class="sourceLineNo">1546</span> *<a name="line.1546"></a> |
| <span class="sourceLineNo">1547</span> * <jk>return</jk> <jv>s</jv>;<a name="line.1547"></a> |
| <span class="sourceLineNo">1548</span> * }<a name="line.1548"></a> |
| <span class="sourceLineNo">1549</span> * }<a name="line.1549"></a> |
| <span class="sourceLineNo">1550</span> * </p><a name="line.1550"></a> |
| <span class="sourceLineNo">1551</span> *<a name="line.1551"></a> |
| <span class="sourceLineNo">1552</span> * <ul class='notes'><a name="line.1552"></a> |
| <span class="sourceLineNo">1553</span> * <li>Mappings are cumulative from super classes.<a name="line.1553"></a> |
| <span class="sourceLineNo">1554</span> * <br>Therefore, you can find and retrieve messages up the class-hierarchy chain.<a name="line.1554"></a> |
| <span class="sourceLineNo">1555</span> * </ul><a name="line.1555"></a> |
| <span class="sourceLineNo">1556</span> *<a name="line.1556"></a> |
| <span class="sourceLineNo">1557</span> * <ul class='seealso'><a name="line.1557"></a> |
| <span class="sourceLineNo">1558</span> * <li class='jc'>{@link Messages}<a name="line.1558"></a> |
| <span class="sourceLineNo">1559</span> * <li class='link'>{@doc RestMessages}<a name="line.1559"></a> |
| <span class="sourceLineNo">1560</span> * </ul><a name="line.1560"></a> |
| <span class="sourceLineNo">1561</span> */<a name="line.1561"></a> |
| <span class="sourceLineNo">1562</span> public static final String REST_messages = PREFIX + ".messages.lo";<a name="line.1562"></a> |
| <span class="sourceLineNo">1563</span><a name="line.1563"></a> |
| <span class="sourceLineNo">1564</span> /**<a name="line.1564"></a> |
| <span class="sourceLineNo">1565</span> * Configuration property: MIME types.<a name="line.1565"></a> |
| <span class="sourceLineNo">1566</span> *<a name="line.1566"></a> |
| <span class="sourceLineNo">1567</span> * <h5 class='section'>Property:</h5><a name="line.1567"></a> |
| <span class="sourceLineNo">1568</span> * <ul class='spaced-list'><a name="line.1568"></a> |
| <span class="sourceLineNo">1569</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_mimeTypes REST_mimeTypes}<a name="line.1569"></a> |
| <span class="sourceLineNo">1570</span> * <li><b>Name:</b> <js>"RestContext.mimeTypes.ss"</js><a name="line.1570"></a> |
| <span class="sourceLineNo">1571</span> * <li><b>Data type:</b> <c>Set&lt;String&gt;</c><a name="line.1571"></a> |
| <span class="sourceLineNo">1572</span> * <li><b>System property:</b> <c>RestContext.mimeTypes</c><a name="line.1572"></a> |
| <span class="sourceLineNo">1573</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_MIMETYPES</c><a name="line.1573"></a> |
| <span class="sourceLineNo">1574</span> * <li><b>Default:</b> empty list<a name="line.1574"></a> |
| <span class="sourceLineNo">1575</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1575"></a> |
| <span class="sourceLineNo">1576</span> * <li><b>Annotations:</b><a name="line.1576"></a> |
| <span class="sourceLineNo">1577</span> * <ul><a name="line.1577"></a> |
| <span class="sourceLineNo">1578</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#mimeTypes()}<a name="line.1578"></a> |
| <span class="sourceLineNo">1579</span> * </ul><a name="line.1579"></a> |
| <span class="sourceLineNo">1580</span> * <li><b>Methods:</b><a name="line.1580"></a> |
| <span class="sourceLineNo">1581</span> * <ul><a name="line.1581"></a> |
| <span class="sourceLineNo">1582</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#mimeTypes(String...)}<a name="line.1582"></a> |
| <span class="sourceLineNo">1583</span> * </ul><a name="line.1583"></a> |
| <span class="sourceLineNo">1584</span> * </ul><a name="line.1584"></a> |
| <span class="sourceLineNo">1585</span> *<a name="line.1585"></a> |
| <span class="sourceLineNo">1586</span> * <h5 class='section'>Description:</h5><a name="line.1586"></a> |
| <span class="sourceLineNo">1587</span> * <p><a name="line.1587"></a> |
| <span class="sourceLineNo">1588</span> * Defines MIME-type file type mappings.<a name="line.1588"></a> |
| <span class="sourceLineNo">1589</span> *<a name="line.1589"></a> |
| <span class="sourceLineNo">1590</span> * <p><a name="line.1590"></a> |
| <span class="sourceLineNo">1591</span> * Used for specifying the content type on file resources retrieved through the following methods:<a name="line.1591"></a> |
| <span class="sourceLineNo">1592</span> * <ul class='javatree'><a name="line.1592"></a> |
| <span class="sourceLineNo">1593</span> * <li class='jm'>{@link RestContext#getStaticFile(String) RestContext.resolveStaticFile(String)}<a name="line.1593"></a> |
| <span class="sourceLineNo">1594</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String,boolean,MediaType,boolean)}<a name="line.1594"></a> |
| <span class="sourceLineNo">1595</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String,boolean)}<a name="line.1595"></a> |
| <span class="sourceLineNo">1596</span> * <li class='jm'>{@link RestRequest#getClasspathHttpResource(String)}<a name="line.1596"></a> |
| <span class="sourceLineNo">1597</span> * </ul><a name="line.1597"></a> |
| <span class="sourceLineNo">1598</span> *<a name="line.1598"></a> |
| <span class="sourceLineNo">1599</span> * <p><a name="line.1599"></a> |
| <span class="sourceLineNo">1600</span> * This list appends to the existing list provided by {@link ExtendedMimetypesFileTypeMap}.<a name="line.1600"></a> |
| <span class="sourceLineNo">1601</span> *<a name="line.1601"></a> |
| <span class="sourceLineNo">1602</span> * <h5 class='section'>Example:</h5><a name="line.1602"></a> |
| <span class="sourceLineNo">1603</span> * <p class='bcode w800'><a name="line.1603"></a> |
| <span class="sourceLineNo">1604</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.1604"></a> |
| <span class="sourceLineNo">1605</span> * <ja>@Rest</ja>(mimeTypes={<js>"text/plain txt text TXT"</js>})<a name="line.1605"></a> |
| <span class="sourceLineNo">1606</span> * <jk>public class</jk> MyResource {<a name="line.1606"></a> |
| <span class="sourceLineNo">1607</span> *<a name="line.1607"></a> |
| <span class="sourceLineNo">1608</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1608"></a> |
| <span class="sourceLineNo">1609</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1609"></a> |
| <span class="sourceLineNo">1610</span> *<a name="line.1610"></a> |
| <span class="sourceLineNo">1611</span> * <jc>// Using method on builder.</jc><a name="line.1611"></a> |
| <span class="sourceLineNo">1612</span> * builder.mimeTypes(<js>"text/plain txt text TXT"</js>);<a name="line.1612"></a> |
| <span class="sourceLineNo">1613</span> *<a name="line.1613"></a> |
| <span class="sourceLineNo">1614</span> * <jc>// Same, but using property.</jc><a name="line.1614"></a> |
| <span class="sourceLineNo">1615</span> * builder.addTo(<jsf>REST_mimeTypes</jsf>, <js>"text/plain txt text TXT"</js>);<a name="line.1615"></a> |
| <span class="sourceLineNo">1616</span> * }<a name="line.1616"></a> |
| <span class="sourceLineNo">1617</span> *<a name="line.1617"></a> |
| <span class="sourceLineNo">1618</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1618"></a> |
| <span class="sourceLineNo">1619</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1619"></a> |
| <span class="sourceLineNo">1620</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1620"></a> |
| <span class="sourceLineNo">1621</span> * builder.mimeTypes(<js>"text/plain txt text TXT"</js>);<a name="line.1621"></a> |
| <span class="sourceLineNo">1622</span> * }<a name="line.1622"></a> |
| <span class="sourceLineNo">1623</span> * }<a name="line.1623"></a> |
| <span class="sourceLineNo">1624</span> * </p><a name="line.1624"></a> |
| <span class="sourceLineNo">1625</span> *<a name="line.1625"></a> |
| <span class="sourceLineNo">1626</span> * <ul class='notes'><a name="line.1626"></a> |
| <span class="sourceLineNo">1627</span> * <li><a name="line.1627"></a> |
| <span class="sourceLineNo">1628</span> * Values are .mime.types formatted entry string.<a name="line.1628"></a> |
| <span class="sourceLineNo">1629</span> * <br>Example: <js>"image/svg+xml svg"</js><a name="line.1629"></a> |
| <span class="sourceLineNo">1630</span> * </ul><a name="line.1630"></a> |
| <span class="sourceLineNo">1631</span> */<a name="line.1631"></a> |
| <span class="sourceLineNo">1632</span> public static final String REST_mimeTypes = PREFIX + ".mimeTypes.ss";<a name="line.1632"></a> |
| <span class="sourceLineNo">1633</span><a name="line.1633"></a> |
| <span class="sourceLineNo">1634</span> /**<a name="line.1634"></a> |
| <span class="sourceLineNo">1635</span> * Configuration property: Java method parameter resolvers.<a name="line.1635"></a> |
| <span class="sourceLineNo">1636</span> *<a name="line.1636"></a> |
| <span class="sourceLineNo">1637</span> * <h5 class='section'>Property:</h5><a name="line.1637"></a> |
| <span class="sourceLineNo">1638</span> * <ul class='spaced-list'><a name="line.1638"></a> |
| <span class="sourceLineNo">1639</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_paramResolvers REST_paramResolvers}<a name="line.1639"></a> |
| <span class="sourceLineNo">1640</span> * <li><b>Name:</b> <js>"RestContext.paramResolvers.lo"</js><a name="line.1640"></a> |
| <span class="sourceLineNo">1641</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.rest.RestMethodParam}|Class&lt;{@link org.apache.juneau.rest.RestMethodParam}&gt;&gt;</c><a name="line.1641"></a> |
| <span class="sourceLineNo">1642</span> * <li><b>Default:</b> empty list<a name="line.1642"></a> |
| <span class="sourceLineNo">1643</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1643"></a> |
| <span class="sourceLineNo">1644</span> * <li><b>Annotations:</b><a name="line.1644"></a> |
| <span class="sourceLineNo">1645</span> * <ul><a name="line.1645"></a> |
| <span class="sourceLineNo">1646</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#paramResolvers()}<a name="line.1646"></a> |
| <span class="sourceLineNo">1647</span> * </ul><a name="line.1647"></a> |
| <span class="sourceLineNo">1648</span> * <li><b>Methods:</b><a name="line.1648"></a> |
| <span class="sourceLineNo">1649</span> * <ul><a name="line.1649"></a> |
| <span class="sourceLineNo">1650</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#paramResolvers(Class...)}<a name="line.1650"></a> |
| <span class="sourceLineNo">1651</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#paramResolvers(RestMethodParam...)}<a name="line.1651"></a> |
| <span class="sourceLineNo">1652</span> * </ul><a name="line.1652"></a> |
| <span class="sourceLineNo">1653</span> * </ul><a name="line.1653"></a> |
| <span class="sourceLineNo">1654</span> *<a name="line.1654"></a> |
| <span class="sourceLineNo">1655</span> * <h5 class='section'>Description:</h5><a name="line.1655"></a> |
| <span class="sourceLineNo">1656</span> * <p><a name="line.1656"></a> |
| <span class="sourceLineNo">1657</span> * By default, the Juneau framework will automatically Java method parameters of various types (e.g.<a name="line.1657"></a> |
| <span class="sourceLineNo">1658</span> * <c>RestRequest</c>, <c>Accept</c>, <c>Reader</c>).<a name="line.1658"></a> |
| <span class="sourceLineNo">1659</span> * This setting allows you to provide your own resolvers for your own class types that you want resolved.<a name="line.1659"></a> |
| <span class="sourceLineNo">1660</span> *<a name="line.1660"></a> |
| <span class="sourceLineNo">1661</span> * <p><a name="line.1661"></a> |
| <span class="sourceLineNo">1662</span> * For example, if you want to pass in instances of <c>MySpecialObject</c> to your Java method, define<a name="line.1662"></a> |
| <span class="sourceLineNo">1663</span> * the following resolver:<a name="line.1663"></a> |
| <span class="sourceLineNo">1664</span> * <p class='bcode w800'><a name="line.1664"></a> |
| <span class="sourceLineNo">1665</span> * <jc>// Define a parameter resolver for resolving MySpecialObject objects.</jc><a name="line.1665"></a> |
| <span class="sourceLineNo">1666</span> * <jk>public class</jk> MyRestParam <jk>extends</jk> RestMethodParam {<a name="line.1666"></a> |
| <span class="sourceLineNo">1667</span> *<a name="line.1667"></a> |
| <span class="sourceLineNo">1668</span> * <jc>// Must have no-arg constructor!</jc><a name="line.1668"></a> |
| <span class="sourceLineNo">1669</span> * <jk>public</jk> MyRestParam() {<a name="line.1669"></a> |
| <span class="sourceLineNo">1670</span> * <jc>// First two parameters help with Swagger doc generation.</jc><a name="line.1670"></a> |
| <span class="sourceLineNo">1671</span> * <jk>super</jk>(<jsf>QUERY</jsf>, <js>"myparam"</js>, MySpecialObject.<jk>class</jk>);<a name="line.1671"></a> |
| <span class="sourceLineNo">1672</span> * }<a name="line.1672"></a> |
| <span class="sourceLineNo">1673</span> *<a name="line.1673"></a> |
| <span class="sourceLineNo">1674</span> * <jc>// The method that creates our object.<a name="line.1674"></a> |
| <span class="sourceLineNo">1675</span> * // In this case, we're taking in a query parameter and converting it to our object.</jc><a name="line.1675"></a> |
| <span class="sourceLineNo">1676</span> * <jk>public</jk> Object resolve(RestRequest req, RestResponse res) <jk>throws</jk> Exception {<a name="line.1676"></a> |
| <span class="sourceLineNo">1677</span> * <jk>return new</jk> MySpecialObject(req.getQuery().get(<js>"myparam"</js>));<a name="line.1677"></a> |
| <span class="sourceLineNo">1678</span> * }<a name="line.1678"></a> |
| <span class="sourceLineNo">1679</span> * }<a name="line.1679"></a> |
| <span class="sourceLineNo">1680</span> *<a name="line.1680"></a> |
| <span class="sourceLineNo">1681</span> * <jc>// Option #1 - Registered via annotation.</jc><a name="line.1681"></a> |
| <span class="sourceLineNo">1682</span> * <ja>@Rest</ja>(paramResolvers=MyRestParam.<jk>class</jk>)<a name="line.1682"></a> |
| <span class="sourceLineNo">1683</span> * <jk>public class</jk> MyResource {<a name="line.1683"></a> |
| <span class="sourceLineNo">1684</span> *<a name="line.1684"></a> |
| <span class="sourceLineNo">1685</span> * <jc>// Option #2 - Registered via builder passed in through resource constructor.</jc><a name="line.1685"></a> |
| <span class="sourceLineNo">1686</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1686"></a> |
| <span class="sourceLineNo">1687</span> *<a name="line.1687"></a> |
| <span class="sourceLineNo">1688</span> * <jc>// Using method on builder.</jc><a name="line.1688"></a> |
| <span class="sourceLineNo">1689</span> * builder.paramResolvers(MyRestParam.<jk>class</jk>);<a name="line.1689"></a> |
| <span class="sourceLineNo">1690</span> *<a name="line.1690"></a> |
| <span class="sourceLineNo">1691</span> * <jc>// Same, but using property.</jc><a name="line.1691"></a> |
| <span class="sourceLineNo">1692</span> * builder.addTo(<jsf>REST_paramResolver</jsf>, MyRestParam.<jk>class</jk>);<a name="line.1692"></a> |
| <span class="sourceLineNo">1693</span> * }<a name="line.1693"></a> |
| <span class="sourceLineNo">1694</span> *<a name="line.1694"></a> |
| <span class="sourceLineNo">1695</span> * <jc>// Option #3 - Registered via builder passed in through init method.</jc><a name="line.1695"></a> |
| <span class="sourceLineNo">1696</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1696"></a> |
| <span class="sourceLineNo">1697</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1697"></a> |
| <span class="sourceLineNo">1698</span> * builder.paramResolvers(MyRestParam.<jk>class</jk>);<a name="line.1698"></a> |
| <span class="sourceLineNo">1699</span> * }<a name="line.1699"></a> |
| <span class="sourceLineNo">1700</span> *<a name="line.1700"></a> |
| <span class="sourceLineNo">1701</span> * <jc>// Now pass it into your method.</jc><a name="line.1701"></a> |
| <span class="sourceLineNo">1702</span> * <ja>@RestMethod</ja>(...)<a name="line.1702"></a> |
| <span class="sourceLineNo">1703</span> * <jk>public</jk> Object doMyMethod(MySpecialObject mySpeciaObject) {<a name="line.1703"></a> |
| <span class="sourceLineNo">1704</span> * <jc>// Do something with it.</jc><a name="line.1704"></a> |
| <span class="sourceLineNo">1705</span> * }<a name="line.1705"></a> |
| <span class="sourceLineNo">1706</span> * }<a name="line.1706"></a> |
| <span class="sourceLineNo">1707</span> * </p><a name="line.1707"></a> |
| <span class="sourceLineNo">1708</span> *<a name="line.1708"></a> |
| <span class="sourceLineNo">1709</span> * <ul class='notes'><a name="line.1709"></a> |
| <span class="sourceLineNo">1710</span> * <li><a name="line.1710"></a> |
| <span class="sourceLineNo">1711</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.1711"></a> |
| <span class="sourceLineNo">1712</span> * <ul><a name="line.1712"></a> |
| <span class="sourceLineNo">1713</span> * <li><code><jk>public</jk> T(BeanContext)</code><a name="line.1713"></a> |
| <span class="sourceLineNo">1714</span> * <li><code><jk>public</jk> T()</code><a name="line.1714"></a> |
| <span class="sourceLineNo">1715</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.1715"></a> |
| <span class="sourceLineNo">1716</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.1716"></a> |
| <span class="sourceLineNo">1717</span> * </ul><a name="line.1717"></a> |
| <span class="sourceLineNo">1718</span> * <li><a name="line.1718"></a> |
| <span class="sourceLineNo">1719</span> * Inner classes of the REST resource class are allowed.<a name="line.1719"></a> |
| <span class="sourceLineNo">1720</span> * <li><a name="line.1720"></a> |
| <span class="sourceLineNo">1721</span> * Refer to {@link RestMethodParam} for the list of predefined parameter resolvers.<a name="line.1721"></a> |
| <span class="sourceLineNo">1722</span> * </ul><a name="line.1722"></a> |
| <span class="sourceLineNo">1723</span> */<a name="line.1723"></a> |
| <span class="sourceLineNo">1724</span> public static final String REST_paramResolvers = PREFIX + ".paramResolvers.lo";<a name="line.1724"></a> |
| <span class="sourceLineNo">1725</span><a name="line.1725"></a> |
| <span class="sourceLineNo">1726</span> /**<a name="line.1726"></a> |
| <span class="sourceLineNo">1727</span> * Configuration property: Parsers.<a name="line.1727"></a> |
| <span class="sourceLineNo">1728</span> *<a name="line.1728"></a> |
| <span class="sourceLineNo">1729</span> * <h5 class='section'>Property:</h5><a name="line.1729"></a> |
| <span class="sourceLineNo">1730</span> * <ul class='spaced-list'><a name="line.1730"></a> |
| <span class="sourceLineNo">1731</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_parsers REST_parsers}<a name="line.1731"></a> |
| <span class="sourceLineNo">1732</span> * <li><b>Name:</b> <js>"RestContext.parsers.lo"</js><a name="line.1732"></a> |
| <span class="sourceLineNo">1733</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.parser.Parser}|Class&lt;{@link org.apache.juneau.parser.Parser}&gt;&gt;</c><a name="line.1733"></a> |
| <span class="sourceLineNo">1734</span> * <li><b>Default:</b> empty list<a name="line.1734"></a> |
| <span class="sourceLineNo">1735</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1735"></a> |
| <span class="sourceLineNo">1736</span> * <li><b>Annotations:</b><a name="line.1736"></a> |
| <span class="sourceLineNo">1737</span> * <ul><a name="line.1737"></a> |
| <span class="sourceLineNo">1738</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#parsers()}<a name="line.1738"></a> |
| <span class="sourceLineNo">1739</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#parsers()}<a name="line.1739"></a> |
| <span class="sourceLineNo">1740</span> * </ul><a name="line.1740"></a> |
| <span class="sourceLineNo">1741</span> * <li><b>Methods:</b><a name="line.1741"></a> |
| <span class="sourceLineNo">1742</span> * <ul><a name="line.1742"></a> |
| <span class="sourceLineNo">1743</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#parsers(Object...)}<a name="line.1743"></a> |
| <span class="sourceLineNo">1744</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#parsers(Class...)}<a name="line.1744"></a> |
| <span class="sourceLineNo">1745</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#parsersReplace(Object...)}<a name="line.1745"></a> |
| <span class="sourceLineNo">1746</span> * </ul><a name="line.1746"></a> |
| <span class="sourceLineNo">1747</span> * </ul><a name="line.1747"></a> |
| <span class="sourceLineNo">1748</span> *<a name="line.1748"></a> |
| <span class="sourceLineNo">1749</span> * <h5 class='section'>Description:</h5><a name="line.1749"></a> |
| <span class="sourceLineNo">1750</span> * <p><a name="line.1750"></a> |
| <span class="sourceLineNo">1751</span> * Adds class-level parsers to this resource.<a name="line.1751"></a> |
| <span class="sourceLineNo">1752</span> *<a name="line.1752"></a> |
| <span class="sourceLineNo">1753</span> * <p><a name="line.1753"></a> |
| <span class="sourceLineNo">1754</span> * Parsers are used to convert the body of HTTP requests into POJOs.<a name="line.1754"></a> |
| <span class="sourceLineNo">1755</span> * <br>Any of the Juneau framework parsers can be used in this setting.<a name="line.1755"></a> |
| <span class="sourceLineNo">1756</span> * <br>The parser selected is based on the request <c>Content-Type</c> header matched against the values returned by the following method<a name="line.1756"></a> |
| <span class="sourceLineNo">1757</span> * using a best-match algorithm:<a name="line.1757"></a> |
| <span class="sourceLineNo">1758</span> * <ul class='javatree'><a name="line.1758"></a> |
| <span class="sourceLineNo">1759</span> * <li class='jm'>{@link Parser#getMediaTypes()}<a name="line.1759"></a> |
| <span class="sourceLineNo">1760</span> * </ul><a name="line.1760"></a> |
| <span class="sourceLineNo">1761</span> *<a name="line.1761"></a> |
| <span class="sourceLineNo">1762</span> * <h5 class='section'>Example:</h5><a name="line.1762"></a> |
| <span class="sourceLineNo">1763</span> * <p class='bcode w800'><a name="line.1763"></a> |
| <span class="sourceLineNo">1764</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.1764"></a> |
| <span class="sourceLineNo">1765</span> * <ja>@Rest</ja>(parsers={JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>})<a name="line.1765"></a> |
| <span class="sourceLineNo">1766</span> * <jk>public class</jk> MyResource {<a name="line.1766"></a> |
| <span class="sourceLineNo">1767</span> *<a name="line.1767"></a> |
| <span class="sourceLineNo">1768</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1768"></a> |
| <span class="sourceLineNo">1769</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1769"></a> |
| <span class="sourceLineNo">1770</span> *<a name="line.1770"></a> |
| <span class="sourceLineNo">1771</span> * <jc>// Using method on builder.</jc><a name="line.1771"></a> |
| <span class="sourceLineNo">1772</span> * builder.parsers(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);<a name="line.1772"></a> |
| <span class="sourceLineNo">1773</span> *<a name="line.1773"></a> |
| <span class="sourceLineNo">1774</span> * <jc>// Same, but use pre-instantiated parsers.</jc><a name="line.1774"></a> |
| <span class="sourceLineNo">1775</span> * builder.parsers(JsonParser.<jsf>DEFAULT</jsf>, XmlParser.<jsf>DEFAULT</jsf>);<a name="line.1775"></a> |
| <span class="sourceLineNo">1776</span> *<a name="line.1776"></a> |
| <span class="sourceLineNo">1777</span> * <jc>// Same, but using property.</jc><a name="line.1777"></a> |
| <span class="sourceLineNo">1778</span> * builder.set(<jsf>REST_parsers</jsf>, JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);<a name="line.1778"></a> |
| <span class="sourceLineNo">1779</span> * }<a name="line.1779"></a> |
| <span class="sourceLineNo">1780</span> *<a name="line.1780"></a> |
| <span class="sourceLineNo">1781</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1781"></a> |
| <span class="sourceLineNo">1782</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1782"></a> |
| <span class="sourceLineNo">1783</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1783"></a> |
| <span class="sourceLineNo">1784</span> * builder.parsers(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>);<a name="line.1784"></a> |
| <span class="sourceLineNo">1785</span> * }<a name="line.1785"></a> |
| <span class="sourceLineNo">1786</span> *<a name="line.1786"></a> |
| <span class="sourceLineNo">1787</span> * <jc>// Override at the method level.</jc><a name="line.1787"></a> |
| <span class="sourceLineNo">1788</span> * <ja>@RestMethod</ja>(parsers={HtmlParser.<jk>class</jk>})<a name="line.1788"></a> |
| <span class="sourceLineNo">1789</span> * <jk>public</jk> Object myMethod(<ja>@Body</ja> MyPojo myPojo) {<a name="line.1789"></a> |
| <span class="sourceLineNo">1790</span> * <jc>// Do something with your parsed POJO.</jc><a name="line.1790"></a> |
| <span class="sourceLineNo">1791</span> * }<a name="line.1791"></a> |
| <span class="sourceLineNo">1792</span> * }<a name="line.1792"></a> |
| <span class="sourceLineNo">1793</span> * </p><a name="line.1793"></a> |
| <span class="sourceLineNo">1794</span> *<a name="line.1794"></a> |
| <span class="sourceLineNo">1795</span> * <ul class='notes'><a name="line.1795"></a> |
| <span class="sourceLineNo">1796</span> * <li><a name="line.1796"></a> |
| <span class="sourceLineNo">1797</span> * When defined as a class, properties/transforms defined on the resource/method are inherited.<a name="line.1797"></a> |
| <span class="sourceLineNo">1798</span> * <li><a name="line.1798"></a> |
| <span class="sourceLineNo">1799</span> * When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.<a name="line.1799"></a> |
| <span class="sourceLineNo">1800</span> * <li><a name="line.1800"></a> |
| <span class="sourceLineNo">1801</span> * Typically, you'll want your resource to extend directly from {@link BasicRestServlet} which comes<a name="line.1801"></a> |
| <span class="sourceLineNo">1802</span> * preconfigured with the following parsers:<a name="line.1802"></a> |
| <span class="sourceLineNo">1803</span> * <ul><a name="line.1803"></a> |
| <span class="sourceLineNo">1804</span> * <li class='jc'>{@link JsonParser}<a name="line.1804"></a> |
| <span class="sourceLineNo">1805</span> * <li class='jc'>{@link XmlParser}<a name="line.1805"></a> |
| <span class="sourceLineNo">1806</span> * <li class='jc'>{@link HtmlParser}<a name="line.1806"></a> |
| <span class="sourceLineNo">1807</span> * <li class='jc'>{@link UonParser}<a name="line.1807"></a> |
| <span class="sourceLineNo">1808</span> * <li class='jc'>{@link UrlEncodingParser}<a name="line.1808"></a> |
| <span class="sourceLineNo">1809</span> * <li class='jc'>{@link MsgPackParser}<a name="line.1809"></a> |
| <span class="sourceLineNo">1810</span> * <li class='jc'>{@link PlainTextParser}<a name="line.1810"></a> |
| <span class="sourceLineNo">1811</span> * </ul><a name="line.1811"></a> |
| <span class="sourceLineNo">1812</span> * </ul><a name="line.1812"></a> |
| <span class="sourceLineNo">1813</span> *<a name="line.1813"></a> |
| <span class="sourceLineNo">1814</span> * <ul class='seealso'><a name="line.1814"></a> |
| <span class="sourceLineNo">1815</span> * <li class='link'>{@doc RestParsers}<a name="line.1815"></a> |
| <span class="sourceLineNo">1816</span> * </ul><a name="line.1816"></a> |
| <span class="sourceLineNo">1817</span> */<a name="line.1817"></a> |
| <span class="sourceLineNo">1818</span> public static final String REST_parsers = PREFIX + ".parsers.lo";<a name="line.1818"></a> |
| <span class="sourceLineNo">1819</span><a name="line.1819"></a> |
| <span class="sourceLineNo">1820</span> /**<a name="line.1820"></a> |
| <span class="sourceLineNo">1821</span> * Configuration property: HTTP part parser.<a name="line.1821"></a> |
| <span class="sourceLineNo">1822</span> *<a name="line.1822"></a> |
| <span class="sourceLineNo">1823</span> * <h5 class='section'>Property:</h5><a name="line.1823"></a> |
| <span class="sourceLineNo">1824</span> * <ul class='spaced-list'><a name="line.1824"></a> |
| <span class="sourceLineNo">1825</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_partParser REST_partParser}<a name="line.1825"></a> |
| <span class="sourceLineNo">1826</span> * <li><b>Name:</b> <js>"RestContext.partParser.o"</js><a name="line.1826"></a> |
| <span class="sourceLineNo">1827</span> * <li><b>Data type:</b> <c>{@link org.apache.juneau.httppart.HttpPartParser}|Class&lt;{@link org.apache.juneau.httppart.HttpPartParser}&gt;</c><a name="line.1827"></a> |
| <span class="sourceLineNo">1828</span> * <li><b>Default:</b> {@link org.apache.juneau.oapi.OpenApiParser}<a name="line.1828"></a> |
| <span class="sourceLineNo">1829</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1829"></a> |
| <span class="sourceLineNo">1830</span> * <li><b>Annotations:</b><a name="line.1830"></a> |
| <span class="sourceLineNo">1831</span> * <ul><a name="line.1831"></a> |
| <span class="sourceLineNo">1832</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#partParser()}<a name="line.1832"></a> |
| <span class="sourceLineNo">1833</span> * </ul><a name="line.1833"></a> |
| <span class="sourceLineNo">1834</span> * <li><b>Methods:</b><a name="line.1834"></a> |
| <span class="sourceLineNo">1835</span> * <ul><a name="line.1835"></a> |
| <span class="sourceLineNo">1836</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#partParser(Class)}<a name="line.1836"></a> |
| <span class="sourceLineNo">1837</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#partParser(HttpPartParser)}<a name="line.1837"></a> |
| <span class="sourceLineNo">1838</span> * </ul><a name="line.1838"></a> |
| <span class="sourceLineNo">1839</span> * </ul><a name="line.1839"></a> |
| <span class="sourceLineNo">1840</span> *<a name="line.1840"></a> |
| <span class="sourceLineNo">1841</span> * <h5 class='section'>Description:</h5><a name="line.1841"></a> |
| <span class="sourceLineNo">1842</span> * <p><a name="line.1842"></a> |
| <span class="sourceLineNo">1843</span> * Specifies the {@link HttpPartParser} to use for parsing headers, query/form parameters, and URI parts.<a name="line.1843"></a> |
| <span class="sourceLineNo">1844</span> *<a name="line.1844"></a> |
| <span class="sourceLineNo">1845</span> * <p><a name="line.1845"></a> |
| <span class="sourceLineNo">1846</span> * The default value is {@link OpenApiParser} which allows for both plain-text and URL-Encoded-Object-Notation values.<a name="line.1846"></a> |
| <span class="sourceLineNo">1847</span> * <br>If your parts contain text that can be confused with UON (e.g. <js>"(foo)"</js>), you can switch to<a name="line.1847"></a> |
| <span class="sourceLineNo">1848</span> * {@link SimplePartParser} which treats everything as plain text.<a name="line.1848"></a> |
| <span class="sourceLineNo">1849</span> *<a name="line.1849"></a> |
| <span class="sourceLineNo">1850</span> * <h5 class='section'>Example:</h5><a name="line.1850"></a> |
| <span class="sourceLineNo">1851</span> * <p class='bcode w800'><a name="line.1851"></a> |
| <span class="sourceLineNo">1852</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.1852"></a> |
| <span class="sourceLineNo">1853</span> * <ja>@Rest</ja>(partParser=SimplePartParser.<jk>class</jk>)<a name="line.1853"></a> |
| <span class="sourceLineNo">1854</span> * <jk>public class</jk> MyResource {<a name="line.1854"></a> |
| <span class="sourceLineNo">1855</span> *<a name="line.1855"></a> |
| <span class="sourceLineNo">1856</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1856"></a> |
| <span class="sourceLineNo">1857</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1857"></a> |
| <span class="sourceLineNo">1858</span> *<a name="line.1858"></a> |
| <span class="sourceLineNo">1859</span> * <jc>// Using method on builder.</jc><a name="line.1859"></a> |
| <span class="sourceLineNo">1860</span> * builder.partParser(SimplePartParser.<jk>class</jk>);<a name="line.1860"></a> |
| <span class="sourceLineNo">1861</span> *<a name="line.1861"></a> |
| <span class="sourceLineNo">1862</span> * <jc>// Same, but using property.</jc><a name="line.1862"></a> |
| <span class="sourceLineNo">1863</span> * builder.set(<jsf>REST_partParser</jsf>, SimplePartParser.<jk>class</jk>);<a name="line.1863"></a> |
| <span class="sourceLineNo">1864</span> * }<a name="line.1864"></a> |
| <span class="sourceLineNo">1865</span> *<a name="line.1865"></a> |
| <span class="sourceLineNo">1866</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1866"></a> |
| <span class="sourceLineNo">1867</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1867"></a> |
| <span class="sourceLineNo">1868</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1868"></a> |
| <span class="sourceLineNo">1869</span> * builder.partParser(SimplePartParser.<jk>class</jk>);<a name="line.1869"></a> |
| <span class="sourceLineNo">1870</span> * }<a name="line.1870"></a> |
| <span class="sourceLineNo">1871</span> *<a name="line.1871"></a> |
| <span class="sourceLineNo">1872</span> * <ja>@RestMethod</ja>(...)<a name="line.1872"></a> |
| <span class="sourceLineNo">1873</span> * <jk>public</jk> Object myMethod(<ja>@Header</ja>(<js>"My-Header"</js>) MyParsedHeader h, <ja>@Query</ja>(<js>"myquery"</js>) MyParsedQuery q) {<a name="line.1873"></a> |
| <span class="sourceLineNo">1874</span> * <jc>// Do something with your parsed parts.</jc><a name="line.1874"></a> |
| <span class="sourceLineNo">1875</span> * }<a name="line.1875"></a> |
| <span class="sourceLineNo">1876</span> * }<a name="line.1876"></a> |
| <span class="sourceLineNo">1877</span> * </p><a name="line.1877"></a> |
| <span class="sourceLineNo">1878</span> *<a name="line.1878"></a> |
| <span class="sourceLineNo">1879</span> * <ul class='notes'><a name="line.1879"></a> |
| <span class="sourceLineNo">1880</span> * <li><a name="line.1880"></a> |
| <span class="sourceLineNo">1881</span> * When defined as a class, properties/transforms defined on the resource/method are inherited.<a name="line.1881"></a> |
| <span class="sourceLineNo">1882</span> * <li><a name="line.1882"></a> |
| <span class="sourceLineNo">1883</span> * When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.<a name="line.1883"></a> |
| <span class="sourceLineNo">1884</span> * </ul><a name="line.1884"></a> |
| <span class="sourceLineNo">1885</span> */<a name="line.1885"></a> |
| <span class="sourceLineNo">1886</span> public static final String REST_partParser = PREFIX + ".partParser.o";<a name="line.1886"></a> |
| <span class="sourceLineNo">1887</span><a name="line.1887"></a> |
| <span class="sourceLineNo">1888</span> /**<a name="line.1888"></a> |
| <span class="sourceLineNo">1889</span> * Configuration property: HTTP part serializer.<a name="line.1889"></a> |
| <span class="sourceLineNo">1890</span> *<a name="line.1890"></a> |
| <span class="sourceLineNo">1891</span> * <h5 class='section'>Property:</h5><a name="line.1891"></a> |
| <span class="sourceLineNo">1892</span> * <ul class='spaced-list'><a name="line.1892"></a> |
| <span class="sourceLineNo">1893</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_partSerializer REST_partSerializer}<a name="line.1893"></a> |
| <span class="sourceLineNo">1894</span> * <li><b>Name:</b> <js>"RestContext.partSerializer.o"</js><a name="line.1894"></a> |
| <span class="sourceLineNo">1895</span> * <li><b>Data type:</b><a name="line.1895"></a> |
| <span class="sourceLineNo">1896</span> * <ul><a name="line.1896"></a> |
| <span class="sourceLineNo">1897</span> * <li>{@link org.apache.juneau.httppart.HttpPartSerializer}<a name="line.1897"></a> |
| <span class="sourceLineNo">1898</span> * <li><c>Class&lt;{@link org.apache.juneau.httppart.HttpPartSerializer}&gt;</c><a name="line.1898"></a> |
| <span class="sourceLineNo">1899</span> * </ul><a name="line.1899"></a> |
| <span class="sourceLineNo">1900</span> * <li><b>Default:</b> {@link org.apache.juneau.oapi.OpenApiSerializer}<a name="line.1900"></a> |
| <span class="sourceLineNo">1901</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1901"></a> |
| <span class="sourceLineNo">1902</span> * <li><b>Annotations:</b><a name="line.1902"></a> |
| <span class="sourceLineNo">1903</span> * <ul><a name="line.1903"></a> |
| <span class="sourceLineNo">1904</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#partSerializer()}<a name="line.1904"></a> |
| <span class="sourceLineNo">1905</span> * </ul><a name="line.1905"></a> |
| <span class="sourceLineNo">1906</span> * <li><b>Methods:</b><a name="line.1906"></a> |
| <span class="sourceLineNo">1907</span> * <ul><a name="line.1907"></a> |
| <span class="sourceLineNo">1908</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#partSerializer(Class)}<a name="line.1908"></a> |
| <span class="sourceLineNo">1909</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#partSerializer(HttpPartSerializer)}<a name="line.1909"></a> |
| <span class="sourceLineNo">1910</span> * </ul><a name="line.1910"></a> |
| <span class="sourceLineNo">1911</span> * </ul><a name="line.1911"></a> |
| <span class="sourceLineNo">1912</span> *<a name="line.1912"></a> |
| <span class="sourceLineNo">1913</span> * <h5 class='section'>Description:</h5><a name="line.1913"></a> |
| <span class="sourceLineNo">1914</span> * <p><a name="line.1914"></a> |
| <span class="sourceLineNo">1915</span> * Specifies the {@link HttpPartSerializer} to use for serializing headers, query/form parameters, and URI parts.<a name="line.1915"></a> |
| <span class="sourceLineNo">1916</span> *<a name="line.1916"></a> |
| <span class="sourceLineNo">1917</span> * <p><a name="line.1917"></a> |
| <span class="sourceLineNo">1918</span> * The default value is {@link OpenApiSerializer} which serializes based on OpenAPI rules, but defaults to UON notation for beans and maps, and<a name="line.1918"></a> |
| <span class="sourceLineNo">1919</span> * plain text for everything else.<a name="line.1919"></a> |
| <span class="sourceLineNo">1920</span> * <br>Other options include:<a name="line.1920"></a> |
| <span class="sourceLineNo">1921</span> * <ul><a name="line.1921"></a> |
| <span class="sourceLineNo">1922</span> * <li class='jc'>{@link SimplePartSerializer} - Always serializes to plain text.<a name="line.1922"></a> |
| <span class="sourceLineNo">1923</span> * <li class='jc'>{@link UonSerializer} - Always serializers to UON.<a name="line.1923"></a> |
| <span class="sourceLineNo">1924</span> * </ul><a name="line.1924"></a> |
| <span class="sourceLineNo">1925</span> *<a name="line.1925"></a> |
| <span class="sourceLineNo">1926</span> * <h5 class='section'>Example:</h5><a name="line.1926"></a> |
| <span class="sourceLineNo">1927</span> * <p class='bcode w800'><a name="line.1927"></a> |
| <span class="sourceLineNo">1928</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.1928"></a> |
| <span class="sourceLineNo">1929</span> * <ja>@Rest</ja>(partSerializer=SimplePartSerializer.<jk>class</jk>)<a name="line.1929"></a> |
| <span class="sourceLineNo">1930</span> * <jk>public class</jk> MyResource {<a name="line.1930"></a> |
| <span class="sourceLineNo">1931</span> *<a name="line.1931"></a> |
| <span class="sourceLineNo">1932</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.1932"></a> |
| <span class="sourceLineNo">1933</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1933"></a> |
| <span class="sourceLineNo">1934</span> *<a name="line.1934"></a> |
| <span class="sourceLineNo">1935</span> * <jc>// Using method on builder.</jc><a name="line.1935"></a> |
| <span class="sourceLineNo">1936</span> * builder.partSerializer(SimplePartSerializer.<jk>class</jk>);<a name="line.1936"></a> |
| <span class="sourceLineNo">1937</span> *<a name="line.1937"></a> |
| <span class="sourceLineNo">1938</span> * <jc>// Same, but using property.</jc><a name="line.1938"></a> |
| <span class="sourceLineNo">1939</span> * builder.set(<jsf>REST_partSerializer</jsf>, SimplePartSerializer.<jk>class</jk>);<a name="line.1939"></a> |
| <span class="sourceLineNo">1940</span> * }<a name="line.1940"></a> |
| <span class="sourceLineNo">1941</span> *<a name="line.1941"></a> |
| <span class="sourceLineNo">1942</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.1942"></a> |
| <span class="sourceLineNo">1943</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.1943"></a> |
| <span class="sourceLineNo">1944</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.1944"></a> |
| <span class="sourceLineNo">1945</span> * builder.partSerializer(SimplePartSerializer.<jk>class</jk>);<a name="line.1945"></a> |
| <span class="sourceLineNo">1946</span> * }<a name="line.1946"></a> |
| <span class="sourceLineNo">1947</span> *<a name="line.1947"></a> |
| <span class="sourceLineNo">1948</span> * <ja>@RestMethod</ja>(...)<a name="line.1948"></a> |
| <span class="sourceLineNo">1949</span> * <jk>public</jk> Object myMethod(RestResponse res) {<a name="line.1949"></a> |
| <span class="sourceLineNo">1950</span> * <jc>// Set a header to a POJO.</jc><a name="line.1950"></a> |
| <span class="sourceLineNo">1951</span> * res.setHeader(<js>"My-Header"</js>, <jk>new</jk> MyPojo());<a name="line.1951"></a> |
| <span class="sourceLineNo">1952</span> * }<a name="line.1952"></a> |
| <span class="sourceLineNo">1953</span> * }<a name="line.1953"></a> |
| <span class="sourceLineNo">1954</span> * </p><a name="line.1954"></a> |
| <span class="sourceLineNo">1955</span> *<a name="line.1955"></a> |
| <span class="sourceLineNo">1956</span> * <ul class='notes'><a name="line.1956"></a> |
| <span class="sourceLineNo">1957</span> * <li><a name="line.1957"></a> |
| <span class="sourceLineNo">1958</span> * When defined as a class, properties/transforms defined on the resource/method are inherited.<a name="line.1958"></a> |
| <span class="sourceLineNo">1959</span> * <li><a name="line.1959"></a> |
| <span class="sourceLineNo">1960</span> * When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.<a name="line.1960"></a> |
| <span class="sourceLineNo">1961</span> * </ul><a name="line.1961"></a> |
| <span class="sourceLineNo">1962</span> */<a name="line.1962"></a> |
| <span class="sourceLineNo">1963</span> public static final String REST_partSerializer = PREFIX + ".partSerializer.o";<a name="line.1963"></a> |
| <span class="sourceLineNo">1964</span><a name="line.1964"></a> |
| <span class="sourceLineNo">1965</span> /**<a name="line.1965"></a> |
| <span class="sourceLineNo">1966</span> * Configuration property: Resource path.<a name="line.1966"></a> |
| <span class="sourceLineNo">1967</span> *<a name="line.1967"></a> |
| <span class="sourceLineNo">1968</span> * <h5 class='section'>Property:</h5><a name="line.1968"></a> |
| <span class="sourceLineNo">1969</span> * <ul class='spaced-list'><a name="line.1969"></a> |
| <span class="sourceLineNo">1970</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_path REST_path}<a name="line.1970"></a> |
| <span class="sourceLineNo">1971</span> * <li><b>Name:</b> <js>"RestContext.path.s"</js><a name="line.1971"></a> |
| <span class="sourceLineNo">1972</span> * <li><b>Data type:</b> <c>String</c><a name="line.1972"></a> |
| <span class="sourceLineNo">1973</span> * <li><b>System property:</b> <c>RestContext.path.</c><a name="line.1973"></a> |
| <span class="sourceLineNo">1974</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_PATH</c><a name="line.1974"></a> |
| <span class="sourceLineNo">1975</span> * <li><b>Default:</b> <jk>null</jk><a name="line.1975"></a> |
| <span class="sourceLineNo">1976</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.1976"></a> |
| <span class="sourceLineNo">1977</span> * <li><b>Annotations:</b><a name="line.1977"></a> |
| <span class="sourceLineNo">1978</span> * <ul><a name="line.1978"></a> |
| <span class="sourceLineNo">1979</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#path()}<a name="line.1979"></a> |
| <span class="sourceLineNo">1980</span> * </ul><a name="line.1980"></a> |
| <span class="sourceLineNo">1981</span> * <li><b>Methods:</b><a name="line.1981"></a> |
| <span class="sourceLineNo">1982</span> * <ul><a name="line.1982"></a> |
| <span class="sourceLineNo">1983</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#path(String)}<a name="line.1983"></a> |
| <span class="sourceLineNo">1984</span> * </ul><a name="line.1984"></a> |
| <span class="sourceLineNo">1985</span> * </ul><a name="line.1985"></a> |
| <span class="sourceLineNo">1986</span> *<a name="line.1986"></a> |
| <span class="sourceLineNo">1987</span> * <h5 class='section'>Description:</h5><a name="line.1987"></a> |
| <span class="sourceLineNo">1988</span> * <p><a name="line.1988"></a> |
| <span class="sourceLineNo">1989</span> * Identifies the URL subpath relative to the ascendant resource.<a name="line.1989"></a> |
| <span class="sourceLineNo">1990</span> *<a name="line.1990"></a> |
| <span class="sourceLineNo">1991</span> * <p><a name="line.1991"></a> |
| <span class="sourceLineNo">1992</span> * This setting is critical for the routing of HTTP requests from ascendant to child resources.<a name="line.1992"></a> |
| <span class="sourceLineNo">1993</span> *<a name="line.1993"></a> |
| <span class="sourceLineNo">1994</span> * <h5 class='section'>Example:</h5><a name="line.1994"></a> |
| <span class="sourceLineNo">1995</span> * <p class='bcode w800'><a name="line.1995"></a> |
| <span class="sourceLineNo">1996</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.1996"></a> |
| <span class="sourceLineNo">1997</span> * <ja>@Rest</ja>(path=<js>"/myResource"</js>)<a name="line.1997"></a> |
| <span class="sourceLineNo">1998</span> * <jk>public class</jk> MyResource {<a name="line.1998"></a> |
| <span class="sourceLineNo">1999</span> *<a name="line.1999"></a> |
| <span class="sourceLineNo">2000</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2000"></a> |
| <span class="sourceLineNo">2001</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2001"></a> |
| <span class="sourceLineNo">2002</span> *<a name="line.2002"></a> |
| <span class="sourceLineNo">2003</span> * <jc>// Using method on builder.</jc><a name="line.2003"></a> |
| <span class="sourceLineNo">2004</span> * builder.path(<js>"/myResource"</js>);<a name="line.2004"></a> |
| <span class="sourceLineNo">2005</span> *<a name="line.2005"></a> |
| <span class="sourceLineNo">2006</span> * <jc>// Same, but using property.</jc><a name="line.2006"></a> |
| <span class="sourceLineNo">2007</span> * builder.set(<jsf>REST_path</jsf>, <js>"/myResource"</js>);<a name="line.2007"></a> |
| <span class="sourceLineNo">2008</span> * }<a name="line.2008"></a> |
| <span class="sourceLineNo">2009</span> *<a name="line.2009"></a> |
| <span class="sourceLineNo">2010</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2010"></a> |
| <span class="sourceLineNo">2011</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2011"></a> |
| <span class="sourceLineNo">2012</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2012"></a> |
| <span class="sourceLineNo">2013</span> * builder.path(<js>"/myResource"</js>);<a name="line.2013"></a> |
| <span class="sourceLineNo">2014</span> * }<a name="line.2014"></a> |
| <span class="sourceLineNo">2015</span> * }<a name="line.2015"></a> |
| <span class="sourceLineNo">2016</span> * </p><a name="line.2016"></a> |
| <span class="sourceLineNo">2017</span> *<a name="line.2017"></a> |
| <span class="sourceLineNo">2018</span> * <p><a name="line.2018"></a> |
| <span class="sourceLineNo">2019</span> * <ul class='notes'><a name="line.2019"></a> |
| <span class="sourceLineNo">2020</span> * <li><a name="line.2020"></a> |
| <span class="sourceLineNo">2021</span> * This annotation is ignored on top-level servlets (i.e. servlets defined in <c>web.xml</c> files).<a name="line.2021"></a> |
| <span class="sourceLineNo">2022</span> * <br>Therefore, implementers can optionally specify a path value for documentation purposes.<a name="line.2022"></a> |
| <span class="sourceLineNo">2023</span> * <li><a name="line.2023"></a> |
| <span class="sourceLineNo">2024</span> * Typically, this setting is only applicable to resources defined as children through the<a name="line.2024"></a> |
| <span class="sourceLineNo">2025</span> * {@link Rest#children() @Rest(children)} annotation.<a name="line.2025"></a> |
| <span class="sourceLineNo">2026</span> * <br>However, it may be used in other ways (e.g. defining paths for top-level resources in microservices).<a name="line.2026"></a> |
| <span class="sourceLineNo">2027</span> * <li><a name="line.2027"></a> |
| <span class="sourceLineNo">2028</span> * Slashes are trimmed from the path ends.<a name="line.2028"></a> |
| <span class="sourceLineNo">2029</span> * <br>As a convention, you may want to start your path with <js>'/'</js> simple because it make it easier to read.<a name="line.2029"></a> |
| <span class="sourceLineNo">2030</span> * <li><a name="line.2030"></a> |
| <span class="sourceLineNo">2031</span> * This path is available through the following method:<a name="line.2031"></a> |
| <span class="sourceLineNo">2032</span> * <ul><a name="line.2032"></a> |
| <span class="sourceLineNo">2033</span> * <li class='jm'>{@link RestContext#getPath() RestContext.getPath()}<a name="line.2033"></a> |
| <span class="sourceLineNo">2034</span> * </ul><a name="line.2034"></a> |
| <span class="sourceLineNo">2035</span> * </ul><a name="line.2035"></a> |
| <span class="sourceLineNo">2036</span> */<a name="line.2036"></a> |
| <span class="sourceLineNo">2037</span> public static final String REST_path = PREFIX + ".path.s";<a name="line.2037"></a> |
| <span class="sourceLineNo">2038</span><a name="line.2038"></a> |
| <span class="sourceLineNo">2039</span> /**<a name="line.2039"></a> |
| <span class="sourceLineNo">2040</span> * Configuration property: Render response stack traces in responses.<a name="line.2040"></a> |
| <span class="sourceLineNo">2041</span> *<a name="line.2041"></a> |
| <span class="sourceLineNo">2042</span> * <h5 class='section'>Property:</h5><a name="line.2042"></a> |
| <span class="sourceLineNo">2043</span> * <ul class='spaced-list'><a name="line.2043"></a> |
| <span class="sourceLineNo">2044</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_renderResponseStackTraces REST_renderResponseStackTraces}<a name="line.2044"></a> |
| <span class="sourceLineNo">2045</span> * <li><b>Name:</b> <js>"RestContext.renderResponseStackTraces.b"</js><a name="line.2045"></a> |
| <span class="sourceLineNo">2046</span> * <li><b>Data type:</b> <jk>boolean</jk><a name="line.2046"></a> |
| <span class="sourceLineNo">2047</span> * <li><b>System property:</b> <c>RestContext.renderResponseStackTraces</c><a name="line.2047"></a> |
| <span class="sourceLineNo">2048</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_RENDERRESPONSESTACKTRACES</c><a name="line.2048"></a> |
| <span class="sourceLineNo">2049</span> * <li><b>Default:</b> <jk>false</jk><a name="line.2049"></a> |
| <span class="sourceLineNo">2050</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2050"></a> |
| <span class="sourceLineNo">2051</span> * <li><b>Annotations:</b><a name="line.2051"></a> |
| <span class="sourceLineNo">2052</span> * <ul><a name="line.2052"></a> |
| <span class="sourceLineNo">2053</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#renderResponseStackTraces()}<a name="line.2053"></a> |
| <span class="sourceLineNo">2054</span> * </ul><a name="line.2054"></a> |
| <span class="sourceLineNo">2055</span> * <li><b>Methods:</b><a name="line.2055"></a> |
| <span class="sourceLineNo">2056</span> * <ul><a name="line.2056"></a> |
| <span class="sourceLineNo">2057</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#renderResponseStackTraces(boolean)}<a name="line.2057"></a> |
| <span class="sourceLineNo">2058</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#renderResponseStackTraces()}<a name="line.2058"></a> |
| <span class="sourceLineNo">2059</span> * </ul><a name="line.2059"></a> |
| <span class="sourceLineNo">2060</span> * </ul><a name="line.2060"></a> |
| <span class="sourceLineNo">2061</span> *<a name="line.2061"></a> |
| <span class="sourceLineNo">2062</span> * <h5 class='section'>Description:</h5><a name="line.2062"></a> |
| <span class="sourceLineNo">2063</span> * <p><a name="line.2063"></a> |
| <span class="sourceLineNo">2064</span> * Render stack traces in HTTP response bodies when errors occur.<a name="line.2064"></a> |
| <span class="sourceLineNo">2065</span> *<a name="line.2065"></a> |
| <span class="sourceLineNo">2066</span> * <h5 class='section'>Example:</h5><a name="line.2066"></a> |
| <span class="sourceLineNo">2067</span> * <p class='bcode w800'><a name="line.2067"></a> |
| <span class="sourceLineNo">2068</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.2068"></a> |
| <span class="sourceLineNo">2069</span> * <ja>@Rest</ja>(renderResponseStackTraces=<jk>true</jk>)<a name="line.2069"></a> |
| <span class="sourceLineNo">2070</span> * <jk>public class</jk> MyResource {<a name="line.2070"></a> |
| <span class="sourceLineNo">2071</span> *<a name="line.2071"></a> |
| <span class="sourceLineNo">2072</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2072"></a> |
| <span class="sourceLineNo">2073</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2073"></a> |
| <span class="sourceLineNo">2074</span> *<a name="line.2074"></a> |
| <span class="sourceLineNo">2075</span> * <jc>// Using method on builder.</jc><a name="line.2075"></a> |
| <span class="sourceLineNo">2076</span> * builder.renderResponseStackTraces();<a name="line.2076"></a> |
| <span class="sourceLineNo">2077</span> *<a name="line.2077"></a> |
| <span class="sourceLineNo">2078</span> * <jc>// Same, but using property.</jc><a name="line.2078"></a> |
| <span class="sourceLineNo">2079</span> * builder.set(<jsf>REST_renderResponseStackTraces</jsf>, <jk>true</jk>);<a name="line.2079"></a> |
| <span class="sourceLineNo">2080</span> * }<a name="line.2080"></a> |
| <span class="sourceLineNo">2081</span> *<a name="line.2081"></a> |
| <span class="sourceLineNo">2082</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2082"></a> |
| <span class="sourceLineNo">2083</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2083"></a> |
| <span class="sourceLineNo">2084</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2084"></a> |
| <span class="sourceLineNo">2085</span> * builder.renderResponseStackTraces();<a name="line.2085"></a> |
| <span class="sourceLineNo">2086</span> * }<a name="line.2086"></a> |
| <span class="sourceLineNo">2087</span> * }<a name="line.2087"></a> |
| <span class="sourceLineNo">2088</span> * </p><a name="line.2088"></a> |
| <span class="sourceLineNo">2089</span> *<a name="line.2089"></a> |
| <span class="sourceLineNo">2090</span> * <ul class='notes'><a name="line.2090"></a> |
| <span class="sourceLineNo">2091</span> * <li><a name="line.2091"></a> |
| <span class="sourceLineNo">2092</span> * Useful for debugging, although allowing stack traces to be rendered may cause security concerns so use<a name="line.2092"></a> |
| <span class="sourceLineNo">2093</span> * caution when enabling.<a name="line.2093"></a> |
| <span class="sourceLineNo">2094</span> * <li><a name="line.2094"></a> |
| <span class="sourceLineNo">2095</span> * This setting is available through the following method:<a name="line.2095"></a> |
| <span class="sourceLineNo">2096</span> * <ul><a name="line.2096"></a> |
| <span class="sourceLineNo">2097</span> * <li class='jm'>{@link RestContext#isRenderResponseStackTraces() RestContext.isRenderResponseStackTraces()}<a name="line.2097"></a> |
| <span class="sourceLineNo">2098</span> * </ul><a name="line.2098"></a> |
| <span class="sourceLineNo">2099</span> * That method is used by {@link #handleError(RestCall, Throwable)}.<a name="line.2099"></a> |
| <span class="sourceLineNo">2100</span> * </ul><a name="line.2100"></a> |
| <span class="sourceLineNo">2101</span> */<a name="line.2101"></a> |
| <span class="sourceLineNo">2102</span> public static final String REST_renderResponseStackTraces = PREFIX + ".renderResponseStackTraces.b";<a name="line.2102"></a> |
| <span class="sourceLineNo">2103</span><a name="line.2103"></a> |
| <span class="sourceLineNo">2104</span> /**<a name="line.2104"></a> |
| <span class="sourceLineNo">2105</span> * Configuration property: Default request attributes.<a name="line.2105"></a> |
| <span class="sourceLineNo">2106</span> *<a name="line.2106"></a> |
| <span class="sourceLineNo">2107</span> * <h5 class='section'>Property:</h5><a name="line.2107"></a> |
| <span class="sourceLineNo">2108</span> * <ul class='spaced-list'><a name="line.2108"></a> |
| <span class="sourceLineNo">2109</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_reqAttrs REST_reqAttrs}<a name="line.2109"></a> |
| <span class="sourceLineNo">2110</span> * <li><b>Name:</b> <js>"RestContext.reqAttrs.smo"</js><a name="line.2110"></a> |
| <span class="sourceLineNo">2111</span> * <li><b>Data type:</b> <c>Map&lt;String,Object&gt;</c><a name="line.2111"></a> |
| <span class="sourceLineNo">2112</span> * <li><b>System property:</b> <c>RestContext.reqAttrs</c><a name="line.2112"></a> |
| <span class="sourceLineNo">2113</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_REQATTRS</c><a name="line.2113"></a> |
| <span class="sourceLineNo">2114</span> * <li><b>Default:</b> empty map<a name="line.2114"></a> |
| <span class="sourceLineNo">2115</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2115"></a> |
| <span class="sourceLineNo">2116</span> * <li><b>Annotations:</b><a name="line.2116"></a> |
| <span class="sourceLineNo">2117</span> * <ul><a name="line.2117"></a> |
| <span class="sourceLineNo">2118</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#reqAttrs()}<a name="line.2118"></a> |
| <span class="sourceLineNo">2119</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#reqAttrs()}<a name="line.2119"></a> |
| <span class="sourceLineNo">2120</span> * </ul><a name="line.2120"></a> |
| <span class="sourceLineNo">2121</span> * <li><b>Methods:</b><a name="line.2121"></a> |
| <span class="sourceLineNo">2122</span> * <ul><a name="line.2122"></a> |
| <span class="sourceLineNo">2123</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#reqAttrs(String...)}<a name="line.2123"></a> |
| <span class="sourceLineNo">2124</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#reqAttr(String,Object)}<a name="line.2124"></a> |
| <span class="sourceLineNo">2125</span> * </ul><a name="line.2125"></a> |
| <span class="sourceLineNo">2126</span> * </ul><a name="line.2126"></a> |
| <span class="sourceLineNo">2127</span> *<a name="line.2127"></a> |
| <span class="sourceLineNo">2128</span> * <h5 class='section'>Description:</h5><a name="line.2128"></a> |
| <span class="sourceLineNo">2129</span> * <p><a name="line.2129"></a> |
| <span class="sourceLineNo">2130</span> * Specifies default values for request attributes if they're not already set on the request.<a name="line.2130"></a> |
| <span class="sourceLineNo">2131</span> *<a name="line.2131"></a> |
| <span class="sourceLineNo">2132</span> * <ul class='notes'><a name="line.2132"></a> |
| <span class="sourceLineNo">2133</span> * <li><a name="line.2133"></a> |
| <span class="sourceLineNo">2134</span> * Strings are in the format <js>"Name: value"</js>.<a name="line.2134"></a> |
| <span class="sourceLineNo">2135</span> * <li><a name="line.2135"></a> |
| <span class="sourceLineNo">2136</span> * Affects values returned by the following methods:<a name="line.2136"></a> |
| <span class="sourceLineNo">2137</span> * <ul><a name="line.2137"></a> |
| <span class="sourceLineNo">2138</span> * <li class='jm'>{@link RestRequest#getAttribute(String)}.<a name="line.2138"></a> |
| <span class="sourceLineNo">2139</span> * <li class='jm'>{@link RestRequest#getAttributes()}.<a name="line.2139"></a> |
| <span class="sourceLineNo">2140</span> * </ul><a name="line.2140"></a> |
| <span class="sourceLineNo">2141</span> * </ul><a name="line.2141"></a> |
| <span class="sourceLineNo">2142</span> *<a name="line.2142"></a> |
| <span class="sourceLineNo">2143</span> * <h5 class='section'>Example:</h5><a name="line.2143"></a> |
| <span class="sourceLineNo">2144</span> * <p class='bcode w800'><a name="line.2144"></a> |
| <span class="sourceLineNo">2145</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.2145"></a> |
| <span class="sourceLineNo">2146</span> * <ja>@Rest</ja>(reqAttrs={<js>"Foo: bar"</js>, <js>"Baz: $C{REST/myAttributeValue}"</js>})<a name="line.2146"></a> |
| <span class="sourceLineNo">2147</span> * <jk>public class</jk> MyResource {<a name="line.2147"></a> |
| <span class="sourceLineNo">2148</span> *<a name="line.2148"></a> |
| <span class="sourceLineNo">2149</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2149"></a> |
| <span class="sourceLineNo">2150</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2150"></a> |
| <span class="sourceLineNo">2151</span> *<a name="line.2151"></a> |
| <span class="sourceLineNo">2152</span> * <jc>// Using method on builder.</jc><a name="line.2152"></a> |
| <span class="sourceLineNo">2153</span> * builder<a name="line.2153"></a> |
| <span class="sourceLineNo">2154</span> * .attr(<js>"Foo"</js>, <js>"bar"</js>);<a name="line.2154"></a> |
| <span class="sourceLineNo">2155</span> * .attr(<js>"Baz: true"</js>);<a name="line.2155"></a> |
| <span class="sourceLineNo">2156</span> *<a name="line.2156"></a> |
| <span class="sourceLineNo">2157</span> * <jc>// Same, but using property.</jc><a name="line.2157"></a> |
| <span class="sourceLineNo">2158</span> * builder.addTo(<jsf>REST_reqAttrs</jsf>, <js>"Foo"</js>, <js>"bar"</js>);<a name="line.2158"></a> |
| <span class="sourceLineNo">2159</span> * }<a name="line.2159"></a> |
| <span class="sourceLineNo">2160</span> *<a name="line.2160"></a> |
| <span class="sourceLineNo">2161</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2161"></a> |
| <span class="sourceLineNo">2162</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2162"></a> |
| <span class="sourceLineNo">2163</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2163"></a> |
| <span class="sourceLineNo">2164</span> * builder.reqAttr(<js>"Foo"</js>, <js>"bar"</js>);<a name="line.2164"></a> |
| <span class="sourceLineNo">2165</span> * }<a name="line.2165"></a> |
| <span class="sourceLineNo">2166</span> *<a name="line.2166"></a> |
| <span class="sourceLineNo">2167</span> * <jc>// Override at the method level.</jc><a name="line.2167"></a> |
| <span class="sourceLineNo">2168</span> * <ja>@RestMethod</ja>(reqAttrs={<js>"Foo: bar"</js>})<a name="line.2168"></a> |
| <span class="sourceLineNo">2169</span> * public Object myMethod() {...}<a name="line.2169"></a> |
| <span class="sourceLineNo">2170</span> * }<a name="line.2170"></a> |
| <span class="sourceLineNo">2171</span> * </p><a name="line.2171"></a> |
| <span class="sourceLineNo">2172</span> */<a name="line.2172"></a> |
| <span class="sourceLineNo">2173</span> public static final String REST_reqAttrs = PREFIX + ".reqAttrs.smo";<a name="line.2173"></a> |
| <span class="sourceLineNo">2174</span><a name="line.2174"></a> |
| <span class="sourceLineNo">2175</span> /**<a name="line.2175"></a> |
| <span class="sourceLineNo">2176</span> * Configuration property: Default request headers.<a name="line.2176"></a> |
| <span class="sourceLineNo">2177</span> *<a name="line.2177"></a> |
| <span class="sourceLineNo">2178</span> * <h5 class='section'>Property:</h5><a name="line.2178"></a> |
| <span class="sourceLineNo">2179</span> * <ul class='spaced-list'><a name="line.2179"></a> |
| <span class="sourceLineNo">2180</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_reqHeaders REST_reqHeaders}<a name="line.2180"></a> |
| <span class="sourceLineNo">2181</span> * <li><b>Name:</b> <js>"RestContext.reqHeaders.smo"</js><a name="line.2181"></a> |
| <span class="sourceLineNo">2182</span> * <li><b>Data type:</b> <c>Map&lt;String,String&gt;</c><a name="line.2182"></a> |
| <span class="sourceLineNo">2183</span> * <li><b>System property:</b> <c>RestContext.reqHeaders</c><a name="line.2183"></a> |
| <span class="sourceLineNo">2184</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_REQHEADERS</c><a name="line.2184"></a> |
| <span class="sourceLineNo">2185</span> * <li><b>Default:</b> empty map<a name="line.2185"></a> |
| <span class="sourceLineNo">2186</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2186"></a> |
| <span class="sourceLineNo">2187</span> * <li><b>Annotations:</b><a name="line.2187"></a> |
| <span class="sourceLineNo">2188</span> * <ul><a name="line.2188"></a> |
| <span class="sourceLineNo">2189</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#reqHeaders()}<a name="line.2189"></a> |
| <span class="sourceLineNo">2190</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#reqHeaders()}<a name="line.2190"></a> |
| <span class="sourceLineNo">2191</span> * </ul><a name="line.2191"></a> |
| <span class="sourceLineNo">2192</span> * <li><b>Methods:</b><a name="line.2192"></a> |
| <span class="sourceLineNo">2193</span> * <ul><a name="line.2193"></a> |
| <span class="sourceLineNo">2194</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#reqHeader(String,Object)}<a name="line.2194"></a> |
| <span class="sourceLineNo">2195</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#reqHeaders(String...)}<a name="line.2195"></a> |
| <span class="sourceLineNo">2196</span> * </ul><a name="line.2196"></a> |
| <span class="sourceLineNo">2197</span> * </ul><a name="line.2197"></a> |
| <span class="sourceLineNo">2198</span> *<a name="line.2198"></a> |
| <span class="sourceLineNo">2199</span> * <h5 class='section'>Description:</h5><a name="line.2199"></a> |
| <span class="sourceLineNo">2200</span> * <p><a name="line.2200"></a> |
| <span class="sourceLineNo">2201</span> * Specifies default values for request headers if they're not passed in through the request.<a name="line.2201"></a> |
| <span class="sourceLineNo">2202</span> *<a name="line.2202"></a> |
| <span class="sourceLineNo">2203</span> * <ul class='notes'><a name="line.2203"></a> |
| <span class="sourceLineNo">2204</span> * <li><a name="line.2204"></a> |
| <span class="sourceLineNo">2205</span> * Strings are in the format <js>"Header-Name: header-value"</js>.<a name="line.2205"></a> |
| <span class="sourceLineNo">2206</span> * <li><a name="line.2206"></a> |
| <span class="sourceLineNo">2207</span> * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.<a name="line.2207"></a> |
| <span class="sourceLineNo">2208</span> * <li><a name="line.2208"></a> |
| <span class="sourceLineNo">2209</span> * The most useful reason for this annotation is to provide a default <c>Accept</c> header when one is not<a name="line.2209"></a> |
| <span class="sourceLineNo">2210</span> * specified so that a particular default {@link Serializer} is picked.<a name="line.2210"></a> |
| <span class="sourceLineNo">2211</span> * </ul><a name="line.2211"></a> |
| <span class="sourceLineNo">2212</span> *<a name="line.2212"></a> |
| <span class="sourceLineNo">2213</span> * <h5 class='section'>Example:</h5><a name="line.2213"></a> |
| <span class="sourceLineNo">2214</span> * <p class='bcode w800'><a name="line.2214"></a> |
| <span class="sourceLineNo">2215</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.2215"></a> |
| <span class="sourceLineNo">2216</span> * <ja>@Rest</ja>(reqHeaders={<js>"Accept: application/json"</js>, <js>"My-Header: $C{REST/myHeaderValue}"</js>})<a name="line.2216"></a> |
| <span class="sourceLineNo">2217</span> * <jk>public class</jk> MyResource {<a name="line.2217"></a> |
| <span class="sourceLineNo">2218</span> *<a name="line.2218"></a> |
| <span class="sourceLineNo">2219</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2219"></a> |
| <span class="sourceLineNo">2220</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2220"></a> |
| <span class="sourceLineNo">2221</span> *<a name="line.2221"></a> |
| <span class="sourceLineNo">2222</span> * <jc>// Using method on builder.</jc><a name="line.2222"></a> |
| <span class="sourceLineNo">2223</span> * builder<a name="line.2223"></a> |
| <span class="sourceLineNo">2224</span> * .reqHeader(<js>"Accept"</js>, <js>"application/json"</js>);<a name="line.2224"></a> |
| <span class="sourceLineNo">2225</span> * .reqHeaders(<js>"My-Header: foo"</js>);<a name="line.2225"></a> |
| <span class="sourceLineNo">2226</span> *<a name="line.2226"></a> |
| <span class="sourceLineNo">2227</span> * <jc>// Same, but using property.</jc><a name="line.2227"></a> |
| <span class="sourceLineNo">2228</span> * builder.addTo(<jsf>REST_reqHeaders</jsf>, <js>"Accept"</js>, <js>"application/json"</js>);<a name="line.2228"></a> |
| <span class="sourceLineNo">2229</span> * }<a name="line.2229"></a> |
| <span class="sourceLineNo">2230</span> *<a name="line.2230"></a> |
| <span class="sourceLineNo">2231</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2231"></a> |
| <span class="sourceLineNo">2232</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2232"></a> |
| <span class="sourceLineNo">2233</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2233"></a> |
| <span class="sourceLineNo">2234</span> * builder.reqHeader(<js>"Accept"</js>, <js>"application/json"</js>);<a name="line.2234"></a> |
| <span class="sourceLineNo">2235</span> * }<a name="line.2235"></a> |
| <span class="sourceLineNo">2236</span> *<a name="line.2236"></a> |
| <span class="sourceLineNo">2237</span> * <jc>// Override at the method level.</jc><a name="line.2237"></a> |
| <span class="sourceLineNo">2238</span> * <ja>@RestMethod</ja>(reqHeaders={<js>"Accept: text/xml"</js>})<a name="line.2238"></a> |
| <span class="sourceLineNo">2239</span> * public Object myMethod() {...}<a name="line.2239"></a> |
| <span class="sourceLineNo">2240</span> * }<a name="line.2240"></a> |
| <span class="sourceLineNo">2241</span> * </p><a name="line.2241"></a> |
| <span class="sourceLineNo">2242</span> */<a name="line.2242"></a> |
| <span class="sourceLineNo">2243</span> public static final String REST_reqHeaders = PREFIX + ".reqHeaders.smo";<a name="line.2243"></a> |
| <span class="sourceLineNo">2244</span><a name="line.2244"></a> |
| <span class="sourceLineNo">2245</span> /**<a name="line.2245"></a> |
| <span class="sourceLineNo">2246</span> * Configuration property: Default response headers.<a name="line.2246"></a> |
| <span class="sourceLineNo">2247</span> *<a name="line.2247"></a> |
| <span class="sourceLineNo">2248</span> * <h5 class='section'>Property:</h5><a name="line.2248"></a> |
| <span class="sourceLineNo">2249</span> * <ul class='spaced-list'><a name="line.2249"></a> |
| <span class="sourceLineNo">2250</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_resHeaders REST_resHeaders}<a name="line.2250"></a> |
| <span class="sourceLineNo">2251</span> * <li><b>Name:</b> <js>"RestContext.resHeaders.omo"</js><a name="line.2251"></a> |
| <span class="sourceLineNo">2252</span> * <li><b>Data type:</b> <c>Map&lt;String,String&gt;</c><a name="line.2252"></a> |
| <span class="sourceLineNo">2253</span> * <li><b>System property:</b> <c>RestContext.resHeaders</c><a name="line.2253"></a> |
| <span class="sourceLineNo">2254</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_RESHEADERS</c><a name="line.2254"></a> |
| <span class="sourceLineNo">2255</span> * <li><b>Default:</b> empty map<a name="line.2255"></a> |
| <span class="sourceLineNo">2256</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2256"></a> |
| <span class="sourceLineNo">2257</span> * <li><b>Annotations:</b><a name="line.2257"></a> |
| <span class="sourceLineNo">2258</span> * <ul><a name="line.2258"></a> |
| <span class="sourceLineNo">2259</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#resHeaders()}<a name="line.2259"></a> |
| <span class="sourceLineNo">2260</span> * </ul><a name="line.2260"></a> |
| <span class="sourceLineNo">2261</span> * <li><b>Methods:</b><a name="line.2261"></a> |
| <span class="sourceLineNo">2262</span> * <ul><a name="line.2262"></a> |
| <span class="sourceLineNo">2263</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#resHeader(String,Object)}<a name="line.2263"></a> |
| <span class="sourceLineNo">2264</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#resHeaders(String...)}<a name="line.2264"></a> |
| <span class="sourceLineNo">2265</span> * </ul><a name="line.2265"></a> |
| <span class="sourceLineNo">2266</span> * </ul><a name="line.2266"></a> |
| <span class="sourceLineNo">2267</span> *<a name="line.2267"></a> |
| <span class="sourceLineNo">2268</span> * <h5 class='section'>Description:</h5><a name="line.2268"></a> |
| <span class="sourceLineNo">2269</span> * <p><a name="line.2269"></a> |
| <span class="sourceLineNo">2270</span> * Specifies default values for response headers if they're not set after the Java REST method is called.<a name="line.2270"></a> |
| <span class="sourceLineNo">2271</span> *<a name="line.2271"></a> |
| <span class="sourceLineNo">2272</span> * <ul class='notes'><a name="line.2272"></a> |
| <span class="sourceLineNo">2273</span> * <li><a name="line.2273"></a> |
| <span class="sourceLineNo">2274</span> * Strings are in the format <js>"Header-Name: header-value"</js>.<a name="line.2274"></a> |
| <span class="sourceLineNo">2275</span> * <li><a name="line.2275"></a> |
| <span class="sourceLineNo">2276</span> * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of<a name="line.2276"></a> |
| <span class="sourceLineNo">2277</span> * the Java methods.<a name="line.2277"></a> |
| <span class="sourceLineNo">2278</span> * <li><a name="line.2278"></a> |
| <span class="sourceLineNo">2279</span> * The header value will not be set if the header value has already been specified (hence the 'default' in the name).<a name="line.2279"></a> |
| <span class="sourceLineNo">2280</span> * </ul><a name="line.2280"></a> |
| <span class="sourceLineNo">2281</span> *<a name="line.2281"></a> |
| <span class="sourceLineNo">2282</span> * <h5 class='section'>Example:</h5><a name="line.2282"></a> |
| <span class="sourceLineNo">2283</span> * <p class='bcode w800'><a name="line.2283"></a> |
| <span class="sourceLineNo">2284</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.2284"></a> |
| <span class="sourceLineNo">2285</span> * <ja>@Rest</ja>(resHeaders={<js>"Content-Type: $C{REST/defaultContentType,text/plain}"</js>,<js>"My-Header: $C{REST/myHeaderValue}"</js>})<a name="line.2285"></a> |
| <span class="sourceLineNo">2286</span> * <jk>public class</jk> MyResource {<a name="line.2286"></a> |
| <span class="sourceLineNo">2287</span> *<a name="line.2287"></a> |
| <span class="sourceLineNo">2288</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2288"></a> |
| <span class="sourceLineNo">2289</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2289"></a> |
| <span class="sourceLineNo">2290</span> *<a name="line.2290"></a> |
| <span class="sourceLineNo">2291</span> * <jc>// Using method on builder.</jc><a name="line.2291"></a> |
| <span class="sourceLineNo">2292</span> * builder<a name="line.2292"></a> |
| <span class="sourceLineNo">2293</span> * .resHeader(<js>"Content-Type"</js>, <js>"text/plain"</js>);<a name="line.2293"></a> |
| <span class="sourceLineNo">2294</span> * .resHeaders(<js>"My-Header: foo"</js>);<a name="line.2294"></a> |
| <span class="sourceLineNo">2295</span> *<a name="line.2295"></a> |
| <span class="sourceLineNo">2296</span> * <jc>// Same, but using property.</jc><a name="line.2296"></a> |
| <span class="sourceLineNo">2297</span> * builder<a name="line.2297"></a> |
| <span class="sourceLineNo">2298</span> * .addTo(<jsf>REST_resHeaders</jsf>, <js>"Accept"</js>, <js>"application/json"</js>);<a name="line.2298"></a> |
| <span class="sourceLineNo">2299</span> * .addTo(<jsf>REST_resHeaders</jsf>, <js>"My-Header"</js>, <js>"foo"</js>);<a name="line.2299"></a> |
| <span class="sourceLineNo">2300</span> * }<a name="line.2300"></a> |
| <span class="sourceLineNo">2301</span> *<a name="line.2301"></a> |
| <span class="sourceLineNo">2302</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2302"></a> |
| <span class="sourceLineNo">2303</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2303"></a> |
| <span class="sourceLineNo">2304</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2304"></a> |
| <span class="sourceLineNo">2305</span> * builder.resHeader(<js>"Content-Type"</js>, <js>"text/plain"</js>);<a name="line.2305"></a> |
| <span class="sourceLineNo">2306</span> * }<a name="line.2306"></a> |
| <span class="sourceLineNo">2307</span> * }<a name="line.2307"></a> |
| <span class="sourceLineNo">2308</span> * </p><a name="line.2308"></a> |
| <span class="sourceLineNo">2309</span> */<a name="line.2309"></a> |
| <span class="sourceLineNo">2310</span> public static final String REST_resHeaders = PREFIX + ".resHeaders.omo";<a name="line.2310"></a> |
| <span class="sourceLineNo">2311</span><a name="line.2311"></a> |
| <span class="sourceLineNo">2312</span> /**<a name="line.2312"></a> |
| <span class="sourceLineNo">2313</span> * Configuration property: REST resource resolver.<a name="line.2313"></a> |
| <span class="sourceLineNo">2314</span> *<a name="line.2314"></a> |
| <span class="sourceLineNo">2315</span> * <h5 class='section'>Property:</h5><a name="line.2315"></a> |
| <span class="sourceLineNo">2316</span> * <ul class='spaced-list'><a name="line.2316"></a> |
| <span class="sourceLineNo">2317</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_resourceResolver REST_resourceResolver}<a name="line.2317"></a> |
| <span class="sourceLineNo">2318</span> * <li><b>Name:</b> <js>"RestContext.resourceResolver.o"</js><a name="line.2318"></a> |
| <span class="sourceLineNo">2319</span> * <li><b>Data type:</b><a name="line.2319"></a> |
| <span class="sourceLineNo">2320</span> * <ul><a name="line.2320"></a> |
| <span class="sourceLineNo">2321</span> * <li>{@link org.apache.juneau.rest.RestResourceResolver}<a name="line.2321"></a> |
| <span class="sourceLineNo">2322</span> * <li><c>Class&lt;{@link org.apache.juneau.rest.RestResourceResolver}&gt;</c><a name="line.2322"></a> |
| <span class="sourceLineNo">2323</span> * </ul><a name="line.2323"></a> |
| <span class="sourceLineNo">2324</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.BasicRestResourceResolver}<a name="line.2324"></a> |
| <span class="sourceLineNo">2325</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2325"></a> |
| <span class="sourceLineNo">2326</span> * <li><b>Annotations:</b><a name="line.2326"></a> |
| <span class="sourceLineNo">2327</span> * <ul><a name="line.2327"></a> |
| <span class="sourceLineNo">2328</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#resourceResolver()}<a name="line.2328"></a> |
| <span class="sourceLineNo">2329</span> * </ul><a name="line.2329"></a> |
| <span class="sourceLineNo">2330</span> * <li><b>Methods:</b><a name="line.2330"></a> |
| <span class="sourceLineNo">2331</span> * <ul><a name="line.2331"></a> |
| <span class="sourceLineNo">2332</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#resourceResolver(Class)}<a name="line.2332"></a> |
| <span class="sourceLineNo">2333</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#resourceResolver(RestResourceResolver)}<a name="line.2333"></a> |
| <span class="sourceLineNo">2334</span> * </ul><a name="line.2334"></a> |
| <span class="sourceLineNo">2335</span> * </ul><a name="line.2335"></a> |
| <span class="sourceLineNo">2336</span> *<a name="line.2336"></a> |
| <span class="sourceLineNo">2337</span> * <h5 class='section'>Description:</h5><a name="line.2337"></a> |
| <span class="sourceLineNo">2338</span> * <p><a name="line.2338"></a> |
| <span class="sourceLineNo">2339</span> * The resolver used for resolving instances of child resources.<a name="line.2339"></a> |
| <span class="sourceLineNo">2340</span> *<a name="line.2340"></a> |
| <span class="sourceLineNo">2341</span> * <p><a name="line.2341"></a> |
| <span class="sourceLineNo">2342</span> * Can be used to provide customized resolution of REST resource class instances (e.g. resources retrieve from Spring).<a name="line.2342"></a> |
| <span class="sourceLineNo">2343</span> *<a name="line.2343"></a> |
| <span class="sourceLineNo">2344</span> * <h5 class='section'>Example:</h5><a name="line.2344"></a> |
| <span class="sourceLineNo">2345</span> * <p class='bcode w800'><a name="line.2345"></a> |
| <span class="sourceLineNo">2346</span> * <jc>// Our custom resource resolver. </jc><a name="line.2346"></a> |
| <span class="sourceLineNo">2347</span> * <jk>public class</jk> MyResourceResolver <jk>extends</jk> RestResourceResolverSimple {<a name="line.2347"></a> |
| <span class="sourceLineNo">2348</span> *<a name="line.2348"></a> |
| <span class="sourceLineNo">2349</span> * <ja>@Override</ja><a name="line.2349"></a> |
| <span class="sourceLineNo">2350</span> * <jk>public</jk> Object resolve(Class&lt;?&gt; resourceType, RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2350"></a> |
| <span class="sourceLineNo">2351</span> * Object resource = <jsm>findOurResourceSomehow</jsm>(resourceType);<a name="line.2351"></a> |
| <span class="sourceLineNo">2352</span> *<a name="line.2352"></a> |
| <span class="sourceLineNo">2353</span> * <jc>// If we can't resolve it, use default resolution.</jc><a name="line.2353"></a> |
| <span class="sourceLineNo">2354</span> * <jk>if</jk> (resource == <jk>null</jk>)<a name="line.2354"></a> |
| <span class="sourceLineNo">2355</span> * resource = <jk>super</jk>.resolve(resourceType, builder);<a name="line.2355"></a> |
| <span class="sourceLineNo">2356</span> *<a name="line.2356"></a> |
| <span class="sourceLineNo">2357</span> * <jk>return</jk> resource;<a name="line.2357"></a> |
| <span class="sourceLineNo">2358</span> * }<a name="line.2358"></a> |
| <span class="sourceLineNo">2359</span> * }<a name="line.2359"></a> |
| <span class="sourceLineNo">2360</span> *<a name="line.2360"></a> |
| <span class="sourceLineNo">2361</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.2361"></a> |
| <span class="sourceLineNo">2362</span> * <ja>@Rest</ja>(resourceResolver=MyResourceResolver.<jk>class</jk>)<a name="line.2362"></a> |
| <span class="sourceLineNo">2363</span> * <jk>public class</jk> MyResource {<a name="line.2363"></a> |
| <span class="sourceLineNo">2364</span> *<a name="line.2364"></a> |
| <span class="sourceLineNo">2365</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2365"></a> |
| <span class="sourceLineNo">2366</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2366"></a> |
| <span class="sourceLineNo">2367</span> *<a name="line.2367"></a> |
| <span class="sourceLineNo">2368</span> * <jc>// Using method on builder.</jc><a name="line.2368"></a> |
| <span class="sourceLineNo">2369</span> * builder.resourceResolver(MyResourceResolver.<jk>class</jk>);<a name="line.2369"></a> |
| <span class="sourceLineNo">2370</span> *<a name="line.2370"></a> |
| <span class="sourceLineNo">2371</span> * <jc>// Same, but using property.</jc><a name="line.2371"></a> |
| <span class="sourceLineNo">2372</span> * builder.set(<jsf>REST_resourceResolver</jsf>, MyResourceResolver.<jk>class</jk>);<a name="line.2372"></a> |
| <span class="sourceLineNo">2373</span> * }<a name="line.2373"></a> |
| <span class="sourceLineNo">2374</span> *<a name="line.2374"></a> |
| <span class="sourceLineNo">2375</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2375"></a> |
| <span class="sourceLineNo">2376</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2376"></a> |
| <span class="sourceLineNo">2377</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2377"></a> |
| <span class="sourceLineNo">2378</span> * builder.resourceResolver(MyResourceResolver.<jk>class</jk>);<a name="line.2378"></a> |
| <span class="sourceLineNo">2379</span> * }<a name="line.2379"></a> |
| <span class="sourceLineNo">2380</span> * }<a name="line.2380"></a> |
| <span class="sourceLineNo">2381</span> * </p><a name="line.2381"></a> |
| <span class="sourceLineNo">2382</span> *<a name="line.2382"></a> |
| <span class="sourceLineNo">2383</span> * <ul class='notes'><a name="line.2383"></a> |
| <span class="sourceLineNo">2384</span> * <li><a name="line.2384"></a> |
| <span class="sourceLineNo">2385</span> * Unless overridden, resource resolvers are inherited from ascendant resources.<a name="line.2385"></a> |
| <span class="sourceLineNo">2386</span> * <li><a name="line.2386"></a> |
| <span class="sourceLineNo">2387</span> * The resource class itself will be used if it implements the {@link RestResourceResolver} interface and not<a name="line.2387"></a> |
| <span class="sourceLineNo">2388</span> * explicitly overridden via this annotation.<a name="line.2388"></a> |
| <span class="sourceLineNo">2389</span> * <li><a name="line.2389"></a> |
| <span class="sourceLineNo">2390</span> * The {@link RestServlet} and {@link BasicRest} classes implement the {@link RestResourceResolver} interface with the same<a name="line.2390"></a> |
| <span class="sourceLineNo">2391</span> * functionality as {@link BasicRestResourceResolver} that gets used if not overridden by this annotation.<a name="line.2391"></a> |
| <span class="sourceLineNo">2392</span> * <br>Subclasses can also alter the behavior by overriding these methods.<a name="line.2392"></a> |
| <span class="sourceLineNo">2393</span> * <li><a name="line.2393"></a> |
| <span class="sourceLineNo">2394</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.2394"></a> |
| <span class="sourceLineNo">2395</span> * <ul><a name="line.2395"></a> |
| <span class="sourceLineNo">2396</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.2396"></a> |
| <span class="sourceLineNo">2397</span> * <li><code><jk>public</jk> T()</code><a name="line.2397"></a> |
| <span class="sourceLineNo">2398</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.2398"></a> |
| <span class="sourceLineNo">2399</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.2399"></a> |
| <span class="sourceLineNo">2400</span> * </ul><a name="line.2400"></a> |
| <span class="sourceLineNo">2401</span> * <li><a name="line.2401"></a> |
| <span class="sourceLineNo">2402</span> * Inner classes of the REST resource class are allowed.<a name="line.2402"></a> |
| <span class="sourceLineNo">2403</span> * </ul><a name="line.2403"></a> |
| <span class="sourceLineNo">2404</span> *<a name="line.2404"></a> |
| <span class="sourceLineNo">2405</span> * <ul class='seealso'><a name="line.2405"></a> |
| <span class="sourceLineNo">2406</span> * <li class='link'>{@doc RestResourceResolvers}<a name="line.2406"></a> |
| <span class="sourceLineNo">2407</span> * <li class='link'>{@doc RestInjection}<a name="line.2407"></a> |
| <span class="sourceLineNo">2408</span> * </ul><a name="line.2408"></a> |
| <span class="sourceLineNo">2409</span> */<a name="line.2409"></a> |
| <span class="sourceLineNo">2410</span> public static final String REST_resourceResolver = PREFIX + ".resourceResolver.o";<a name="line.2410"></a> |
| <span class="sourceLineNo">2411</span><a name="line.2411"></a> |
| <span class="sourceLineNo">2412</span> /**<a name="line.2412"></a> |
| <span class="sourceLineNo">2413</span> * Configuration property: Response handlers.<a name="line.2413"></a> |
| <span class="sourceLineNo">2414</span> *<a name="line.2414"></a> |
| <span class="sourceLineNo">2415</span> * <h5 class='section'>Property:</h5><a name="line.2415"></a> |
| <span class="sourceLineNo">2416</span> * <ul class='spaced-list'><a name="line.2416"></a> |
| <span class="sourceLineNo">2417</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_responseHandlers REST_responseHandlers}<a name="line.2417"></a> |
| <span class="sourceLineNo">2418</span> * <li><b>Name:</b> <js>"RestContext.responseHandlers.lo"</js><a name="line.2418"></a> |
| <span class="sourceLineNo">2419</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.rest.ResponseHandler}|Class&lt;{@link org.apache.juneau.rest.ResponseHandler}&gt;&gt;</c><a name="line.2419"></a> |
| <span class="sourceLineNo">2420</span> * <li><b>Default:</b> empty list<a name="line.2420"></a> |
| <span class="sourceLineNo">2421</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2421"></a> |
| <span class="sourceLineNo">2422</span> * <li><b>Annotations:</b><a name="line.2422"></a> |
| <span class="sourceLineNo">2423</span> * <ul><a name="line.2423"></a> |
| <span class="sourceLineNo">2424</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#responseHandlers()}<a name="line.2424"></a> |
| <span class="sourceLineNo">2425</span> * </ul><a name="line.2425"></a> |
| <span class="sourceLineNo">2426</span> * <li><b>Methods:</b><a name="line.2426"></a> |
| <span class="sourceLineNo">2427</span> * <ul><a name="line.2427"></a> |
| <span class="sourceLineNo">2428</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#responseHandlers(Class...)}<a name="line.2428"></a> |
| <span class="sourceLineNo">2429</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#responseHandlers(ResponseHandler...)}<a name="line.2429"></a> |
| <span class="sourceLineNo">2430</span> * </ul><a name="line.2430"></a> |
| <span class="sourceLineNo">2431</span> * </ul><a name="line.2431"></a> |
| <span class="sourceLineNo">2432</span> *<a name="line.2432"></a> |
| <span class="sourceLineNo">2433</span> * <h5 class='section'>Description:</h5><a name="line.2433"></a> |
| <span class="sourceLineNo">2434</span> * <p><a name="line.2434"></a> |
| <span class="sourceLineNo">2435</span> * Specifies a list of {@link ResponseHandler} classes that know how to convert POJOs returned by REST methods or<a name="line.2435"></a> |
| <span class="sourceLineNo">2436</span> * set via {@link RestResponse#setOutput(Object)} into appropriate HTTP responses.<a name="line.2436"></a> |
| <span class="sourceLineNo">2437</span> *<a name="line.2437"></a> |
| <span class="sourceLineNo">2438</span> * <p><a name="line.2438"></a> |
| <span class="sourceLineNo">2439</span> * By default, the following response handlers are provided out-of-the-box:<a name="line.2439"></a> |
| <span class="sourceLineNo">2440</span> * <ul><a name="line.2440"></a> |
| <span class="sourceLineNo">2441</span> * <li class='jc'>{@link ReaderHandler} - {@link Reader} objects.<a name="line.2441"></a> |
| <span class="sourceLineNo">2442</span> * <li class='jc'>{@link InputStreamHandler} - {@link InputStream} objects.<a name="line.2442"></a> |
| <span class="sourceLineNo">2443</span> * <li class='jc'>{@link DefaultHandler} - All other POJOs.<a name="line.2443"></a> |
| <span class="sourceLineNo">2444</span> * </ul><a name="line.2444"></a> |
| <span class="sourceLineNo">2445</span> *<a name="line.2445"></a> |
| <span class="sourceLineNo">2446</span> * <h5 class='section'>Example:</h5><a name="line.2446"></a> |
| <span class="sourceLineNo">2447</span> * <p class='bcode w800'><a name="line.2447"></a> |
| <span class="sourceLineNo">2448</span> * <jc>// Our custom response handler for MySpecialObject objects. </jc><a name="line.2448"></a> |
| <span class="sourceLineNo">2449</span> * <jk>public class</jk> MyResponseHandler <jk>implements</jk> ResponseHandler {<a name="line.2449"></a> |
| <span class="sourceLineNo">2450</span> *<a name="line.2450"></a> |
| <span class="sourceLineNo">2451</span> * <ja>@Override</ja><a name="line.2451"></a> |
| <span class="sourceLineNo">2452</span> * <jk>public boolean</jk> handle(RestRequest req, RestResponse res, Object output) <jk>throws</jk> IOException, RestException {<a name="line.2452"></a> |
| <span class="sourceLineNo">2453</span> * <jk>if</jk> (output <jk>instanceof</jk> MySpecialObject) {<a name="line.2453"></a> |
| <span class="sourceLineNo">2454</span> * <jk>try</jk> (Writer w = res.getNegotiatedWriter()) {<a name="line.2454"></a> |
| <span class="sourceLineNo">2455</span> * <jc>//Pipe it to the writer ourselves.</jc><a name="line.2455"></a> |
| <span class="sourceLineNo">2456</span> * }<a name="line.2456"></a> |
| <span class="sourceLineNo">2457</span> * <jk>return true</jk>; <jc>// We handled it.</jc><a name="line.2457"></a> |
| <span class="sourceLineNo">2458</span> * }<a name="line.2458"></a> |
| <span class="sourceLineNo">2459</span> * <jk>return false</jk>; <jc>// We didn't handle it.</jc><a name="line.2459"></a> |
| <span class="sourceLineNo">2460</span> * }<a name="line.2460"></a> |
| <span class="sourceLineNo">2461</span> * }<a name="line.2461"></a> |
| <span class="sourceLineNo">2462</span> *<a name="line.2462"></a> |
| <span class="sourceLineNo">2463</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.2463"></a> |
| <span class="sourceLineNo">2464</span> * <ja>@Rest</ja>(responseHandlers=MyResponseHandler.<jk>class</jk>)<a name="line.2464"></a> |
| <span class="sourceLineNo">2465</span> * <jk>public class</jk> MyResource {<a name="line.2465"></a> |
| <span class="sourceLineNo">2466</span> *<a name="line.2466"></a> |
| <span class="sourceLineNo">2467</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2467"></a> |
| <span class="sourceLineNo">2468</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2468"></a> |
| <span class="sourceLineNo">2469</span> *<a name="line.2469"></a> |
| <span class="sourceLineNo">2470</span> * <jc>// Using method on builder.</jc><a name="line.2470"></a> |
| <span class="sourceLineNo">2471</span> * builder.responseHandlers(MyResponseHandler.<jk>class</jk>);<a name="line.2471"></a> |
| <span class="sourceLineNo">2472</span> *<a name="line.2472"></a> |
| <span class="sourceLineNo">2473</span> * <jc>// Same, but using property.</jc><a name="line.2473"></a> |
| <span class="sourceLineNo">2474</span> * builder.addTo(<jsf>REST_responseHandlers</jsf>, MyResponseHandler.<jk>class</jk>);<a name="line.2474"></a> |
| <span class="sourceLineNo">2475</span> * }<a name="line.2475"></a> |
| <span class="sourceLineNo">2476</span> *<a name="line.2476"></a> |
| <span class="sourceLineNo">2477</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2477"></a> |
| <span class="sourceLineNo">2478</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2478"></a> |
| <span class="sourceLineNo">2479</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2479"></a> |
| <span class="sourceLineNo">2480</span> * builder.responseHandlers(MyResponseHandler.<jk>class</jk>);<a name="line.2480"></a> |
| <span class="sourceLineNo">2481</span> * }<a name="line.2481"></a> |
| <span class="sourceLineNo">2482</span> *<a name="line.2482"></a> |
| <span class="sourceLineNo">2483</span> * <ja>@RestMethod</ja>(...)<a name="line.2483"></a> |
| <span class="sourceLineNo">2484</span> * <jk>public</jk> Object myMethod() {<a name="line.2484"></a> |
| <span class="sourceLineNo">2485</span> * <jc>// Return a special object for our handler.</jc><a name="line.2485"></a> |
| <span class="sourceLineNo">2486</span> * <jk>return new</jk> MySpecialObject();<a name="line.2486"></a> |
| <span class="sourceLineNo">2487</span> * }<a name="line.2487"></a> |
| <span class="sourceLineNo">2488</span> * }<a name="line.2488"></a> |
| <span class="sourceLineNo">2489</span> * </p><a name="line.2489"></a> |
| <span class="sourceLineNo">2490</span> *<a name="line.2490"></a> |
| <span class="sourceLineNo">2491</span> * <ul class='notes'><a name="line.2491"></a> |
| <span class="sourceLineNo">2492</span> * <li><a name="line.2492"></a> |
| <span class="sourceLineNo">2493</span> * Response handlers resolvers are always inherited from ascendant resources.<a name="line.2493"></a> |
| <span class="sourceLineNo">2494</span> * <li><a name="line.2494"></a> |
| <span class="sourceLineNo">2495</span> * When defined as a class, the implementation must have one of the following constructors:<a name="line.2495"></a> |
| <span class="sourceLineNo">2496</span> * <ul><a name="line.2496"></a> |
| <span class="sourceLineNo">2497</span> * <li><code><jk>public</jk> T(RestContext)</code><a name="line.2497"></a> |
| <span class="sourceLineNo">2498</span> * <li><code><jk>public</jk> T()</code><a name="line.2498"></a> |
| <span class="sourceLineNo">2499</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>(RestContext)</code><a name="line.2499"></a> |
| <span class="sourceLineNo">2500</span> * <li><code><jk>public static</jk> T <jsm>create</jsm>()</code><a name="line.2500"></a> |
| <span class="sourceLineNo">2501</span> * </ul><a name="line.2501"></a> |
| <span class="sourceLineNo">2502</span> * <li><a name="line.2502"></a> |
| <span class="sourceLineNo">2503</span> * Inner classes of the REST resource class are allowed.<a name="line.2503"></a> |
| <span class="sourceLineNo">2504</span> * </ul><a name="line.2504"></a> |
| <span class="sourceLineNo">2505</span> */<a name="line.2505"></a> |
| <span class="sourceLineNo">2506</span> public static final String REST_responseHandlers = PREFIX + ".responseHandlers.lo";<a name="line.2506"></a> |
| <span class="sourceLineNo">2507</span><a name="line.2507"></a> |
| <span class="sourceLineNo">2508</span> /**<a name="line.2508"></a> |
| <span class="sourceLineNo">2509</span> * Configuration property: Declared roles.<a name="line.2509"></a> |
| <span class="sourceLineNo">2510</span> *<a name="line.2510"></a> |
| <span class="sourceLineNo">2511</span> * <h5 class='section'>Property:</h5><a name="line.2511"></a> |
| <span class="sourceLineNo">2512</span> * <ul class='spaced-list'><a name="line.2512"></a> |
| <span class="sourceLineNo">2513</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_rolesDeclared REST_rolesDeclared}<a name="line.2513"></a> |
| <span class="sourceLineNo">2514</span> * <li><b>Name:</b> <js>"RestContext.rolesDeclared.ss"</js><a name="line.2514"></a> |
| <span class="sourceLineNo">2515</span> * <li><b>Data type:</b> <c>Set&lt;String&gt;</c><a name="line.2515"></a> |
| <span class="sourceLineNo">2516</span> * <li><b>System property:</b> <c>RestContext.rolesDeclared</c><a name="line.2516"></a> |
| <span class="sourceLineNo">2517</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ROLESDECLARED</c><a name="line.2517"></a> |
| <span class="sourceLineNo">2518</span> * <li><b>Default:</b> empty list<a name="line.2518"></a> |
| <span class="sourceLineNo">2519</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2519"></a> |
| <span class="sourceLineNo">2520</span> * <li><b>Annotations:</b><a name="line.2520"></a> |
| <span class="sourceLineNo">2521</span> * <ul><a name="line.2521"></a> |
| <span class="sourceLineNo">2522</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#rolesDeclared()}<a name="line.2522"></a> |
| <span class="sourceLineNo">2523</span> * </ul><a name="line.2523"></a> |
| <span class="sourceLineNo">2524</span> * <li><b>Methods:</b><a name="line.2524"></a> |
| <span class="sourceLineNo">2525</span> * <ul><a name="line.2525"></a> |
| <span class="sourceLineNo">2526</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#rolesDeclared(String...)}<a name="line.2526"></a> |
| <span class="sourceLineNo">2527</span> * </ul><a name="line.2527"></a> |
| <span class="sourceLineNo">2528</span> * </ul><a name="line.2528"></a> |
| <span class="sourceLineNo">2529</span> *<a name="line.2529"></a> |
| <span class="sourceLineNo">2530</span> *<a name="line.2530"></a> |
| <span class="sourceLineNo">2531</span> * <h5 class='section'>Description:</h5><a name="line.2531"></a> |
| <span class="sourceLineNo">2532</span> * <p><a name="line.2532"></a> |
| <span class="sourceLineNo">2533</span> * A comma-delimited list of all possible user roles.<a name="line.2533"></a> |
| <span class="sourceLineNo">2534</span> *<a name="line.2534"></a> |
| <span class="sourceLineNo">2535</span> * <p><a name="line.2535"></a> |
| <span class="sourceLineNo">2536</span> * Used in conjunction with {@link RestContextBuilder#roleGuard(String)} is used with patterns.<a name="line.2536"></a> |
| <span class="sourceLineNo">2537</span> *<a name="line.2537"></a> |
| <span class="sourceLineNo">2538</span> * <h5 class='section'>Example:</h5><a name="line.2538"></a> |
| <span class="sourceLineNo">2539</span> * <p class='bcode w800'><a name="line.2539"></a> |
| <span class="sourceLineNo">2540</span> * <ja>@Rest</ja>(<a name="line.2540"></a> |
| <span class="sourceLineNo">2541</span> * rolesDeclared=<js>"ROLE_ADMIN,ROLE_READ_WRITE,ROLE_READ_ONLY,ROLE_SPECIAL"</js>,<a name="line.2541"></a> |
| <span class="sourceLineNo">2542</span> * roleGuard=<js>"ROLE_ADMIN || (ROLE_READ_WRITE &amp;&amp; ROLE_SPECIAL)"</js><a name="line.2542"></a> |
| <span class="sourceLineNo">2543</span> * )<a name="line.2543"></a> |
| <span class="sourceLineNo">2544</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.2544"></a> |
| <span class="sourceLineNo">2545</span> * ...<a name="line.2545"></a> |
| <span class="sourceLineNo">2546</span> * }<a name="line.2546"></a> |
| <span class="sourceLineNo">2547</span> * </p><a name="line.2547"></a> |
| <span class="sourceLineNo">2548</span> *<a name="line.2548"></a> |
| <span class="sourceLineNo">2549</span> * <ul class='seealso'><a name="line.2549"></a> |
| <span class="sourceLineNo">2550</span> * <li class='jf'>{@link RestContext#REST_rolesDeclared}<a name="line.2550"></a> |
| <span class="sourceLineNo">2551</span> * </ul><a name="line.2551"></a> |
| <span class="sourceLineNo">2552</span> */<a name="line.2552"></a> |
| <span class="sourceLineNo">2553</span> public static final String REST_rolesDeclared = PREFIX + ".rolesDeclared.ss";<a name="line.2553"></a> |
| <span class="sourceLineNo">2554</span><a name="line.2554"></a> |
| <span class="sourceLineNo">2555</span> /**<a name="line.2555"></a> |
| <span class="sourceLineNo">2556</span> * Configuration property: Role guard.<a name="line.2556"></a> |
| <span class="sourceLineNo">2557</span> *<a name="line.2557"></a> |
| <span class="sourceLineNo">2558</span> * <h5 class='section'>Property:</h5><a name="line.2558"></a> |
| <span class="sourceLineNo">2559</span> * <ul class='spaced-list'><a name="line.2559"></a> |
| <span class="sourceLineNo">2560</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_roleGuard REST_roleGuard}<a name="line.2560"></a> |
| <span class="sourceLineNo">2561</span> * <li><b>Name:</b> <js>"RestContext.roleGuard.ss"</js><a name="line.2561"></a> |
| <span class="sourceLineNo">2562</span> * <li><b>Data type:</b> <c>Set&lt;String&gt;</c><a name="line.2562"></a> |
| <span class="sourceLineNo">2563</span> * <li><b>System property:</b> <c>RestContext.roleGuard</c><a name="line.2563"></a> |
| <span class="sourceLineNo">2564</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_ROLEGUARD</c><a name="line.2564"></a> |
| <span class="sourceLineNo">2565</span> * <li><b>Default:</b> empty set<a name="line.2565"></a> |
| <span class="sourceLineNo">2566</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2566"></a> |
| <span class="sourceLineNo">2567</span> * <li><b>Annotations:</b><a name="line.2567"></a> |
| <span class="sourceLineNo">2568</span> * <ul><a name="line.2568"></a> |
| <span class="sourceLineNo">2569</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#roleGuard()}<a name="line.2569"></a> |
| <span class="sourceLineNo">2570</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#roleGuard()}<a name="line.2570"></a> |
| <span class="sourceLineNo">2571</span> * </ul><a name="line.2571"></a> |
| <span class="sourceLineNo">2572</span> * <li><b>Methods:</b><a name="line.2572"></a> |
| <span class="sourceLineNo">2573</span> * <ul><a name="line.2573"></a> |
| <span class="sourceLineNo">2574</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#roleGuard(String)}<a name="line.2574"></a> |
| <span class="sourceLineNo">2575</span> * </ul><a name="line.2575"></a> |
| <span class="sourceLineNo">2576</span> * </ul><a name="line.2576"></a> |
| <span class="sourceLineNo">2577</span> *<a name="line.2577"></a> |
| <span class="sourceLineNo">2578</span> * <h5 class='section'>Description:</h5><a name="line.2578"></a> |
| <span class="sourceLineNo">2579</span> * <p><a name="line.2579"></a> |
| <span class="sourceLineNo">2580</span> * An expression defining if a user with the specified roles are allowed to access methods on this class.<a name="line.2580"></a> |
| <span class="sourceLineNo">2581</span> *<a name="line.2581"></a> |
| <span class="sourceLineNo">2582</span> * <h5 class='section'>Example:</h5><a name="line.2582"></a> |
| <span class="sourceLineNo">2583</span> * <p class='bcode w800'><a name="line.2583"></a> |
| <span class="sourceLineNo">2584</span> * <ja>@Rest</ja>(<a name="line.2584"></a> |
| <span class="sourceLineNo">2585</span> * path=<js>"/foo"</js>,<a name="line.2585"></a> |
| <span class="sourceLineNo">2586</span> * roleGuard=<js>"ROLE_ADMIN || (ROLE_READ_WRITE &amp;&amp; ROLE_SPECIAL)"</js><a name="line.2586"></a> |
| <span class="sourceLineNo">2587</span> * )<a name="line.2587"></a> |
| <span class="sourceLineNo">2588</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.2588"></a> |
| <span class="sourceLineNo">2589</span> * ...<a name="line.2589"></a> |
| <span class="sourceLineNo">2590</span> * }<a name="line.2590"></a> |
| <span class="sourceLineNo">2591</span> * </p><a name="line.2591"></a> |
| <span class="sourceLineNo">2592</span> *<a name="line.2592"></a> |
| <span class="sourceLineNo">2593</span> * <ul class='notes'><a name="line.2593"></a> |
| <span class="sourceLineNo">2594</span> * <li><a name="line.2594"></a> |
| <span class="sourceLineNo">2595</span> * Supports any of the following expression constructs:<a name="line.2595"></a> |
| <span class="sourceLineNo">2596</span> * <ul><a name="line.2596"></a> |
| <span class="sourceLineNo">2597</span> * <li><js>"foo"</js> - Single arguments.<a name="line.2597"></a> |
| <span class="sourceLineNo">2598</span> * <li><js>"foo,bar,baz"</js> - Multiple OR'ed arguments.<a name="line.2598"></a> |
| <span class="sourceLineNo">2599</span> * <li><js>"foo | bar | bqz"</js> - Multiple OR'ed arguments, pipe syntax.<a name="line.2599"></a> |
| <span class="sourceLineNo">2600</span> * <li><js>"foo || bar || bqz"</js> - Multiple OR'ed arguments, Java-OR syntax.<a name="line.2600"></a> |
| <span class="sourceLineNo">2601</span> * <li><js>"fo*"</js> - Patterns including <js>'*'</js> and <js>'?'</js>.<a name="line.2601"></a> |
| <span class="sourceLineNo">2602</span> * <li><js>"fo* &amp; *oo"</js> - Multiple AND'ed arguments, ampersand syntax.<a name="line.2602"></a> |
| <span class="sourceLineNo">2603</span> * <li><js>"fo* &amp;&amp; *oo"</js> - Multiple AND'ed arguments, Java-AND syntax.<a name="line.2603"></a> |
| <span class="sourceLineNo">2604</span> * <li><js>"fo* || (*oo || bar)"</js> - Parenthesis.<a name="line.2604"></a> |
| <span class="sourceLineNo">2605</span> * </ul><a name="line.2605"></a> |
| <span class="sourceLineNo">2606</span> * <li><a name="line.2606"></a> |
| <span class="sourceLineNo">2607</span> * AND operations take precedence over OR operations (as expected).<a name="line.2607"></a> |
| <span class="sourceLineNo">2608</span> * <li><a name="line.2608"></a> |
| <span class="sourceLineNo">2609</span> * Whitespace is ignored.<a name="line.2609"></a> |
| <span class="sourceLineNo">2610</span> * <li><a name="line.2610"></a> |
| <span class="sourceLineNo">2611</span> * <jk>null</jk> or empty expressions always match as <jk>false</jk>.<a name="line.2611"></a> |
| <span class="sourceLineNo">2612</span> * <li><a name="line.2612"></a> |
| <span class="sourceLineNo">2613</span> * If patterns are used, you must specify the list of declared roles using {@link Rest#rolesDeclared()} or {@link RestContext#REST_rolesDeclared}.<a name="line.2613"></a> |
| <span class="sourceLineNo">2614</span> * <li><a name="line.2614"></a> |
| <span class="sourceLineNo">2615</span> * Supports {@doc RestSvlVariables}<a name="line.2615"></a> |
| <span class="sourceLineNo">2616</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.2616"></a> |
| <span class="sourceLineNo">2617</span> * <li><a name="line.2617"></a> |
| <span class="sourceLineNo">2618</span> * Role guards defined at both the class and method level must both pass.<a name="line.2618"></a> |
| <span class="sourceLineNo">2619</span> * </ul><a name="line.2619"></a> |
| <span class="sourceLineNo">2620</span> *<a name="line.2620"></a> |
| <span class="sourceLineNo">2621</span> * <ul class='seealso'><a name="line.2621"></a> |
| <span class="sourceLineNo">2622</span> * <li class='jf'>{@link RestContext#REST_roleGuard}<a name="line.2622"></a> |
| <span class="sourceLineNo">2623</span> * </ul><a name="line.2623"></a> |
| <span class="sourceLineNo">2624</span> */<a name="line.2624"></a> |
| <span class="sourceLineNo">2625</span> public static final String REST_roleGuard = PREFIX + ".roleGuard.ss";<a name="line.2625"></a> |
| <span class="sourceLineNo">2626</span><a name="line.2626"></a> |
| <span class="sourceLineNo">2627</span> /**<a name="line.2627"></a> |
| <span class="sourceLineNo">2628</span> * Configuration property: Serializers.<a name="line.2628"></a> |
| <span class="sourceLineNo">2629</span> *<a name="line.2629"></a> |
| <span class="sourceLineNo">2630</span> * <h5 class='section'>Property:</h5><a name="line.2630"></a> |
| <span class="sourceLineNo">2631</span> * <ul class='spaced-list'><a name="line.2631"></a> |
| <span class="sourceLineNo">2632</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_serializers REST_serializers}<a name="line.2632"></a> |
| <span class="sourceLineNo">2633</span> * <li><b>Name:</b> <js>"RestContext.serializers.lo"</js><a name="line.2633"></a> |
| <span class="sourceLineNo">2634</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.serializer.Serializer}|Class&lt;{@link org.apache.juneau.serializer.Serializer}&gt;&gt;</c><a name="line.2634"></a> |
| <span class="sourceLineNo">2635</span> * <li><b>Default:</b> empty list<a name="line.2635"></a> |
| <span class="sourceLineNo">2636</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2636"></a> |
| <span class="sourceLineNo">2637</span> * <li><b>Annotations:</b><a name="line.2637"></a> |
| <span class="sourceLineNo">2638</span> * <ul><a name="line.2638"></a> |
| <span class="sourceLineNo">2639</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#serializers()}<a name="line.2639"></a> |
| <span class="sourceLineNo">2640</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#serializers()}<a name="line.2640"></a> |
| <span class="sourceLineNo">2641</span> * </ul><a name="line.2641"></a> |
| <span class="sourceLineNo">2642</span> * <li><b>Methods:</b><a name="line.2642"></a> |
| <span class="sourceLineNo">2643</span> * <ul><a name="line.2643"></a> |
| <span class="sourceLineNo">2644</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#serializers(Object...)}<a name="line.2644"></a> |
| <span class="sourceLineNo">2645</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#serializers(Class...)}<a name="line.2645"></a> |
| <span class="sourceLineNo">2646</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#serializersReplace(Object...)}<a name="line.2646"></a> |
| <span class="sourceLineNo">2647</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#serializersReplace(Class...)}<a name="line.2647"></a> |
| <span class="sourceLineNo">2648</span> * </ul><a name="line.2648"></a> |
| <span class="sourceLineNo">2649</span> * </ul><a name="line.2649"></a> |
| <span class="sourceLineNo">2650</span> *<a name="line.2650"></a> |
| <span class="sourceLineNo">2651</span> * <h5 class='section'>Description:</h5><a name="line.2651"></a> |
| <span class="sourceLineNo">2652</span> * <p><a name="line.2652"></a> |
| <span class="sourceLineNo">2653</span> * Adds class-level serializers to this resource.<a name="line.2653"></a> |
| <span class="sourceLineNo">2654</span> *<a name="line.2654"></a> |
| <span class="sourceLineNo">2655</span> * <p><a name="line.2655"></a> |
| <span class="sourceLineNo">2656</span> * Serializer are used to convert POJOs to HTTP response bodies.<a name="line.2656"></a> |
| <span class="sourceLineNo">2657</span> * <br>Any of the Juneau framework serializers can be used in this setting.<a name="line.2657"></a> |
| <span class="sourceLineNo">2658</span> * <br>The serializer selected is based on the request <c>Accept</c> header matched against the values returned by the following method<a name="line.2658"></a> |
| <span class="sourceLineNo">2659</span> * using a best-match algorithm:<a name="line.2659"></a> |
| <span class="sourceLineNo">2660</span> * <ul class='javatree'><a name="line.2660"></a> |
| <span class="sourceLineNo">2661</span> * <li class='jm'>{@link Serializer#getMediaTypeRanges()}<a name="line.2661"></a> |
| <span class="sourceLineNo">2662</span> * </ul><a name="line.2662"></a> |
| <span class="sourceLineNo">2663</span> *<a name="line.2663"></a> |
| <span class="sourceLineNo">2664</span> * <h5 class='section'>Example:</h5><a name="line.2664"></a> |
| <span class="sourceLineNo">2665</span> * <p class='bcode w800'><a name="line.2665"></a> |
| <span class="sourceLineNo">2666</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.2666"></a> |
| <span class="sourceLineNo">2667</span> * <ja>@Rest</ja>(serializers={JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>})<a name="line.2667"></a> |
| <span class="sourceLineNo">2668</span> * <jk>public class</jk> MyResource {<a name="line.2668"></a> |
| <span class="sourceLineNo">2669</span> *<a name="line.2669"></a> |
| <span class="sourceLineNo">2670</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2670"></a> |
| <span class="sourceLineNo">2671</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2671"></a> |
| <span class="sourceLineNo">2672</span> *<a name="line.2672"></a> |
| <span class="sourceLineNo">2673</span> * <jc>// Using method on builder.</jc><a name="line.2673"></a> |
| <span class="sourceLineNo">2674</span> * builder.serializers(JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>);<a name="line.2674"></a> |
| <span class="sourceLineNo">2675</span> *<a name="line.2675"></a> |
| <span class="sourceLineNo">2676</span> * <jc>// Same, but use pre-instantiated parsers.</jc><a name="line.2676"></a> |
| <span class="sourceLineNo">2677</span> * builder.serializers(JsonSerializer.<jsf>DEFAULT</jsf>, XmlSerializer.<jsf>DEFAULT</jsf>);<a name="line.2677"></a> |
| <span class="sourceLineNo">2678</span> *<a name="line.2678"></a> |
| <span class="sourceLineNo">2679</span> * <jc>// Same, but using property.</jc><a name="line.2679"></a> |
| <span class="sourceLineNo">2680</span> * builder.set(<jsf>REST_serializers</jsf>, JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>);<a name="line.2680"></a> |
| <span class="sourceLineNo">2681</span> * }<a name="line.2681"></a> |
| <span class="sourceLineNo">2682</span> *<a name="line.2682"></a> |
| <span class="sourceLineNo">2683</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2683"></a> |
| <span class="sourceLineNo">2684</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2684"></a> |
| <span class="sourceLineNo">2685</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2685"></a> |
| <span class="sourceLineNo">2686</span> * builder.serializers(JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>);<a name="line.2686"></a> |
| <span class="sourceLineNo">2687</span> * }<a name="line.2687"></a> |
| <span class="sourceLineNo">2688</span> *<a name="line.2688"></a> |
| <span class="sourceLineNo">2689</span> * <jc>// Override at the method level.</jc><a name="line.2689"></a> |
| <span class="sourceLineNo">2690</span> * <ja>@RestMethod</ja>(serializers={HtmlSerializer.<jk>class</jk>})<a name="line.2690"></a> |
| <span class="sourceLineNo">2691</span> * <jk>public</jk> MyPojo myMethod() {<a name="line.2691"></a> |
| <span class="sourceLineNo">2692</span> * <jc>// Return a POJO to be serialized.</jc><a name="line.2692"></a> |
| <span class="sourceLineNo">2693</span> * <jk>return new</jk> MyPojo();<a name="line.2693"></a> |
| <span class="sourceLineNo">2694</span> * }<a name="line.2694"></a> |
| <span class="sourceLineNo">2695</span> * }<a name="line.2695"></a> |
| <span class="sourceLineNo">2696</span> * </p><a name="line.2696"></a> |
| <span class="sourceLineNo">2697</span> *<a name="line.2697"></a> |
| <span class="sourceLineNo">2698</span> * <ul class='notes'><a name="line.2698"></a> |
| <span class="sourceLineNo">2699</span> * <li><a name="line.2699"></a> |
| <span class="sourceLineNo">2700</span> * When defined as a class, properties/transforms defined on the resource/method are inherited.<a name="line.2700"></a> |
| <span class="sourceLineNo">2701</span> * <li><a name="line.2701"></a> |
| <span class="sourceLineNo">2702</span> * When defined as an instance, properties/transforms defined on the resource/method are NOT inherited.<a name="line.2702"></a> |
| <span class="sourceLineNo">2703</span> * <li><a name="line.2703"></a> |
| <span class="sourceLineNo">2704</span> * Typically, you'll want your resource to extend directly from {@link BasicRestServlet} which comes<a name="line.2704"></a> |
| <span class="sourceLineNo">2705</span> * preconfigured with the following serializers:<a name="line.2705"></a> |
| <span class="sourceLineNo">2706</span> * <ul><a name="line.2706"></a> |
| <span class="sourceLineNo">2707</span> * <li class='jc'>{@link HtmlDocSerializer}<a name="line.2707"></a> |
| <span class="sourceLineNo">2708</span> * <li class='jc'>{@link HtmlStrippedDocSerializer}<a name="line.2708"></a> |
| <span class="sourceLineNo">2709</span> * <li class='jc'>{@link HtmlSchemaDocSerializer}<a name="line.2709"></a> |
| <span class="sourceLineNo">2710</span> * <li class='jc'>{@link JsonSerializer}<a name="line.2710"></a> |
| <span class="sourceLineNo">2711</span> * <li class='jc'>{@link SimpleJsonSerializer}<a name="line.2711"></a> |
| <span class="sourceLineNo">2712</span> * <li class='jc'>{@link JsonSchemaSerializer}<a name="line.2712"></a> |
| <span class="sourceLineNo">2713</span> * <li class='jc'>{@link XmlDocSerializer}<a name="line.2713"></a> |
| <span class="sourceLineNo">2714</span> * <li class='jc'>{@link UonSerializer}<a name="line.2714"></a> |
| <span class="sourceLineNo">2715</span> * <li class='jc'>{@link UrlEncodingSerializer}<a name="line.2715"></a> |
| <span class="sourceLineNo">2716</span> * <li class='jc'>{@link MsgPackSerializer}<a name="line.2716"></a> |
| <span class="sourceLineNo">2717</span> * <li class='jc'>{@link SoapXmlSerializer}<a name="line.2717"></a> |
| <span class="sourceLineNo">2718</span> * <li class='jc'>{@link PlainTextSerializer}<a name="line.2718"></a> |
| <span class="sourceLineNo">2719</span> * </ul><a name="line.2719"></a> |
| <span class="sourceLineNo">2720</span> * </ul><a name="line.2720"></a> |
| <span class="sourceLineNo">2721</span> *<a name="line.2721"></a> |
| <span class="sourceLineNo">2722</span> * <ul class='seealso'><a name="line.2722"></a> |
| <span class="sourceLineNo">2723</span> * <li class='link'>{@doc RestSerializers}<a name="line.2723"></a> |
| <span class="sourceLineNo">2724</span> * </ul><a name="line.2724"></a> |
| <span class="sourceLineNo">2725</span> * <p><a name="line.2725"></a> |
| <span class="sourceLineNo">2726</span> */<a name="line.2726"></a> |
| <span class="sourceLineNo">2727</span> public static final String REST_serializers = PREFIX + ".serializers.lo";<a name="line.2727"></a> |
| <span class="sourceLineNo">2728</span><a name="line.2728"></a> |
| <span class="sourceLineNo">2729</span> /**<a name="line.2729"></a> |
| <span class="sourceLineNo">2730</span> * Configuration property: Static file response headers.<a name="line.2730"></a> |
| <span class="sourceLineNo">2731</span> *<a name="line.2731"></a> |
| <span class="sourceLineNo">2732</span> * <h5 class='section'>Property:</h5><a name="line.2732"></a> |
| <span class="sourceLineNo">2733</span> * <ul class='spaced-list'><a name="line.2733"></a> |
| <span class="sourceLineNo">2734</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_staticFileResponseHeaders REST_staticFileResponseHeaders}<a name="line.2734"></a> |
| <span class="sourceLineNo">2735</span> * <li><b>Name:</b> <js>"RestContext.staticFileResponseHeaders.omo"</js><a name="line.2735"></a> |
| <span class="sourceLineNo">2736</span> * <li><b>Data type:</b> <c>Map&lt;String,String&gt;</c><a name="line.2736"></a> |
| <span class="sourceLineNo">2737</span> * <li><b>System property:</b> <c>RestContext.staticFileResponseHeaders</c><a name="line.2737"></a> |
| <span class="sourceLineNo">2738</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_STATICFILERESPONSEHEADERS</c><a name="line.2738"></a> |
| <span class="sourceLineNo">2739</span> * <li><b>Default:</b> <code>{<js>'Cache-Control'</js>: <js>'max-age=86400, public</js>}</code><a name="line.2739"></a> |
| <span class="sourceLineNo">2740</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2740"></a> |
| <span class="sourceLineNo">2741</span> * <li><b>Annotations:</b><a name="line.2741"></a> |
| <span class="sourceLineNo">2742</span> * <ul><a name="line.2742"></a> |
| <span class="sourceLineNo">2743</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#staticFileResponseHeaders()}<a name="line.2743"></a> |
| <span class="sourceLineNo">2744</span> * </ul><a name="line.2744"></a> |
| <span class="sourceLineNo">2745</span> * <li><b>Methods:</b><a name="line.2745"></a> |
| <span class="sourceLineNo">2746</span> * <ul><a name="line.2746"></a> |
| <span class="sourceLineNo">2747</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFileResponseHeaders(Map)}<a name="line.2747"></a> |
| <span class="sourceLineNo">2748</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFileResponseHeaders(String...)}<a name="line.2748"></a> |
| <span class="sourceLineNo">2749</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFileResponseHeader(String,String)}<a name="line.2749"></a> |
| <span class="sourceLineNo">2750</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFileResponseHeadersReplace(Map)}<a name="line.2750"></a> |
| <span class="sourceLineNo">2751</span> * </ul><a name="line.2751"></a> |
| <span class="sourceLineNo">2752</span> * </ul><a name="line.2752"></a> |
| <span class="sourceLineNo">2753</span> *<a name="line.2753"></a> |
| <span class="sourceLineNo">2754</span> * <h5 class='section'>Description:</h5><a name="line.2754"></a> |
| <span class="sourceLineNo">2755</span> * <p><a name="line.2755"></a> |
| <span class="sourceLineNo">2756</span> * Used to customize the headers on responses returned for statically-served files.<a name="line.2756"></a> |
| <span class="sourceLineNo">2757</span> *<a name="line.2757"></a> |
| <span class="sourceLineNo">2758</span> * <h5 class='section'>Example:</h5><a name="line.2758"></a> |
| <span class="sourceLineNo">2759</span> * <p class='bcode w800'><a name="line.2759"></a> |
| <span class="sourceLineNo">2760</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.2760"></a> |
| <span class="sourceLineNo">2761</span> * <ja>@Rest</ja>(<a name="line.2761"></a> |
| <span class="sourceLineNo">2762</span> * staticFileResponseHeaders={<a name="line.2762"></a> |
| <span class="sourceLineNo">2763</span> * <js>"Cache-Control: $C{REST/cacheControl,nocache}"</js>,<a name="line.2763"></a> |
| <span class="sourceLineNo">2764</span> * <js>"My-Header: $C{REST/myHeaderValue}"</js><a name="line.2764"></a> |
| <span class="sourceLineNo">2765</span> * }<a name="line.2765"></a> |
| <span class="sourceLineNo">2766</span> * )<a name="line.2766"></a> |
| <span class="sourceLineNo">2767</span> * <jk>public class</jk> MyResource {<a name="line.2767"></a> |
| <span class="sourceLineNo">2768</span> *<a name="line.2768"></a> |
| <span class="sourceLineNo">2769</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2769"></a> |
| <span class="sourceLineNo">2770</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2770"></a> |
| <span class="sourceLineNo">2771</span> *<a name="line.2771"></a> |
| <span class="sourceLineNo">2772</span> * <jc>// Using method on builder.</jc><a name="line.2772"></a> |
| <span class="sourceLineNo">2773</span> * builder<a name="line.2773"></a> |
| <span class="sourceLineNo">2774</span> * .staticFileResponseHeader(<js>"Cache-Control"</js>, <js>"nocache"</js>);<a name="line.2774"></a> |
| <span class="sourceLineNo">2775</span> * .staticFileResponseHeaders(<js>"My-Header: foo"</js>);<a name="line.2775"></a> |
| <span class="sourceLineNo">2776</span> *<a name="line.2776"></a> |
| <span class="sourceLineNo">2777</span> * <jc>// Same, but using property.</jc><a name="line.2777"></a> |
| <span class="sourceLineNo">2778</span> * builder<a name="line.2778"></a> |
| <span class="sourceLineNo">2779</span> * .addTo(<jsf>REST_staticFileResponseHeaders</jsf>, <js>"Cache-Control"</js>, <js>"nocache"</js>);<a name="line.2779"></a> |
| <span class="sourceLineNo">2780</span> * .addTo(<jsf>REST_staticFileResponseHeaders</jsf>, <js>"My-Header"</js>, <js>"foo"</js>);<a name="line.2780"></a> |
| <span class="sourceLineNo">2781</span> * }<a name="line.2781"></a> |
| <span class="sourceLineNo">2782</span> *<a name="line.2782"></a> |
| <span class="sourceLineNo">2783</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2783"></a> |
| <span class="sourceLineNo">2784</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2784"></a> |
| <span class="sourceLineNo">2785</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2785"></a> |
| <span class="sourceLineNo">2786</span> * builder.staticFileResponseHeader(<js>"Cache-Control"</js>, <js>"nocache"</js>);<a name="line.2786"></a> |
| <span class="sourceLineNo">2787</span> * }<a name="line.2787"></a> |
| <span class="sourceLineNo">2788</span> * }<a name="line.2788"></a> |
| <span class="sourceLineNo">2789</span> * </p><a name="line.2789"></a> |
| <span class="sourceLineNo">2790</span> *<a name="line.2790"></a> |
| <span class="sourceLineNo">2791</span> * <p><a name="line.2791"></a> |
| <span class="sourceLineNo">2792</span> * Note that headers can also be specified per path-mapping via the {@link Rest#staticFiles() @Rest(staticFiles)} annotation.<a name="line.2792"></a> |
| <span class="sourceLineNo">2793</span> * <p class='bcode w800'><a name="line.2793"></a> |
| <span class="sourceLineNo">2794</span> * <ja>@Rest</ja>(<a name="line.2794"></a> |
| <span class="sourceLineNo">2795</span> * staticFiles={<a name="line.2795"></a> |
| <span class="sourceLineNo">2796</span> * <js>"htdocs:docs:{'Cache-Control':'max-age=86400, public'}"</js><a name="line.2796"></a> |
| <span class="sourceLineNo">2797</span> * }<a name="line.2797"></a> |
| <span class="sourceLineNo">2798</span> * )<a name="line.2798"></a> |
| <span class="sourceLineNo">2799</span> * </p><a name="line.2799"></a> |
| <span class="sourceLineNo">2800</span> *<a name="line.2800"></a> |
| <span class="sourceLineNo">2801</span> * <ul class='seealso'><a name="line.2801"></a> |
| <span class="sourceLineNo">2802</span> * <li class='jf'>{@link #REST_staticFiles} for information about statically-served files.<a name="line.2802"></a> |
| <span class="sourceLineNo">2803</span> * </ul><a name="line.2803"></a> |
| <span class="sourceLineNo">2804</span> */<a name="line.2804"></a> |
| <span class="sourceLineNo">2805</span> public static final String REST_staticFileResponseHeaders = PREFIX + ".staticFileResponseHeaders.omo";<a name="line.2805"></a> |
| <span class="sourceLineNo">2806</span><a name="line.2806"></a> |
| <span class="sourceLineNo">2807</span> /**<a name="line.2807"></a> |
| <span class="sourceLineNo">2808</span> * Configuration property: Static file mappings.<a name="line.2808"></a> |
| <span class="sourceLineNo">2809</span> *<a name="line.2809"></a> |
| <span class="sourceLineNo">2810</span> * <h5 class='section'>Property:</h5><a name="line.2810"></a> |
| <span class="sourceLineNo">2811</span> * <ul class='spaced-list'><a name="line.2811"></a> |
| <span class="sourceLineNo">2812</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_staticFiles REST_staticFiles}<a name="line.2812"></a> |
| <span class="sourceLineNo">2813</span> * <li><b>Name:</b> <js>"RestContext.staticFiles.lo"</js><a name="line.2813"></a> |
| <span class="sourceLineNo">2814</span> * <li><b>Data type:</b> <c>List&lt;{@link org.apache.juneau.rest.StaticFileMapping}&gt;</c><a name="line.2814"></a> |
| <span class="sourceLineNo">2815</span> * <li><b>Default:</b> <jk>null</jk><a name="line.2815"></a> |
| <span class="sourceLineNo">2816</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2816"></a> |
| <span class="sourceLineNo">2817</span> * <li><b>Annotations:</b><a name="line.2817"></a> |
| <span class="sourceLineNo">2818</span> * <ul><a name="line.2818"></a> |
| <span class="sourceLineNo">2819</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#staticFiles()}<a name="line.2819"></a> |
| <span class="sourceLineNo">2820</span> * </ul><a name="line.2820"></a> |
| <span class="sourceLineNo">2821</span> * <li><b>Methods:</b><a name="line.2821"></a> |
| <span class="sourceLineNo">2822</span> * <ul><a name="line.2822"></a> |
| <span class="sourceLineNo">2823</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFiles(String)},<a name="line.2823"></a> |
| <span class="sourceLineNo">2824</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFiles(Class,String)}<a name="line.2824"></a> |
| <span class="sourceLineNo">2825</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFiles(String,String)}<a name="line.2825"></a> |
| <span class="sourceLineNo">2826</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFiles(Class,String,String)}<a name="line.2826"></a> |
| <span class="sourceLineNo">2827</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#staticFiles(StaticFileMapping...)}<a name="line.2827"></a> |
| <span class="sourceLineNo">2828</span> * </ul><a name="line.2828"></a> |
| <span class="sourceLineNo">2829</span> * </ul><a name="line.2829"></a> |
| <span class="sourceLineNo">2830</span> *<a name="line.2830"></a> |
| <span class="sourceLineNo">2831</span> * <h5 class='section'>Description:</h5><a name="line.2831"></a> |
| <span class="sourceLineNo">2832</span> * <p><a name="line.2832"></a> |
| <span class="sourceLineNo">2833</span> * Used to define paths and locations of statically-served files such as images or HTML documents<a name="line.2833"></a> |
| <span class="sourceLineNo">2834</span> * from the classpath or file system.<a name="line.2834"></a> |
| <span class="sourceLineNo">2835</span> *<a name="line.2835"></a> |
| <span class="sourceLineNo">2836</span> * <p><a name="line.2836"></a> |
| <span class="sourceLineNo">2837</span> * The format of the value is one of the following:<a name="line.2837"></a> |
| <span class="sourceLineNo">2838</span> * <ol class='spaced-list'><a name="line.2838"></a> |
| <span class="sourceLineNo">2839</span> * <li><js>"path:location"</js><a name="line.2839"></a> |
| <span class="sourceLineNo">2840</span> * <li><js>"path:location:headers"</js><a name="line.2840"></a> |
| <span class="sourceLineNo">2841</span> * </ol><a name="line.2841"></a> |
| <span class="sourceLineNo">2842</span> *<a name="line.2842"></a> |
| <span class="sourceLineNo">2843</span> * <p><a name="line.2843"></a> |
| <span class="sourceLineNo">2844</span> * An example where this class is used is in the {@link Rest#staticFiles} annotation:<a name="line.2844"></a> |
| <span class="sourceLineNo">2845</span> * <p class='bcode w800'><a name="line.2845"></a> |
| <span class="sourceLineNo">2846</span> * <jk>package</jk> com.foo.mypackage;<a name="line.2846"></a> |
| <span class="sourceLineNo">2847</span> *<a name="line.2847"></a> |
| <span class="sourceLineNo">2848</span> * <ja>@Rest</ja>(<a name="line.2848"></a> |
| <span class="sourceLineNo">2849</span> * path=<js>"/myresource"</js>,<a name="line.2849"></a> |
| <span class="sourceLineNo">2850</span> * staticFiles={<a name="line.2850"></a> |
| <span class="sourceLineNo">2851</span> * <js>"htdocs:docs"</js>,<a name="line.2851"></a> |
| <span class="sourceLineNo">2852</span> * <js>"styles:styles"</js><a name="line.2852"></a> |
| <span class="sourceLineNo">2853</span> * }<a name="line.2853"></a> |
| <span class="sourceLineNo">2854</span> * )<a name="line.2854"></a> |
| <span class="sourceLineNo">2855</span> * <jk>public class</jk> MyResource <jk>extends</jk> BasicRestServlet {...}<a name="line.2855"></a> |
| <span class="sourceLineNo">2856</span> * </p><a name="line.2856"></a> |
| <span class="sourceLineNo">2857</span> *<a name="line.2857"></a> |
| <span class="sourceLineNo">2858</span> * <p><a name="line.2858"></a> |
| <span class="sourceLineNo">2859</span> * In the example above, given a GET request to the following URL...<a name="line.2859"></a> |
| <span class="sourceLineNo">2860</span> * <p class='bcode w800'><a name="line.2860"></a> |
| <span class="sourceLineNo">2861</span> * /myresource/htdocs/foobar.html<a name="line.2861"></a> |
| <span class="sourceLineNo">2862</span> * </p><a name="line.2862"></a> |
| <span class="sourceLineNo">2863</span> * <br>...the servlet will attempt to find the <c>foobar.html</c> file in the following location:<a name="line.2863"></a> |
| <span class="sourceLineNo">2864</span> * <ol class='spaced-list'><a name="line.2864"></a> |
| <span class="sourceLineNo">2865</span> * <li><c>com.foo.mypackage.docs</c> package.<a name="line.2865"></a> |
| <span class="sourceLineNo">2866</span> * </ol><a name="line.2866"></a> |
| <span class="sourceLineNo">2867</span> *<a name="line.2867"></a> |
| <span class="sourceLineNo">2868</span> * <p><a name="line.2868"></a> |
| <span class="sourceLineNo">2869</span> * The location is interpreted as an absolute path if it starts with <js>'/'</js>.<a name="line.2869"></a> |
| <span class="sourceLineNo">2870</span> * <p class='bcode w800'><a name="line.2870"></a> |
| <span class="sourceLineNo">2871</span> * <ja>@Rest</ja>(<a name="line.2871"></a> |
| <span class="sourceLineNo">2872</span> * staticFiles={<a name="line.2872"></a> |
| <span class="sourceLineNo">2873</span> * <js>"htdocs:/docs"</js><a name="line.2873"></a> |
| <span class="sourceLineNo">2874</span> * }<a name="line.2874"></a> |
| <span class="sourceLineNo">2875</span> * )<a name="line.2875"></a> |
| <span class="sourceLineNo">2876</span> * </p><a name="line.2876"></a> |
| <span class="sourceLineNo">2877</span> * <p><a name="line.2877"></a> |
| <span class="sourceLineNo">2878</span> * In the example above, given a GET request to the following URL...<a name="line.2878"></a> |
| <span class="sourceLineNo">2879</span> * <p class='bcode w800'><a name="line.2879"></a> |
| <span class="sourceLineNo">2880</span> * /myresource/htdocs/foobar.html<a name="line.2880"></a> |
| <span class="sourceLineNo">2881</span> * </p><a name="line.2881"></a> |
| <span class="sourceLineNo">2882</span> * <br>...the servlet will attempt to find the <c>foobar.html</c> file in the following location:<a name="line.2882"></a> |
| <span class="sourceLineNo">2883</span> * <ol class='spaced-list'><a name="line.2883"></a> |
| <span class="sourceLineNo">2884</span> * <li><c>docs</c> package (typically under <c>src/main/resources/docs</c> in your workspace).<a name="line.2884"></a> |
| <span class="sourceLineNo">2885</span> * <li><c>[working-dir]/docs</c> directory at runtime.<a name="line.2885"></a> |
| <span class="sourceLineNo">2886</span> * </ol><a name="line.2886"></a> |
| <span class="sourceLineNo">2887</span> *<a name="line.2887"></a> |
| <span class="sourceLineNo">2888</span> * <p><a name="line.2888"></a> |
| <span class="sourceLineNo">2889</span> * Response headers can be specified for served files by adding a 3rd section that consists of a {@doc SimplifiedJson} object.<a name="line.2889"></a> |
| <span class="sourceLineNo">2890</span> * <p class='bcode w800'><a name="line.2890"></a> |
| <span class="sourceLineNo">2891</span> * <ja>@Rest</ja>(<a name="line.2891"></a> |
| <span class="sourceLineNo">2892</span> * staticFiles={<a name="line.2892"></a> |
| <span class="sourceLineNo">2893</span> * <js>"htdocs:docs:{'Cache-Control':'max-age=86400, public'}"</js><a name="line.2893"></a> |
| <span class="sourceLineNo">2894</span> * }<a name="line.2894"></a> |
| <span class="sourceLineNo">2895</span> * )<a name="line.2895"></a> |
| <span class="sourceLineNo">2896</span> * </p><a name="line.2896"></a> |
| <span class="sourceLineNo">2897</span> *<a name="line.2897"></a> |
| <span class="sourceLineNo">2898</span> * <p><a name="line.2898"></a> |
| <span class="sourceLineNo">2899</span> * The same path can map to multiple locations. Files are searched in the order<a name="line.2899"></a> |
| <span class="sourceLineNo">2900</span> * <p class='bcode w800'><a name="line.2900"></a> |
| <span class="sourceLineNo">2901</span> * <ja>@Rest</ja>(<a name="line.2901"></a> |
| <span class="sourceLineNo">2902</span> * staticFiles={<a name="line.2902"></a> |
| <span class="sourceLineNo">2903</span> * <jc>// Search in absolute location '/htdocs/folder' before location 'htdocs.package' relative to servlet package.</jc><a name="line.2903"></a> |
| <span class="sourceLineNo">2904</span> * <js>"htdocs:/htdocs/folder,htdocs:htdocs.package"</js><a name="line.2904"></a> |
| <span class="sourceLineNo">2905</span> * }<a name="line.2905"></a> |
| <span class="sourceLineNo">2906</span> * )<a name="line.2906"></a> |
| <span class="sourceLineNo">2907</span> * </p><a name="line.2907"></a> |
| <span class="sourceLineNo">2908</span> *<a name="line.2908"></a> |
| <span class="sourceLineNo">2909</span> * <ul class='seealso'><a name="line.2909"></a> |
| <span class="sourceLineNo">2910</span> * <li class='jf'>{@link #REST_classpathResourceFinder} for configuring how classpath resources are located and retrieved.<a name="line.2910"></a> |
| <span class="sourceLineNo">2911</span> * <li class='jf'>{@link #REST_mimeTypes} for configuring the media types based on file extension.<a name="line.2911"></a> |
| <span class="sourceLineNo">2912</span> * <li class='jf'>{@link #REST_staticFileResponseHeaders} for configuring response headers on statically served files.<a name="line.2912"></a> |
| <span class="sourceLineNo">2913</span> * <li class='jf'>{@link #REST_useClasspathResourceCaching} for configuring static file caching.<a name="line.2913"></a> |
| <span class="sourceLineNo">2914</span> * <li class='jm'>{@link RestContext#getClasspathResource(String,Locale)} for retrieving static files.<a name="line.2914"></a> |
| <span class="sourceLineNo">2915</span> * </ul><a name="line.2915"></a> |
| <span class="sourceLineNo">2916</span> *<a name="line.2916"></a> |
| <span class="sourceLineNo">2917</span> * <ul class='notes'><a name="line.2917"></a> |
| <span class="sourceLineNo">2918</span> * <li><a name="line.2918"></a> |
| <span class="sourceLineNo">2919</span> * Mappings are cumulative from super classes.<a name="line.2919"></a> |
| <span class="sourceLineNo">2920</span> * <li><a name="line.2920"></a> |
| <span class="sourceLineNo">2921</span> * Child resources can override mappings made on parent class resources.<a name="line.2921"></a> |
| <span class="sourceLineNo">2922</span> * <br>When both parent and child resources map against the same path, files will be search in the child location<a name="line.2922"></a> |
| <span class="sourceLineNo">2923</span> * and then the parent location.<a name="line.2923"></a> |
| <span class="sourceLineNo">2924</span> * </ul><a name="line.2924"></a> |
| <span class="sourceLineNo">2925</span> */<a name="line.2925"></a> |
| <span class="sourceLineNo">2926</span> public static final String REST_staticFiles = PREFIX + ".staticFiles.lo";<a name="line.2926"></a> |
| <span class="sourceLineNo">2927</span><a name="line.2927"></a> |
| <span class="sourceLineNo">2928</span> /**<a name="line.2928"></a> |
| <span class="sourceLineNo">2929</span> * Configuration property: Supported accept media types.<a name="line.2929"></a> |
| <span class="sourceLineNo">2930</span> *<a name="line.2930"></a> |
| <span class="sourceLineNo">2931</span> * <h5 class='section'>Property:</h5><a name="line.2931"></a> |
| <span class="sourceLineNo">2932</span> * <ul class='spaced-list'><a name="line.2932"></a> |
| <span class="sourceLineNo">2933</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_produces REST_produces}<a name="line.2933"></a> |
| <span class="sourceLineNo">2934</span> * <li><b>Name:</b> <js>"RestContext.produces.ls"</js><a name="line.2934"></a> |
| <span class="sourceLineNo">2935</span> * <li><b>Data type:</b> <c>List&lt;String&gt;</c><a name="line.2935"></a> |
| <span class="sourceLineNo">2936</span> * <li><b>System property:</b> <c>RestContext.produces</c><a name="line.2936"></a> |
| <span class="sourceLineNo">2937</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_PRODUCES</c><a name="line.2937"></a> |
| <span class="sourceLineNo">2938</span> * <li><b>Default:</b> empty list<a name="line.2938"></a> |
| <span class="sourceLineNo">2939</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.2939"></a> |
| <span class="sourceLineNo">2940</span> * <li><b>Annotations:</b><a name="line.2940"></a> |
| <span class="sourceLineNo">2941</span> * <ul><a name="line.2941"></a> |
| <span class="sourceLineNo">2942</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#produces()}<a name="line.2942"></a> |
| <span class="sourceLineNo">2943</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#produces()}<a name="line.2943"></a> |
| <span class="sourceLineNo">2944</span> * </ul><a name="line.2944"></a> |
| <span class="sourceLineNo">2945</span> * <li><b>Methods:</b><a name="line.2945"></a> |
| <span class="sourceLineNo">2946</span> * <ul><a name="line.2946"></a> |
| <span class="sourceLineNo">2947</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#produces(String...)}<a name="line.2947"></a> |
| <span class="sourceLineNo">2948</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#produces(MediaType...)}<a name="line.2948"></a> |
| <span class="sourceLineNo">2949</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#producesReplace(String...)}<a name="line.2949"></a> |
| <span class="sourceLineNo">2950</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#producesReplace(MediaType...)}<a name="line.2950"></a> |
| <span class="sourceLineNo">2951</span> * </ul><a name="line.2951"></a> |
| <span class="sourceLineNo">2952</span> * </ul><a name="line.2952"></a> |
| <span class="sourceLineNo">2953</span> *<a name="line.2953"></a> |
| <span class="sourceLineNo">2954</span> * <h5 class='section'>Description:</h5><a name="line.2954"></a> |
| <span class="sourceLineNo">2955</span> * <p><a name="line.2955"></a> |
| <span class="sourceLineNo">2956</span> * Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.<a name="line.2956"></a> |
| <span class="sourceLineNo">2957</span> * <br>An example where this might be useful if you have serializers registered that handle media types that you<a name="line.2957"></a> |
| <span class="sourceLineNo">2958</span> * don't want exposed in the Swagger documentation.<a name="line.2958"></a> |
| <span class="sourceLineNo">2959</span> *<a name="line.2959"></a> |
| <span class="sourceLineNo">2960</span> * <h5 class='section'>Example:</h5><a name="line.2960"></a> |
| <span class="sourceLineNo">2961</span> * <p class='bcode w800'><a name="line.2961"></a> |
| <span class="sourceLineNo">2962</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.2962"></a> |
| <span class="sourceLineNo">2963</span> * <ja>@Rest</ja>(produces={<js>"$C{REST/supportedProduces,application/json}"</js>})<a name="line.2963"></a> |
| <span class="sourceLineNo">2964</span> * <jk>public class</jk> MyResource {<a name="line.2964"></a> |
| <span class="sourceLineNo">2965</span> *<a name="line.2965"></a> |
| <span class="sourceLineNo">2966</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.2966"></a> |
| <span class="sourceLineNo">2967</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2967"></a> |
| <span class="sourceLineNo">2968</span> *<a name="line.2968"></a> |
| <span class="sourceLineNo">2969</span> * <jc>// Using method on builder.</jc><a name="line.2969"></a> |
| <span class="sourceLineNo">2970</span> * builder.produces(<jk>false</jk>, <js>"application/json"</js>)<a name="line.2970"></a> |
| <span class="sourceLineNo">2971</span> *<a name="line.2971"></a> |
| <span class="sourceLineNo">2972</span> * <jc>// Same, but using property.</jc><a name="line.2972"></a> |
| <span class="sourceLineNo">2973</span> * builder.set(<jsf>REST_produces</jsf>, <js>"application/json"</js>);<a name="line.2973"></a> |
| <span class="sourceLineNo">2974</span> * }<a name="line.2974"></a> |
| <span class="sourceLineNo">2975</span> *<a name="line.2975"></a> |
| <span class="sourceLineNo">2976</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.2976"></a> |
| <span class="sourceLineNo">2977</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.2977"></a> |
| <span class="sourceLineNo">2978</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.2978"></a> |
| <span class="sourceLineNo">2979</span> * builder.produces(<jk>false</jk>, <js>"application/json"</js>);<a name="line.2979"></a> |
| <span class="sourceLineNo">2980</span> * }<a name="line.2980"></a> |
| <span class="sourceLineNo">2981</span> * }<a name="line.2981"></a> |
| <span class="sourceLineNo">2982</span> * </p><a name="line.2982"></a> |
| <span class="sourceLineNo">2983</span> *<a name="line.2983"></a> |
| <span class="sourceLineNo">2984</span> * <p><a name="line.2984"></a> |
| <span class="sourceLineNo">2985</span> * This affects the returned values from the following:<a name="line.2985"></a> |
| <span class="sourceLineNo">2986</span> * <ul class='javatree'><a name="line.2986"></a> |
| <span class="sourceLineNo">2987</span> * <li class='jm'>{@link RestContext#getProduces() RestContext.getProduces()}<a name="line.2987"></a> |
| <span class="sourceLineNo">2988</span> * <li class='jm'>{@link RestRequest#getProduces()}<a name="line.2988"></a> |
| <span class="sourceLineNo">2989</span> * <li class='jm'>{@link RestInfoProvider#getSwagger(RestRequest)} - Affects produces field.<a name="line.2989"></a> |
| <span class="sourceLineNo">2990</span> * </ul><a name="line.2990"></a> |
| <span class="sourceLineNo">2991</span> */<a name="line.2991"></a> |
| <span class="sourceLineNo">2992</span> public static final String REST_produces = PREFIX + ".produces.ls";<a name="line.2992"></a> |
| <span class="sourceLineNo">2993</span><a name="line.2993"></a> |
| <span class="sourceLineNo">2994</span> /**<a name="line.2994"></a> |
| <span class="sourceLineNo">2995</span> * Configuration property: Properties.<a name="line.2995"></a> |
| <span class="sourceLineNo">2996</span> *<a name="line.2996"></a> |
| <span class="sourceLineNo">2997</span> * <h5 class='section'>Property:</h5><a name="line.2997"></a> |
| <span class="sourceLineNo">2998</span> * <ul class='spaced-list'><a name="line.2998"></a> |
| <span class="sourceLineNo">2999</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_properties REST_properties}<a name="line.2999"></a> |
| <span class="sourceLineNo">3000</span> * <li><b>Name:</b> <js>"RestContext.properties.sms"</js><a name="line.3000"></a> |
| <span class="sourceLineNo">3001</span> * <li><b>Data type:</b> <c>Map&lt;String,String&gt;</c><a name="line.3001"></a> |
| <span class="sourceLineNo">3002</span> * <li><b>System property:</b> <c>RestContext.properties</c><a name="line.3002"></a> |
| <span class="sourceLineNo">3003</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_PROPERTIES</c><a name="line.3003"></a> |
| <span class="sourceLineNo">3004</span> * <li><b>Default:</b> empty map<a name="line.3004"></a> |
| <span class="sourceLineNo">3005</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3005"></a> |
| <span class="sourceLineNo">3006</span> * <li><b>Annotations:</b><a name="line.3006"></a> |
| <span class="sourceLineNo">3007</span> * <ul><a name="line.3007"></a> |
| <span class="sourceLineNo">3008</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#properties()}<a name="line.3008"></a> |
| <span class="sourceLineNo">3009</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#flags()}<a name="line.3009"></a> |
| <span class="sourceLineNo">3010</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#properties()}<a name="line.3010"></a> |
| <span class="sourceLineNo">3011</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#flags()}<a name="line.3011"></a> |
| <span class="sourceLineNo">3012</span> * </ul><a name="line.3012"></a> |
| <span class="sourceLineNo">3013</span> * <li><b>Methods:</b><a name="line.3013"></a> |
| <span class="sourceLineNo">3014</span> * <ul><a name="line.3014"></a> |
| <span class="sourceLineNo">3015</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#property(String,Object)}<a name="line.3015"></a> |
| <span class="sourceLineNo">3016</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#properties(Map)}<a name="line.3016"></a> |
| <span class="sourceLineNo">3017</span> * </ul><a name="line.3017"></a> |
| <span class="sourceLineNo">3018</span> * </ul><a name="line.3018"></a> |
| <span class="sourceLineNo">3019</span> *<a name="line.3019"></a> |
| <span class="sourceLineNo">3020</span> * <h5 class='section'>Description:</h5><a name="line.3020"></a> |
| <span class="sourceLineNo">3021</span> * <p><a name="line.3021"></a> |
| <span class="sourceLineNo">3022</span> * Shortcut to add properties to the bean contexts of all serializers and parsers on all methods in the class.<a name="line.3022"></a> |
| <span class="sourceLineNo">3023</span> *<a name="line.3023"></a> |
| <span class="sourceLineNo">3024</span> * <p><a name="line.3024"></a> |
| <span class="sourceLineNo">3025</span> * Any of the properties defined on {@link RestContext} or any of the serializers and parsers can be specified.<a name="line.3025"></a> |
| <span class="sourceLineNo">3026</span> *<a name="line.3026"></a> |
| <span class="sourceLineNo">3027</span> * <p><a name="line.3027"></a> |
| <span class="sourceLineNo">3028</span> * Property values will be converted to the appropriate type.<a name="line.3028"></a> |
| <span class="sourceLineNo">3029</span> *<a name="line.3029"></a> |
| <span class="sourceLineNo">3030</span> * <ul class='notes'><a name="line.3030"></a> |
| <span class="sourceLineNo">3031</span> * <li><a name="line.3031"></a> |
| <span class="sourceLineNo">3032</span> * Supports {@doc RestSvlVariables}<a name="line.3032"></a> |
| <span class="sourceLineNo">3033</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.3033"></a> |
| <span class="sourceLineNo">3034</span> * </ul><a name="line.3034"></a> |
| <span class="sourceLineNo">3035</span> *<a name="line.3035"></a> |
| <span class="sourceLineNo">3036</span> * <ul class='seealso'><a name="line.3036"></a> |
| <span class="sourceLineNo">3037</span> * <li class='jm'>{@link RestContextBuilder#set(String,Object)}<a name="line.3037"></a> |
| <span class="sourceLineNo">3038</span> * <li class='jm'>{@link RestContextBuilder#set(java.util.Map)}<a name="line.3038"></a> |
| <span class="sourceLineNo">3039</span> * </ul><a name="line.3039"></a> |
| <span class="sourceLineNo">3040</span> */<a name="line.3040"></a> |
| <span class="sourceLineNo">3041</span> public static final String REST_properties = PREFIX + ".properties.sms";<a name="line.3041"></a> |
| <span class="sourceLineNo">3042</span><a name="line.3042"></a> |
| <span class="sourceLineNo">3043</span> /**<a name="line.3043"></a> |
| <span class="sourceLineNo">3044</span> * Configuration property: Supported content media types.<a name="line.3044"></a> |
| <span class="sourceLineNo">3045</span> *<a name="line.3045"></a> |
| <span class="sourceLineNo">3046</span> * <h5 class='section'>Property:</h5><a name="line.3046"></a> |
| <span class="sourceLineNo">3047</span> * <ul class='spaced-list'><a name="line.3047"></a> |
| <span class="sourceLineNo">3048</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_consumes REST_consumes}<a name="line.3048"></a> |
| <span class="sourceLineNo">3049</span> * <li><b>Name:</b> <js>"RestContext.consumes.ls"</js><a name="line.3049"></a> |
| <span class="sourceLineNo">3050</span> * <li><b>Data type:</b> <c>List&lt;String&gt;</c><a name="line.3050"></a> |
| <span class="sourceLineNo">3051</span> * <li><b>System property:</b> <c>RestContext.consumes</c><a name="line.3051"></a> |
| <span class="sourceLineNo">3052</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_CONSUMES</c><a name="line.3052"></a> |
| <span class="sourceLineNo">3053</span> * <li><b>Default:</b> empty list<a name="line.3053"></a> |
| <span class="sourceLineNo">3054</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3054"></a> |
| <span class="sourceLineNo">3055</span> * <li><b>Annotations:</b><a name="line.3055"></a> |
| <span class="sourceLineNo">3056</span> * <ul><a name="line.3056"></a> |
| <span class="sourceLineNo">3057</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#consumes()}<a name="line.3057"></a> |
| <span class="sourceLineNo">3058</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.RestMethod#consumes()}<a name="line.3058"></a> |
| <span class="sourceLineNo">3059</span> * </ul><a name="line.3059"></a> |
| <span class="sourceLineNo">3060</span> * <li><b>Methods:</b><a name="line.3060"></a> |
| <span class="sourceLineNo">3061</span> * <ul><a name="line.3061"></a> |
| <span class="sourceLineNo">3062</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#consumes(String...)}<a name="line.3062"></a> |
| <span class="sourceLineNo">3063</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#consumes(MediaType...)}<a name="line.3063"></a> |
| <span class="sourceLineNo">3064</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#consumesReplace(String...)}<a name="line.3064"></a> |
| <span class="sourceLineNo">3065</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#consumesReplace(MediaType...)}<a name="line.3065"></a> |
| <span class="sourceLineNo">3066</span> * </ul><a name="line.3066"></a> |
| <span class="sourceLineNo">3067</span> * </ul><a name="line.3067"></a> |
| <span class="sourceLineNo">3068</span> *<a name="line.3068"></a> |
| <span class="sourceLineNo">3069</span> * <h5 class='section'>Description:</h5><a name="line.3069"></a> |
| <span class="sourceLineNo">3070</span> * <p><a name="line.3070"></a> |
| <span class="sourceLineNo">3071</span> * Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.<a name="line.3071"></a> |
| <span class="sourceLineNo">3072</span> * <br>An example where this might be useful if you have parsers registered that handle media types that you<a name="line.3072"></a> |
| <span class="sourceLineNo">3073</span> * don't want exposed in the Swagger documentation.<a name="line.3073"></a> |
| <span class="sourceLineNo">3074</span> *<a name="line.3074"></a> |
| <span class="sourceLineNo">3075</span> * <h5 class='section'>Example:</h5><a name="line.3075"></a> |
| <span class="sourceLineNo">3076</span> * <p class='bcode w800'><a name="line.3076"></a> |
| <span class="sourceLineNo">3077</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3077"></a> |
| <span class="sourceLineNo">3078</span> * <ja>@Rest</ja>(consumes={<js>"$C{REST/supportedConsumes,application/json}"</js>})<a name="line.3078"></a> |
| <span class="sourceLineNo">3079</span> * <jk>public class</jk> MyResource {<a name="line.3079"></a> |
| <span class="sourceLineNo">3080</span> *<a name="line.3080"></a> |
| <span class="sourceLineNo">3081</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3081"></a> |
| <span class="sourceLineNo">3082</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3082"></a> |
| <span class="sourceLineNo">3083</span> *<a name="line.3083"></a> |
| <span class="sourceLineNo">3084</span> * <jc>// Using method on builder.</jc><a name="line.3084"></a> |
| <span class="sourceLineNo">3085</span> * builder.consumes(<jk>false</jk>, <js>"application/json"</js>)<a name="line.3085"></a> |
| <span class="sourceLineNo">3086</span> *<a name="line.3086"></a> |
| <span class="sourceLineNo">3087</span> * <jc>// Same, but using property.</jc><a name="line.3087"></a> |
| <span class="sourceLineNo">3088</span> * builder.set(<jsf>REST_consumes</jsf>, <js>"application/json"</js>);<a name="line.3088"></a> |
| <span class="sourceLineNo">3089</span> * }<a name="line.3089"></a> |
| <span class="sourceLineNo">3090</span> *<a name="line.3090"></a> |
| <span class="sourceLineNo">3091</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3091"></a> |
| <span class="sourceLineNo">3092</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3092"></a> |
| <span class="sourceLineNo">3093</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3093"></a> |
| <span class="sourceLineNo">3094</span> * builder.consumes(<jk>false</jk>, <js>"application/json"</js>);<a name="line.3094"></a> |
| <span class="sourceLineNo">3095</span> * }<a name="line.3095"></a> |
| <span class="sourceLineNo">3096</span> * }<a name="line.3096"></a> |
| <span class="sourceLineNo">3097</span> * </p><a name="line.3097"></a> |
| <span class="sourceLineNo">3098</span> *<a name="line.3098"></a> |
| <span class="sourceLineNo">3099</span> * <p><a name="line.3099"></a> |
| <span class="sourceLineNo">3100</span> * This affects the returned values from the following:<a name="line.3100"></a> |
| <span class="sourceLineNo">3101</span> * <ul class='javatree'><a name="line.3101"></a> |
| <span class="sourceLineNo">3102</span> * <li class='jm'>{@link RestContext#getConsumes() RestContext.getConsumes()}<a name="line.3102"></a> |
| <span class="sourceLineNo">3103</span> * <li class='jm'>{@link RestRequest#getConsumes()}<a name="line.3103"></a> |
| <span class="sourceLineNo">3104</span> * <li class='jm'>{@link RestInfoProvider#getSwagger(RestRequest)} - Affects consumes field.<a name="line.3104"></a> |
| <span class="sourceLineNo">3105</span> * </ul><a name="line.3105"></a> |
| <span class="sourceLineNo">3106</span> */<a name="line.3106"></a> |
| <span class="sourceLineNo">3107</span> public static final String REST_consumes = PREFIX + ".consumes.ls";<a name="line.3107"></a> |
| <span class="sourceLineNo">3108</span><a name="line.3108"></a> |
| <span class="sourceLineNo">3109</span> /**<a name="line.3109"></a> |
| <span class="sourceLineNo">3110</span> * Configuration property: REST context class.<a name="line.3110"></a> |
| <span class="sourceLineNo">3111</span> *<a name="line.3111"></a> |
| <span class="sourceLineNo">3112</span> * <review>NEEDS REVIEW</review><a name="line.3112"></a> |
| <span class="sourceLineNo">3113</span> *<a name="line.3113"></a> |
| <span class="sourceLineNo">3114</span> * <h5 class='section'>Property:</h5><a name="line.3114"></a> |
| <span class="sourceLineNo">3115</span> * <ul class='spaced-list'><a name="line.3115"></a> |
| <span class="sourceLineNo">3116</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_context REST_context}<a name="line.3116"></a> |
| <span class="sourceLineNo">3117</span> * <li><b>Name:</b> <js>"RestContext.context.c"</js><a name="line.3117"></a> |
| <span class="sourceLineNo">3118</span> * <li><b>Data type:</b> <c>Class&lt;? extends {@link org.apache.juneau.rest.RestContext}&gt;</c><a name="line.3118"></a> |
| <span class="sourceLineNo">3119</span> * <li><b>Default:</b> {@link org.apache.juneau.rest.RestContext}<a name="line.3119"></a> |
| <span class="sourceLineNo">3120</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3120"></a> |
| <span class="sourceLineNo">3121</span> * <li><b>Annotations:</b><a name="line.3121"></a> |
| <span class="sourceLineNo">3122</span> * <ul><a name="line.3122"></a> |
| <span class="sourceLineNo">3123</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#context()}<a name="line.3123"></a> |
| <span class="sourceLineNo">3124</span> * </ul><a name="line.3124"></a> |
| <span class="sourceLineNo">3125</span> * <li><b>Methods:</b><a name="line.3125"></a> |
| <span class="sourceLineNo">3126</span> * <ul><a name="line.3126"></a> |
| <span class="sourceLineNo">3127</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#context(Class)}<a name="line.3127"></a> |
| <span class="sourceLineNo">3128</span> * </ul><a name="line.3128"></a> |
| <span class="sourceLineNo">3129</span> * </ul><a name="line.3129"></a> |
| <span class="sourceLineNo">3130</span> *<a name="line.3130"></a> |
| <span class="sourceLineNo">3131</span> * <h5 class='section'>Description:</h5><a name="line.3131"></a> |
| <span class="sourceLineNo">3132</span> * <p><a name="line.3132"></a> |
| <span class="sourceLineNo">3133</span> * Allows you to extend the {@link RestContext} class to modify how any of the methods are implemented.<a name="line.3133"></a> |
| <span class="sourceLineNo">3134</span> *<a name="line.3134"></a> |
| <span class="sourceLineNo">3135</span> * <p><a name="line.3135"></a> |
| <span class="sourceLineNo">3136</span> * The subclass must provide the following:<a name="line.3136"></a> |
| <span class="sourceLineNo">3137</span> * <ul><a name="line.3137"></a> |
| <span class="sourceLineNo">3138</span> * <li>A public constructor that takes in one parameter that should be passed to the super constructor: {@link RestContextBuilder}.<a name="line.3138"></a> |
| <span class="sourceLineNo">3139</span> * </ul><a name="line.3139"></a> |
| <span class="sourceLineNo">3140</span> *<a name="line.3140"></a> |
| <span class="sourceLineNo">3141</span> * <h5 class='section'>Example:</h5><a name="line.3141"></a> |
| <span class="sourceLineNo">3142</span> * <p class='bcode w800'><a name="line.3142"></a> |
| <span class="sourceLineNo">3143</span> * <jc>// Our extended context class</jc><a name="line.3143"></a> |
| <span class="sourceLineNo">3144</span> * <jk>public</jk> MyRestContext <jk>extends</jk> RestContext {<a name="line.3144"></a> |
| <span class="sourceLineNo">3145</span> * <jk>public</jk> MyRestContext(RestContextBuilder <jv>builder</jv>) {<a name="line.3145"></a> |
| <span class="sourceLineNo">3146</span> * <jk>super</jk>(<jv>builder</jv>);<a name="line.3146"></a> |
| <span class="sourceLineNo">3147</span> * }<a name="line.3147"></a> |
| <span class="sourceLineNo">3148</span> *<a name="line.3148"></a> |
| <span class="sourceLineNo">3149</span> * <jc>// Override any methods.</jc><a name="line.3149"></a> |
| <span class="sourceLineNo">3150</span> * }<a name="line.3150"></a> |
| <span class="sourceLineNo">3151</span> * </p><a name="line.3151"></a> |
| <span class="sourceLineNo">3152</span> * <p class='bcode w800'><a name="line.3152"></a> |
| <span class="sourceLineNo">3153</span> * <jc>// Option #1 - Defined via annotation.</jc><a name="line.3153"></a> |
| <span class="sourceLineNo">3154</span> * <ja>@Rest</ja>(context=MyRestContext.<jk>class</jk>)<a name="line.3154"></a> |
| <span class="sourceLineNo">3155</span> * <jk>public class</jk> MyResource {<a name="line.3155"></a> |
| <span class="sourceLineNo">3156</span> * ...<a name="line.3156"></a> |
| <span class="sourceLineNo">3157</span> *<a name="line.3157"></a> |
| <span class="sourceLineNo">3158</span> * <jc>// Option #2 - Defined via builder passed in through init method.</jc><a name="line.3158"></a> |
| <span class="sourceLineNo">3159</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3159"></a> |
| <span class="sourceLineNo">3160</span> * <jk>public void</jk> init(RestContextBuilder <jv>builder</jv>) <jk>throws</jk> Exception {<a name="line.3160"></a> |
| <span class="sourceLineNo">3161</span> * <jv>builder</jv>.context(MyRestContext.<jk>class</jk>);<a name="line.3161"></a> |
| <span class="sourceLineNo">3162</span> * }<a name="line.3162"></a> |
| <span class="sourceLineNo">3163</span> * }<a name="line.3163"></a> |
| <span class="sourceLineNo">3164</span> * </p><a name="line.3164"></a> |
| <span class="sourceLineNo">3165</span> */<a name="line.3165"></a> |
| <span class="sourceLineNo">3166</span> public static final String REST_context = PREFIX + ".context.c";<a name="line.3166"></a> |
| <span class="sourceLineNo">3167</span><a name="line.3167"></a> |
| <span class="sourceLineNo">3168</span> /**<a name="line.3168"></a> |
| <span class="sourceLineNo">3169</span> * Configuration property: Use classpath resource caching.<a name="line.3169"></a> |
| <span class="sourceLineNo">3170</span> *<a name="line.3170"></a> |
| <span class="sourceLineNo">3171</span> * <h5 class='section'>Property:</h5><a name="line.3171"></a> |
| <span class="sourceLineNo">3172</span> * <ul class='spaced-list'><a name="line.3172"></a> |
| <span class="sourceLineNo">3173</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_useClasspathResourceCaching REST_useClasspathResourceCaching}<a name="line.3173"></a> |
| <span class="sourceLineNo">3174</span> * <li><b>Name:</b> <js>"RestContext.useClasspathResourceCaching.b"</js><a name="line.3174"></a> |
| <span class="sourceLineNo">3175</span> * <li><b>Data type:</b> <jk>boolean</jk><a name="line.3175"></a> |
| <span class="sourceLineNo">3176</span> * <li><b>System property:</b> <c>RestContext.useClasspathResourceCaching</c><a name="line.3176"></a> |
| <span class="sourceLineNo">3177</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_USECLASSPATHRESOURCECACHING</c><a name="line.3177"></a> |
| <span class="sourceLineNo">3178</span> * <li><b>Default:</b> <jk>true</jk><a name="line.3178"></a> |
| <span class="sourceLineNo">3179</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3179"></a> |
| <span class="sourceLineNo">3180</span> * <li><b>Annotations:</b><a name="line.3180"></a> |
| <span class="sourceLineNo">3181</span> * <ul><a name="line.3181"></a> |
| <span class="sourceLineNo">3182</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#useClasspathResourceCaching()}<a name="line.3182"></a> |
| <span class="sourceLineNo">3183</span> * </ul><a name="line.3183"></a> |
| <span class="sourceLineNo">3184</span> * <li><b>Methods:</b><a name="line.3184"></a> |
| <span class="sourceLineNo">3185</span> * <ul><a name="line.3185"></a> |
| <span class="sourceLineNo">3186</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#useClasspathResourceCaching(boolean)}<a name="line.3186"></a> |
| <span class="sourceLineNo">3187</span> * </ul><a name="line.3187"></a> |
| <span class="sourceLineNo">3188</span> * </ul><a name="line.3188"></a> |
| <span class="sourceLineNo">3189</span> *<a name="line.3189"></a> |
| <span class="sourceLineNo">3190</span> * <h5 class='section'>Description:</h5><a name="line.3190"></a> |
| <span class="sourceLineNo">3191</span> * <p><a name="line.3191"></a> |
| <span class="sourceLineNo">3192</span> * When enabled, resources retrieved via {@link RestContext#getClasspathResource(String, Locale)} (and related<a name="line.3192"></a> |
| <span class="sourceLineNo">3193</span> * methods) will be cached in memory to speed subsequent lookups.<a name="line.3193"></a> |
| <span class="sourceLineNo">3194</span> *<a name="line.3194"></a> |
| <span class="sourceLineNo">3195</span> * <h5 class='section'>Example:</h5><a name="line.3195"></a> |
| <span class="sourceLineNo">3196</span> * <p class='bcode w800'><a name="line.3196"></a> |
| <span class="sourceLineNo">3197</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3197"></a> |
| <span class="sourceLineNo">3198</span> * <ja>@Rest</ja>(useClasspathResourceCaching=<js>"$C{REST/useClasspathResourceCaching,false}"</js>)<a name="line.3198"></a> |
| <span class="sourceLineNo">3199</span> * <jk>public class</jk> MyResource {<a name="line.3199"></a> |
| <span class="sourceLineNo">3200</span> *<a name="line.3200"></a> |
| <span class="sourceLineNo">3201</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3201"></a> |
| <span class="sourceLineNo">3202</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3202"></a> |
| <span class="sourceLineNo">3203</span> *<a name="line.3203"></a> |
| <span class="sourceLineNo">3204</span> * <jc>// Using method on builder.</jc><a name="line.3204"></a> |
| <span class="sourceLineNo">3205</span> * builder.useClasspathResourceCaching(<jk>false</jk>)<a name="line.3205"></a> |
| <span class="sourceLineNo">3206</span> *<a name="line.3206"></a> |
| <span class="sourceLineNo">3207</span> * <jc>// Same, but using property.</jc><a name="line.3207"></a> |
| <span class="sourceLineNo">3208</span> * builder.set(<jsf>REST_useClasspathResourceCaching</jsf>, <jk>false</jk>);<a name="line.3208"></a> |
| <span class="sourceLineNo">3209</span> * }<a name="line.3209"></a> |
| <span class="sourceLineNo">3210</span> *<a name="line.3210"></a> |
| <span class="sourceLineNo">3211</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3211"></a> |
| <span class="sourceLineNo">3212</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3212"></a> |
| <span class="sourceLineNo">3213</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3213"></a> |
| <span class="sourceLineNo">3214</span> * builder.useClasspathResourceCaching(<jk>false</jk>)<a name="line.3214"></a> |
| <span class="sourceLineNo">3215</span> * }<a name="line.3215"></a> |
| <span class="sourceLineNo">3216</span> * }<a name="line.3216"></a> |
| <span class="sourceLineNo">3217</span> * </p><a name="line.3217"></a> |
| <span class="sourceLineNo">3218</span> *<a name="line.3218"></a> |
| <span class="sourceLineNo">3219</span> * <ul class='seealso'><a name="line.3219"></a> |
| <span class="sourceLineNo">3220</span> * <li class='jf'>{@link #REST_staticFiles} for information about static files.<a name="line.3220"></a> |
| <span class="sourceLineNo">3221</span> * </ul><a name="line.3221"></a> |
| <span class="sourceLineNo">3222</span> */<a name="line.3222"></a> |
| <span class="sourceLineNo">3223</span> public static final String REST_useClasspathResourceCaching = PREFIX + ".useClasspathResourceCaching.b";<a name="line.3223"></a> |
| <span class="sourceLineNo">3224</span><a name="line.3224"></a> |
| <span class="sourceLineNo">3225</span> /**<a name="line.3225"></a> |
| <span class="sourceLineNo">3226</span> * Configuration property: Use stack trace hashes.<a name="line.3226"></a> |
| <span class="sourceLineNo">3227</span> *<a name="line.3227"></a> |
| <span class="sourceLineNo">3228</span> * <div class='warn'><a name="line.3228"></a> |
| <span class="sourceLineNo">3229</span> * <b>Deprecated</b> - Use {@link Logging#useStackTraceHashing}<a name="line.3229"></a> |
| <span class="sourceLineNo">3230</span> * </div><a name="line.3230"></a> |
| <span class="sourceLineNo">3231</span> */<a name="line.3231"></a> |
| <span class="sourceLineNo">3232</span> @Deprecated<a name="line.3232"></a> |
| <span class="sourceLineNo">3233</span> public static final String REST_useStackTraceHashes = PREFIX + ".useStackTraceHashes.b";<a name="line.3233"></a> |
| <span class="sourceLineNo">3234</span><a name="line.3234"></a> |
| <span class="sourceLineNo">3235</span> /**<a name="line.3235"></a> |
| <span class="sourceLineNo">3236</span> * Configuration property: Resource URI authority path.<a name="line.3236"></a> |
| <span class="sourceLineNo">3237</span> *<a name="line.3237"></a> |
| <span class="sourceLineNo">3238</span> * <h5 class='section'>Property:</h5><a name="line.3238"></a> |
| <span class="sourceLineNo">3239</span> * <ul class='spaced-list'><a name="line.3239"></a> |
| <span class="sourceLineNo">3240</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_uriAuthority REST_uriAuthority}<a name="line.3240"></a> |
| <span class="sourceLineNo">3241</span> * <li><b>Name:</b> <js>"RestContext.uriAuthority.s"</js><a name="line.3241"></a> |
| <span class="sourceLineNo">3242</span> * <li><b>Data type:</b> <c>String</c><a name="line.3242"></a> |
| <span class="sourceLineNo">3243</span> * <li><b>System property:</b> <c>RestContext.uriAuthority</c><a name="line.3243"></a> |
| <span class="sourceLineNo">3244</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_URIAUTHORITY</c><a name="line.3244"></a> |
| <span class="sourceLineNo">3245</span> * <li><b>Default:</b> <jk>null</jk><a name="line.3245"></a> |
| <span class="sourceLineNo">3246</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3246"></a> |
| <span class="sourceLineNo">3247</span> * <li><b>Annotations:</b><a name="line.3247"></a> |
| <span class="sourceLineNo">3248</span> * <ul><a name="line.3248"></a> |
| <span class="sourceLineNo">3249</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#uriAuthority()}<a name="line.3249"></a> |
| <span class="sourceLineNo">3250</span> * </ul><a name="line.3250"></a> |
| <span class="sourceLineNo">3251</span> * <li><b>Methods:</b><a name="line.3251"></a> |
| <span class="sourceLineNo">3252</span> * <ul><a name="line.3252"></a> |
| <span class="sourceLineNo">3253</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#uriAuthority(String)}<a name="line.3253"></a> |
| <span class="sourceLineNo">3254</span> * </ul><a name="line.3254"></a> |
| <span class="sourceLineNo">3255</span> * </ul><a name="line.3255"></a> |
| <span class="sourceLineNo">3256</span> *<a name="line.3256"></a> |
| <span class="sourceLineNo">3257</span> * <h5 class='section'>Description:</h5><a name="line.3257"></a> |
| <span class="sourceLineNo">3258</span> * <p><a name="line.3258"></a> |
| <span class="sourceLineNo">3259</span> * Overrides the authority path value for this resource and any child resources.<a name="line.3259"></a> |
| <span class="sourceLineNo">3260</span> *<a name="line.3260"></a> |
| <span class="sourceLineNo">3261</span> * <p><a name="line.3261"></a> |
| <span class="sourceLineNo">3262</span> * Affects the following methods:<a name="line.3262"></a> |
| <span class="sourceLineNo">3263</span> * <ul class='javatree'><a name="line.3263"></a> |
| <span class="sourceLineNo">3264</span> * <li class='jm'>{@link RestRequest#getAuthorityPath()}<a name="line.3264"></a> |
| <span class="sourceLineNo">3265</span> * </ul><a name="line.3265"></a> |
| <span class="sourceLineNo">3266</span> *<a name="line.3266"></a> |
| <span class="sourceLineNo">3267</span> * <p><a name="line.3267"></a> |
| <span class="sourceLineNo">3268</span> * If you do not specify the authority, it is automatically calculated via the following:<a name="line.3268"></a> |
| <span class="sourceLineNo">3269</span> *<a name="line.3269"></a> |
| <span class="sourceLineNo">3270</span> * <p class='bcode w800'><a name="line.3270"></a> |
| <span class="sourceLineNo">3271</span> * String scheme = request.getScheme();<a name="line.3271"></a> |
| <span class="sourceLineNo">3272</span> * <jk>int</jk> port = request.getServerPort();<a name="line.3272"></a> |
| <span class="sourceLineNo">3273</span> * StringBuilder sb = <jk>new</jk> StringBuilder(request.getScheme()).append(<js>"://"</js>).append(request.getServerName());<a name="line.3273"></a> |
| <span class="sourceLineNo">3274</span> * <jk>if</jk> (! (port == 80 &amp;&amp; <js>"http"</js>.equals(scheme) || port == 443 &amp;&amp; <js>"https"</js>.equals(scheme)))<a name="line.3274"></a> |
| <span class="sourceLineNo">3275</span> * sb.append(<js>':'</js>).append(port);<a name="line.3275"></a> |
| <span class="sourceLineNo">3276</span> * authorityPath = sb.toString();<a name="line.3276"></a> |
| <span class="sourceLineNo">3277</span> * </p><a name="line.3277"></a> |
| <span class="sourceLineNo">3278</span> *<a name="line.3278"></a> |
| <span class="sourceLineNo">3279</span> * <h5 class='section'>Example:</h5><a name="line.3279"></a> |
| <span class="sourceLineNo">3280</span> * <p class='bcode w800'><a name="line.3280"></a> |
| <span class="sourceLineNo">3281</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3281"></a> |
| <span class="sourceLineNo">3282</span> * <ja>@Rest</ja>(<a name="line.3282"></a> |
| <span class="sourceLineNo">3283</span> * path=<js>"/servlet"</js>,<a name="line.3283"></a> |
| <span class="sourceLineNo">3284</span> * uriAuthority=<js>"$C{REST/authorityPathOverride,http://localhost:10000}"</js><a name="line.3284"></a> |
| <span class="sourceLineNo">3285</span> * )<a name="line.3285"></a> |
| <span class="sourceLineNo">3286</span> * <jk>public class</jk> MyResource {<a name="line.3286"></a> |
| <span class="sourceLineNo">3287</span> *<a name="line.3287"></a> |
| <span class="sourceLineNo">3288</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3288"></a> |
| <span class="sourceLineNo">3289</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3289"></a> |
| <span class="sourceLineNo">3290</span> *<a name="line.3290"></a> |
| <span class="sourceLineNo">3291</span> * <jc>// Using method on builder.</jc><a name="line.3291"></a> |
| <span class="sourceLineNo">3292</span> * builder.uriAuthority(<js>"http://localhost:10000"</js>);<a name="line.3292"></a> |
| <span class="sourceLineNo">3293</span> *<a name="line.3293"></a> |
| <span class="sourceLineNo">3294</span> * <jc>// Same, but using property.</jc><a name="line.3294"></a> |
| <span class="sourceLineNo">3295</span> * builder.set(<jsf>REST_uriAuthority</jsf>, <js>"http://localhost:10000"</js>);<a name="line.3295"></a> |
| <span class="sourceLineNo">3296</span> * }<a name="line.3296"></a> |
| <span class="sourceLineNo">3297</span> *<a name="line.3297"></a> |
| <span class="sourceLineNo">3298</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3298"></a> |
| <span class="sourceLineNo">3299</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3299"></a> |
| <span class="sourceLineNo">3300</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3300"></a> |
| <span class="sourceLineNo">3301</span> * builder.uriAuthority(<js>"http://localhost:10000"</js>);<a name="line.3301"></a> |
| <span class="sourceLineNo">3302</span> * }<a name="line.3302"></a> |
| <span class="sourceLineNo">3303</span> * }<a name="line.3303"></a> |
| <span class="sourceLineNo">3304</span> * </p><a name="line.3304"></a> |
| <span class="sourceLineNo">3305</span> */<a name="line.3305"></a> |
| <span class="sourceLineNo">3306</span> public static final String REST_uriAuthority = PREFIX + ".uriAuthority.s";<a name="line.3306"></a> |
| <span class="sourceLineNo">3307</span><a name="line.3307"></a> |
| <span class="sourceLineNo">3308</span> /**<a name="line.3308"></a> |
| <span class="sourceLineNo">3309</span> * Configuration property: Resource URI context path.<a name="line.3309"></a> |
| <span class="sourceLineNo">3310</span> *<a name="line.3310"></a> |
| <span class="sourceLineNo">3311</span> * <h5 class='section'>Property:</h5><a name="line.3311"></a> |
| <span class="sourceLineNo">3312</span> * <ul class='spaced-list'><a name="line.3312"></a> |
| <span class="sourceLineNo">3313</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_uriContext REST_uriContext}<a name="line.3313"></a> |
| <span class="sourceLineNo">3314</span> * <li><b>Name:</b> <js>"RestContext.uriContext.s"</js><a name="line.3314"></a> |
| <span class="sourceLineNo">3315</span> * <li><b>Data type:</b> <c>String</c><a name="line.3315"></a> |
| <span class="sourceLineNo">3316</span> * <li><b>System property:</b> <c>RestContext.uriContext</c><a name="line.3316"></a> |
| <span class="sourceLineNo">3317</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_URICONTEXT</c><a name="line.3317"></a> |
| <span class="sourceLineNo">3318</span> * <li><b>Default:</b> <jk>null</jk><a name="line.3318"></a> |
| <span class="sourceLineNo">3319</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3319"></a> |
| <span class="sourceLineNo">3320</span> * <li><b>Annotations:</b><a name="line.3320"></a> |
| <span class="sourceLineNo">3321</span> * <ul><a name="line.3321"></a> |
| <span class="sourceLineNo">3322</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#uriContext()}<a name="line.3322"></a> |
| <span class="sourceLineNo">3323</span> * </ul><a name="line.3323"></a> |
| <span class="sourceLineNo">3324</span> * <li><b>Methods:</b><a name="line.3324"></a> |
| <span class="sourceLineNo">3325</span> * <ul><a name="line.3325"></a> |
| <span class="sourceLineNo">3326</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#uriContext(String)}<a name="line.3326"></a> |
| <span class="sourceLineNo">3327</span> * </ul><a name="line.3327"></a> |
| <span class="sourceLineNo">3328</span> * </ul><a name="line.3328"></a> |
| <span class="sourceLineNo">3329</span> *<a name="line.3329"></a> |
| <span class="sourceLineNo">3330</span> * <h5 class='section'>Description:</h5><a name="line.3330"></a> |
| <span class="sourceLineNo">3331</span> * <p><a name="line.3331"></a> |
| <span class="sourceLineNo">3332</span> * Overrides the context path value for this resource and any child resources.<a name="line.3332"></a> |
| <span class="sourceLineNo">3333</span> *<a name="line.3333"></a> |
| <span class="sourceLineNo">3334</span> * <p><a name="line.3334"></a> |
| <span class="sourceLineNo">3335</span> * This setting is useful if you want to use <js>"context:/child/path"</js> URLs in child resource POJOs but<a name="line.3335"></a> |
| <span class="sourceLineNo">3336</span> * the context path is not actually specified on the servlet container.<a name="line.3336"></a> |
| <span class="sourceLineNo">3337</span> *<a name="line.3337"></a> |
| <span class="sourceLineNo">3338</span> * <p><a name="line.3338"></a> |
| <span class="sourceLineNo">3339</span> * Affects the following methods:<a name="line.3339"></a> |
| <span class="sourceLineNo">3340</span> * <ul class='javatree'><a name="line.3340"></a> |
| <span class="sourceLineNo">3341</span> * <li class='jm'>{@link RestRequest#getContextPath()} - Returns the overridden context path for the resource.<a name="line.3341"></a> |
| <span class="sourceLineNo">3342</span> * <li class='jm'>{@link RestRequest#getServletPath()} - Includes the overridden context path for the resource.<a name="line.3342"></a> |
| <span class="sourceLineNo">3343</span> * </ul><a name="line.3343"></a> |
| <span class="sourceLineNo">3344</span> *<a name="line.3344"></a> |
| <span class="sourceLineNo">3345</span> * <h5 class='section'>Example:</h5><a name="line.3345"></a> |
| <span class="sourceLineNo">3346</span> * <p class='bcode w800'><a name="line.3346"></a> |
| <span class="sourceLineNo">3347</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3347"></a> |
| <span class="sourceLineNo">3348</span> * <ja>@Rest</ja>(<a name="line.3348"></a> |
| <span class="sourceLineNo">3349</span> * path=<js>"/servlet"</js>,<a name="line.3349"></a> |
| <span class="sourceLineNo">3350</span> * uriContext=<js>"$C{REST/contextPathOverride,/foo}"</js><a name="line.3350"></a> |
| <span class="sourceLineNo">3351</span> * )<a name="line.3351"></a> |
| <span class="sourceLineNo">3352</span> * <jk>public class</jk> MyResource {<a name="line.3352"></a> |
| <span class="sourceLineNo">3353</span> *<a name="line.3353"></a> |
| <span class="sourceLineNo">3354</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3354"></a> |
| <span class="sourceLineNo">3355</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3355"></a> |
| <span class="sourceLineNo">3356</span> *<a name="line.3356"></a> |
| <span class="sourceLineNo">3357</span> * <jc>// Using method on builder.</jc><a name="line.3357"></a> |
| <span class="sourceLineNo">3358</span> * builder.uriContext(<js>"/foo"</js>);<a name="line.3358"></a> |
| <span class="sourceLineNo">3359</span> *<a name="line.3359"></a> |
| <span class="sourceLineNo">3360</span> * <jc>// Same, but using property.</jc><a name="line.3360"></a> |
| <span class="sourceLineNo">3361</span> * builder.set(<jsf>REST_uriContext</jsf>, <js>"/foo"</js>);<a name="line.3361"></a> |
| <span class="sourceLineNo">3362</span> * }<a name="line.3362"></a> |
| <span class="sourceLineNo">3363</span> *<a name="line.3363"></a> |
| <span class="sourceLineNo">3364</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3364"></a> |
| <span class="sourceLineNo">3365</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3365"></a> |
| <span class="sourceLineNo">3366</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3366"></a> |
| <span class="sourceLineNo">3367</span> * builder.uriContext(<js>"/foo"</js>);<a name="line.3367"></a> |
| <span class="sourceLineNo">3368</span> * }<a name="line.3368"></a> |
| <span class="sourceLineNo">3369</span> * }<a name="line.3369"></a> |
| <span class="sourceLineNo">3370</span> * </p><a name="line.3370"></a> |
| <span class="sourceLineNo">3371</span> */<a name="line.3371"></a> |
| <span class="sourceLineNo">3372</span> public static final String REST_uriContext = PREFIX + ".uriContext.s";<a name="line.3372"></a> |
| <span class="sourceLineNo">3373</span><a name="line.3373"></a> |
| <span class="sourceLineNo">3374</span> /**<a name="line.3374"></a> |
| <span class="sourceLineNo">3375</span> * Configuration property: URI resolution relativity.<a name="line.3375"></a> |
| <span class="sourceLineNo">3376</span> *<a name="line.3376"></a> |
| <span class="sourceLineNo">3377</span> * <h5 class='section'>Property:</h5><a name="line.3377"></a> |
| <span class="sourceLineNo">3378</span> * <ul class='spaced-list'><a name="line.3378"></a> |
| <span class="sourceLineNo">3379</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_uriRelativity REST_uriRelativity}<a name="line.3379"></a> |
| <span class="sourceLineNo">3380</span> * <li><b>Name:</b> <js>"RestContext.uriRelativity.s"</js><a name="line.3380"></a> |
| <span class="sourceLineNo">3381</span> * <li><b>Data type:</b> <c>String</c><a name="line.3381"></a> |
| <span class="sourceLineNo">3382</span> * <li><b>System property:</b> <c>RestContext.uriRelativity</c><a name="line.3382"></a> |
| <span class="sourceLineNo">3383</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_URIRELATIVITY</c><a name="line.3383"></a> |
| <span class="sourceLineNo">3384</span> * <li><b>Default:</b> <js>"RESOURCE"</js><a name="line.3384"></a> |
| <span class="sourceLineNo">3385</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3385"></a> |
| <span class="sourceLineNo">3386</span> * <li><b>Annotations:</b><a name="line.3386"></a> |
| <span class="sourceLineNo">3387</span> * <ul><a name="line.3387"></a> |
| <span class="sourceLineNo">3388</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#uriRelativity()}<a name="line.3388"></a> |
| <span class="sourceLineNo">3389</span> * </ul><a name="line.3389"></a> |
| <span class="sourceLineNo">3390</span> * <li><b>Methods:</b><a name="line.3390"></a> |
| <span class="sourceLineNo">3391</span> * <ul><a name="line.3391"></a> |
| <span class="sourceLineNo">3392</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#uriRelativity(String)}<a name="line.3392"></a> |
| <span class="sourceLineNo">3393</span> * </ul><a name="line.3393"></a> |
| <span class="sourceLineNo">3394</span> * </ul><a name="line.3394"></a> |
| <span class="sourceLineNo">3395</span> *<a name="line.3395"></a> |
| <span class="sourceLineNo">3396</span> * <h5 class='section'>Description:</h5><a name="line.3396"></a> |
| <span class="sourceLineNo">3397</span> * <p><a name="line.3397"></a> |
| <span class="sourceLineNo">3398</span> * Specifies how relative URIs should be interpreted by serializers.<a name="line.3398"></a> |
| <span class="sourceLineNo">3399</span> *<a name="line.3399"></a> |
| <span class="sourceLineNo">3400</span> * <p><a name="line.3400"></a> |
| <span class="sourceLineNo">3401</span> * See {@link UriResolution} for possible values.<a name="line.3401"></a> |
| <span class="sourceLineNo">3402</span> *<a name="line.3402"></a> |
| <span class="sourceLineNo">3403</span> * <p><a name="line.3403"></a> |
| <span class="sourceLineNo">3404</span> * Affects the following methods:<a name="line.3404"></a> |
| <span class="sourceLineNo">3405</span> * <ul class='javatree'><a name="line.3405"></a> |
| <span class="sourceLineNo">3406</span> * <li class='jm'>{@link RestRequest#getUriResolver()}<a name="line.3406"></a> |
| <span class="sourceLineNo">3407</span> * </ul><a name="line.3407"></a> |
| <span class="sourceLineNo">3408</span> *<a name="line.3408"></a> |
| <span class="sourceLineNo">3409</span> * <h5 class='section'>Example:</h5><a name="line.3409"></a> |
| <span class="sourceLineNo">3410</span> * <p class='bcode w800'><a name="line.3410"></a> |
| <span class="sourceLineNo">3411</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3411"></a> |
| <span class="sourceLineNo">3412</span> * <ja>@Rest</ja>(<a name="line.3412"></a> |
| <span class="sourceLineNo">3413</span> * path=<js>"/servlet"</js>,<a name="line.3413"></a> |
| <span class="sourceLineNo">3414</span> * uriRelativity=<js>"$C{REST/uriRelativity,PATH_INFO}"</js><a name="line.3414"></a> |
| <span class="sourceLineNo">3415</span> * )<a name="line.3415"></a> |
| <span class="sourceLineNo">3416</span> * <jk>public class</jk> MyResource {<a name="line.3416"></a> |
| <span class="sourceLineNo">3417</span> *<a name="line.3417"></a> |
| <span class="sourceLineNo">3418</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3418"></a> |
| <span class="sourceLineNo">3419</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3419"></a> |
| <span class="sourceLineNo">3420</span> *<a name="line.3420"></a> |
| <span class="sourceLineNo">3421</span> * <jc>// Using method on builder.</jc><a name="line.3421"></a> |
| <span class="sourceLineNo">3422</span> * builder.uriRelativity(<js>"PATH_INFO"</js>);<a name="line.3422"></a> |
| <span class="sourceLineNo">3423</span> *<a name="line.3423"></a> |
| <span class="sourceLineNo">3424</span> * <jc>// Same, but using property.</jc><a name="line.3424"></a> |
| <span class="sourceLineNo">3425</span> * builder.set(<jsf>REST_uriRelativity</jsf>, <js>"PATH_INFO"</js>);<a name="line.3425"></a> |
| <span class="sourceLineNo">3426</span> * }<a name="line.3426"></a> |
| <span class="sourceLineNo">3427</span> *<a name="line.3427"></a> |
| <span class="sourceLineNo">3428</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3428"></a> |
| <span class="sourceLineNo">3429</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3429"></a> |
| <span class="sourceLineNo">3430</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3430"></a> |
| <span class="sourceLineNo">3431</span> * builder.uriRelativity(<js>"PATH_INFO"</js>);<a name="line.3431"></a> |
| <span class="sourceLineNo">3432</span> * }<a name="line.3432"></a> |
| <span class="sourceLineNo">3433</span> * }<a name="line.3433"></a> |
| <span class="sourceLineNo">3434</span> * </p><a name="line.3434"></a> |
| <span class="sourceLineNo">3435</span> */<a name="line.3435"></a> |
| <span class="sourceLineNo">3436</span> public static final String REST_uriRelativity = PREFIX + ".uriRelativity.s";<a name="line.3436"></a> |
| <span class="sourceLineNo">3437</span><a name="line.3437"></a> |
| <span class="sourceLineNo">3438</span> /**<a name="line.3438"></a> |
| <span class="sourceLineNo">3439</span> * Configuration property: URI resolution.<a name="line.3439"></a> |
| <span class="sourceLineNo">3440</span> *<a name="line.3440"></a> |
| <span class="sourceLineNo">3441</span> * <h5 class='section'>Property:</h5><a name="line.3441"></a> |
| <span class="sourceLineNo">3442</span> * <ul class='spaced-list'><a name="line.3442"></a> |
| <span class="sourceLineNo">3443</span> * <li><b>ID:</b> {@link org.apache.juneau.rest.RestContext#REST_uriResolution REST_uriResolution}<a name="line.3443"></a> |
| <span class="sourceLineNo">3444</span> * <li><b>Name:</b> <js>"RestContext.uriResolution.s"</js><a name="line.3444"></a> |
| <span class="sourceLineNo">3445</span> * <li><b>Data type:</b> <c>String</c><a name="line.3445"></a> |
| <span class="sourceLineNo">3446</span> * <li><b>System property:</b> <c>RestContext.uriResolution</c><a name="line.3446"></a> |
| <span class="sourceLineNo">3447</span> * <li><b>Environment variable:</b> <c>RESTCONTEXT_URIRESOLUTION</c><a name="line.3447"></a> |
| <span class="sourceLineNo">3448</span> * <li><b>Default:</b> <js>"ROOT_RELATIVE"</js><a name="line.3448"></a> |
| <span class="sourceLineNo">3449</span> * <li><b>Session property:</b> <jk>false</jk><a name="line.3449"></a> |
| <span class="sourceLineNo">3450</span> * <li><b>Annotations:</b><a name="line.3450"></a> |
| <span class="sourceLineNo">3451</span> * <ul><a name="line.3451"></a> |
| <span class="sourceLineNo">3452</span> * <li class='ja'>{@link org.apache.juneau.rest.annotation.Rest#uriResolution()}<a name="line.3452"></a> |
| <span class="sourceLineNo">3453</span> * </ul><a name="line.3453"></a> |
| <span class="sourceLineNo">3454</span> * <li><b>Methods:</b><a name="line.3454"></a> |
| <span class="sourceLineNo">3455</span> * <ul><a name="line.3455"></a> |
| <span class="sourceLineNo">3456</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#uriResolution(String)}<a name="line.3456"></a> |
| <span class="sourceLineNo">3457</span> * </ul><a name="line.3457"></a> |
| <span class="sourceLineNo">3458</span> * </ul><a name="line.3458"></a> |
| <span class="sourceLineNo">3459</span> *<a name="line.3459"></a> |
| <span class="sourceLineNo">3460</span> * <h5 class='section'>Description:</h5><a name="line.3460"></a> |
| <span class="sourceLineNo">3461</span> * <p><a name="line.3461"></a> |
| <span class="sourceLineNo">3462</span> * Specifies how relative URIs should be interpreted by serializers.<a name="line.3462"></a> |
| <span class="sourceLineNo">3463</span> *<a name="line.3463"></a> |
| <span class="sourceLineNo">3464</span> * <p><a name="line.3464"></a> |
| <span class="sourceLineNo">3465</span> * See {@link UriResolution} for possible values.<a name="line.3465"></a> |
| <span class="sourceLineNo">3466</span> *<a name="line.3466"></a> |
| <span class="sourceLineNo">3467</span> * <p><a name="line.3467"></a> |
| <span class="sourceLineNo">3468</span> * Affects the following methods:<a name="line.3468"></a> |
| <span class="sourceLineNo">3469</span> * <ul class='javatree'><a name="line.3469"></a> |
| <span class="sourceLineNo">3470</span> * <li class='jm'>{@link RestRequest#getUriResolver()}<a name="line.3470"></a> |
| <span class="sourceLineNo">3471</span> * </ul><a name="line.3471"></a> |
| <span class="sourceLineNo">3472</span> *<a name="line.3472"></a> |
| <span class="sourceLineNo">3473</span> * <h5 class='section'>Example:</h5><a name="line.3473"></a> |
| <span class="sourceLineNo">3474</span> * <p class='bcode w800'><a name="line.3474"></a> |
| <span class="sourceLineNo">3475</span> * <jc>// Option #1 - Defined via annotation resolving to a config file setting with default value.</jc><a name="line.3475"></a> |
| <span class="sourceLineNo">3476</span> * <ja>@Rest</ja>(<a name="line.3476"></a> |
| <span class="sourceLineNo">3477</span> * path=<js>"/servlet"</js>,<a name="line.3477"></a> |
| <span class="sourceLineNo">3478</span> * uriResolution=<js>"$C{REST/uriResolution,ABSOLUTE}"</js><a name="line.3478"></a> |
| <span class="sourceLineNo">3479</span> * )<a name="line.3479"></a> |
| <span class="sourceLineNo">3480</span> * <jk>public class</jk> MyResource {<a name="line.3480"></a> |
| <span class="sourceLineNo">3481</span> *<a name="line.3481"></a> |
| <span class="sourceLineNo">3482</span> * <jc>// Option #2 - Defined via builder passed in through resource constructor.</jc><a name="line.3482"></a> |
| <span class="sourceLineNo">3483</span> * <jk>public</jk> MyResource(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3483"></a> |
| <span class="sourceLineNo">3484</span> *<a name="line.3484"></a> |
| <span class="sourceLineNo">3485</span> * <jc>// Using method on builder.</jc><a name="line.3485"></a> |
| <span class="sourceLineNo">3486</span> * builder.uriResolution(<js>"ABSOLUTE"</js>);<a name="line.3486"></a> |
| <span class="sourceLineNo">3487</span> *<a name="line.3487"></a> |
| <span class="sourceLineNo">3488</span> * <jc>// Same, but using property.</jc><a name="line.3488"></a> |
| <span class="sourceLineNo">3489</span> * builder.set(<jsf>REST_uriResolution</jsf>, <js>"ABSOLUTE"</js>);<a name="line.3489"></a> |
| <span class="sourceLineNo">3490</span> * }<a name="line.3490"></a> |
| <span class="sourceLineNo">3491</span> *<a name="line.3491"></a> |
| <span class="sourceLineNo">3492</span> * <jc>// Option #3 - Defined via builder passed in through init method.</jc><a name="line.3492"></a> |
| <span class="sourceLineNo">3493</span> * <ja>@RestHook</ja>(<jsf>INIT</jsf>)<a name="line.3493"></a> |
| <span class="sourceLineNo">3494</span> * <jk>public void</jk> init(RestContextBuilder builder) <jk>throws</jk> Exception {<a name="line.3494"></a> |
| <span class="sourceLineNo">3495</span> * builder.uriResolution(<js>"ABSOLUTE"</js>);<a name="line.3495"></a> |
| <span class="sourceLineNo">3496</span> * }<a name="line.3496"></a> |
| <span class="sourceLineNo">3497</span> * }<a name="line.3497"></a> |
| <span class="sourceLineNo">3498</span> * </p><a name="line.3498"></a> |
| <span class="sourceLineNo">3499</span> */<a name="line.3499"></a> |
| <span class="sourceLineNo">3500</span> public static final String REST_uriResolution = PREFIX + ".uriResolution.s";<a name="line.3500"></a> |
| <span class="sourceLineNo">3501</span><a name="line.3501"></a> |
| <span class="sourceLineNo">3502</span> /**<a name="line.3502"></a> |
| <span class="sourceLineNo">3503</span> * Configuration property: HTML Widgets.<a name="line.3503"></a> |
| <span class="sourceLineNo">3504</span> *<a name="line.3504"></a> |
| <span class="sourceLineNo">3505</span> * <div class='warn'><a name="line.3505"></a> |
| <span class="sourceLineNo">3506</span> * <b>Deprecated</b> - Use {@link HtmlDocSerializer#HTMLDOC_widgets}<a name="line.3506"></a> |
| <span class="sourceLineNo">3507</span> * </div><a name="line.3507"></a> |
| <span class="sourceLineNo">3508</span> */<a name="line.3508"></a> |
| <span class="sourceLineNo">3509</span> @Deprecated<a name="line.3509"></a> |
| <span class="sourceLineNo">3510</span> public static final String REST_widgets = PREFIX + ".widgets.lo";<a name="line.3510"></a> |
| <span class="sourceLineNo">3511</span><a name="line.3511"></a> |
| <span class="sourceLineNo">3512</span><a name="line.3512"></a> |
| <span class="sourceLineNo">3513</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.3513"></a> |
| <span class="sourceLineNo">3514</span> // Static<a name="line.3514"></a> |
| <span class="sourceLineNo">3515</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.3515"></a> |
| <span class="sourceLineNo">3516</span><a name="line.3516"></a> |
| <span class="sourceLineNo">3517</span> private static final Map<Class<?>, RestContext> REGISTRY = new ConcurrentHashMap<>();<a name="line.3517"></a> |
| <span class="sourceLineNo">3518</span><a name="line.3518"></a> |
| <span class="sourceLineNo">3519</span> /**<a name="line.3519"></a> |
| <span class="sourceLineNo">3520</span> * Returns a registry of all created {@link RestContext} objects.<a name="line.3520"></a> |
| <span class="sourceLineNo">3521</span> *<a name="line.3521"></a> |
| <span class="sourceLineNo">3522</span> * @return An unmodifiable map of resource classes to {@link RestContext} objects.<a name="line.3522"></a> |
| <span class="sourceLineNo">3523</span> */<a name="line.3523"></a> |
| <span class="sourceLineNo">3524</span> public static final Map<Class<?>, RestContext> getGlobalRegistry() {<a name="line.3524"></a> |
| <span class="sourceLineNo">3525</span> return Collections.unmodifiableMap(REGISTRY);<a name="line.3525"></a> |
| <span class="sourceLineNo">3526</span> }<a name="line.3526"></a> |
| <span class="sourceLineNo">3527</span><a name="line.3527"></a> |
| <span class="sourceLineNo">3528</span>// public static final Set<MethodExecStats> getGlobalExecStats() {<a name="line.3528"></a> |
| <span class="sourceLineNo">3529</span>// Set<MethodExecStats> s = new TreeSet<>();<a name="line.3529"></a> |
| <span class="sourceLineNo">3530</span>// for (RestContext rc : REGISTRY.values())<a name="line.3530"></a> |
| <span class="sourceLineNo">3531</span>// s.addAll(rc.getMethodExecStats());<a name="line.3531"></a> |
| <span class="sourceLineNo">3532</span>// return s;<a name="line.3532"></a> |
| <span class="sourceLineNo">3533</span>// }<a name="line.3533"></a> |
| <span class="sourceLineNo">3534</span>//<a name="line.3534"></a> |
| <span class="sourceLineNo">3535</span>//// public static final Set<ExceptionStats> getGlobalExceptions() {<a name="line.3535"></a> |
| <span class="sourceLineNo">3536</span>//// Set<ExceptionStats> s = new TreeSet<>();<a name="line.3536"></a> |
| <span class="sourceLineNo">3537</span>//// for (RestContext rc : REGISTRY.values())<a name="line.3537"></a> |
| <span class="sourceLineNo">3538</span>//// s.addAll(rc.getStackTraceDb().getClonedStackTraceInfos());<a name="line.3538"></a> |
| <span class="sourceLineNo">3539</span>//// return s;<a name="line.3539"></a> |
| <span class="sourceLineNo">3540</span>//// }<a name="line.3540"></a> |
| <span class="sourceLineNo">3541</span>//<a name="line.3541"></a> |
| <span class="sourceLineNo">3542</span>// public static final Set<StatusStats> getGlobalStatusStats() {<a name="line.3542"></a> |
| <span class="sourceLineNo">3543</span>// Set<StatusStats> s = new TreeSet<>();<a name="line.3543"></a> |
| <span class="sourceLineNo">3544</span>// for (RestContext rc : REGISTRY.values()) {<a name="line.3544"></a> |
| <span class="sourceLineNo">3545</span>// StatusStats ss = StatusStats.create(rc.getResource().getClass());<a name="line.3545"></a> |
| <span class="sourceLineNo">3546</span>// s.add(ss);<a name="line.3546"></a> |
| <span class="sourceLineNo">3547</span>// for (RestMethodContext rmc : rc.getCallMethods().values()) {<a name="line.3547"></a> |
| <span class="sourceLineNo">3548</span>// StatusStats.Method ssm = ss.getMethod(rmc.method);<a name="line.3548"></a> |
| <span class="sourceLineNo">3549</span>// for (Map.Entry<Integer,Integer> e : rmc.getStatusCodes().entrySet()) {<a name="line.3549"></a> |
| <span class="sourceLineNo">3550</span>// ssm.status(e.getKey(), e.getValue());<a name="line.3550"></a> |
| <span class="sourceLineNo">3551</span>// }<a name="line.3551"></a> |
| <span class="sourceLineNo">3552</span>// }<a name="line.3552"></a> |
| <span class="sourceLineNo">3553</span>// }<a name="line.3553"></a> |
| <span class="sourceLineNo">3554</span>// return s;<a name="line.3554"></a> |
| <span class="sourceLineNo">3555</span>// }<a name="line.3555"></a> |
| <span class="sourceLineNo">3556</span><a name="line.3556"></a> |
| <span class="sourceLineNo">3557</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.3557"></a> |
| <span class="sourceLineNo">3558</span> // Instance<a name="line.3558"></a> |
| <span class="sourceLineNo">3559</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.3559"></a> |
| <span class="sourceLineNo">3560</span><a name="line.3560"></a> |
| <span class="sourceLineNo">3561</span> private final Object resource;<a name="line.3561"></a> |
| <span class="sourceLineNo">3562</span> final RestContextBuilder builder;<a name="line.3562"></a> |
| <span class="sourceLineNo">3563</span> private final boolean<a name="line.3563"></a> |
| <span class="sourceLineNo">3564</span> allowBodyParam,<a name="line.3564"></a> |
| <span class="sourceLineNo">3565</span> renderResponseStackTraces,<a name="line.3565"></a> |
| <span class="sourceLineNo">3566</span> useClasspathResourceCaching;<a name="line.3566"></a> |
| <span class="sourceLineNo">3567</span> private final Enablement debug;<a name="line.3567"></a> |
| <span class="sourceLineNo">3568</span> @Deprecated private final boolean<a name="line.3568"></a> |
| <span class="sourceLineNo">3569</span> useStackTraceHashes;<a name="line.3569"></a> |
| <span class="sourceLineNo">3570</span> private final String<a name="line.3570"></a> |
| <span class="sourceLineNo">3571</span> clientVersionHeader,<a name="line.3571"></a> |
| <span class="sourceLineNo">3572</span> uriAuthority,<a name="line.3572"></a> |
| <span class="sourceLineNo">3573</span> uriContext;<a name="line.3573"></a> |
| <span class="sourceLineNo">3574</span> final String fullPath;<a name="line.3574"></a> |
| <span class="sourceLineNo">3575</span> final UrlPathPattern pathPattern;<a name="line.3575"></a> |
| <span class="sourceLineNo">3576</span><a name="line.3576"></a> |
| <span class="sourceLineNo">3577</span> private final Set<String> allowedMethodParams, allowedHeaderParams, allowedMethodHeaders;<a name="line.3577"></a> |
| <span class="sourceLineNo">3578</span><a name="line.3578"></a> |
| <span class="sourceLineNo">3579</span> private final RestContextProperties properties;<a name="line.3579"></a> |
| <span class="sourceLineNo">3580</span> private final Map<Class<?>,RestMethodParam> paramResolvers;<a name="line.3580"></a> |
| <span class="sourceLineNo">3581</span> private final SerializerGroup serializers;<a name="line.3581"></a> |
| <span class="sourceLineNo">3582</span> private final ParserGroup parsers;<a name="line.3582"></a> |
| <span class="sourceLineNo">3583</span> private final HttpPartSerializer partSerializer;<a name="line.3583"></a> |
| <span class="sourceLineNo">3584</span> private final HttpPartParser partParser;<a name="line.3584"></a> |
| <span class="sourceLineNo">3585</span> private final JsonSchemaGenerator jsonSchemaGenerator;<a name="line.3585"></a> |
| <span class="sourceLineNo">3586</span> private final List<MediaType><a name="line.3586"></a> |
| <span class="sourceLineNo">3587</span> consumes,<a name="line.3587"></a> |
| <span class="sourceLineNo">3588</span> produces;<a name="line.3588"></a> |
| <span class="sourceLineNo">3589</span> private final Map<String,Object><a name="line.3589"></a> |
| <span class="sourceLineNo">3590</span> reqHeaders,<a name="line.3590"></a> |
| <span class="sourceLineNo">3591</span> resHeaders,<a name="line.3591"></a> |
| <span class="sourceLineNo">3592</span> staticFileResponseHeaders;<a name="line.3592"></a> |
| <span class="sourceLineNo">3593</span> private final OMap reqAttrs;<a name="line.3593"></a> |
| <span class="sourceLineNo">3594</span> private final ResponseHandler[] responseHandlers;<a name="line.3594"></a> |
| <span class="sourceLineNo">3595</span> private final MimetypesFileTypeMap mimetypesFileTypeMap;<a name="line.3595"></a> |
| <span class="sourceLineNo">3596</span> private final StaticFiles[] staticFiles;<a name="line.3596"></a> |
| <span class="sourceLineNo">3597</span> private final String[] staticFilesPaths;<a name="line.3597"></a> |
| <span class="sourceLineNo">3598</span> private final Messages msgs;<a name="line.3598"></a> |
| <span class="sourceLineNo">3599</span> private final Config config;<a name="line.3599"></a> |
| <span class="sourceLineNo">3600</span> private final VarResolver varResolver;<a name="line.3600"></a> |
| <span class="sourceLineNo">3601</span> private final Map<String,List<RestMethodContext>> methodMap;<a name="line.3601"></a> |
| <span class="sourceLineNo">3602</span> private final List<RestMethodContext> methods;<a name="line.3602"></a> |
| <span class="sourceLineNo">3603</span> private final Map<String,RestContext> childResources;<a name="line.3603"></a> |
| <span class="sourceLineNo">3604</span> @SuppressWarnings("deprecation") private final RestLogger logger;<a name="line.3604"></a> |
| <span class="sourceLineNo">3605</span> private final RestCallLogger callLogger;<a name="line.3605"></a> |
| <span class="sourceLineNo">3606</span> private final RestCallLoggerConfig callLoggerConfig;<a name="line.3606"></a> |
| <span class="sourceLineNo">3607</span> private final StackTraceDatabase stackTraceDb;<a name="line.3607"></a> |
| <span class="sourceLineNo">3608</span> private final RestInfoProvider infoProvider;<a name="line.3608"></a> |
| <span class="sourceLineNo">3609</span> private final HttpException initException;<a name="line.3609"></a> |
| <span class="sourceLineNo">3610</span> private final RestContext parentContext;<a name="line.3610"></a> |
| <span class="sourceLineNo">3611</span> private final RestResourceResolver resourceResolver;<a name="line.3611"></a> |
| <span class="sourceLineNo">3612</span> private final UriResolution uriResolution;<a name="line.3612"></a> |
| <span class="sourceLineNo">3613</span> private final UriRelativity uriRelativity;<a name="line.3613"></a> |
| <span class="sourceLineNo">3614</span> private final ConcurrentHashMap<String,MethodExecStats> methodExecStats = new ConcurrentHashMap<>();<a name="line.3614"></a> |
| <span class="sourceLineNo">3615</span> private final Instant startTime;<a name="line.3615"></a> |
| <span class="sourceLineNo">3616</span> private final Map<Class<?>,ResponseBeanMeta> responseBeanMetas = new ConcurrentHashMap<>();<a name="line.3616"></a> |
| <span class="sourceLineNo">3617</span><a name="line.3617"></a> |
| <span class="sourceLineNo">3618</span> // Lifecycle methods<a name="line.3618"></a> |
| <span class="sourceLineNo">3619</span> private final MethodInvoker[]<a name="line.3619"></a> |
| <span class="sourceLineNo">3620</span> postInitMethods,<a name="line.3620"></a> |
| <span class="sourceLineNo">3621</span> postInitChildFirstMethods,<a name="line.3621"></a> |
| <span class="sourceLineNo">3622</span> preCallMethods,<a name="line.3622"></a> |
| <span class="sourceLineNo">3623</span> postCallMethods,<a name="line.3623"></a> |
| <span class="sourceLineNo">3624</span> startCallMethods,<a name="line.3624"></a> |
| <span class="sourceLineNo">3625</span> endCallMethods,<a name="line.3625"></a> |
| <span class="sourceLineNo">3626</span> destroyMethods;<a name="line.3626"></a> |
| <span class="sourceLineNo">3627</span> private final RestMethodParam[][]<a name="line.3627"></a> |
| <span class="sourceLineNo">3628</span> preCallMethodParams,<a name="line.3628"></a> |
| <span class="sourceLineNo">3629</span> postCallMethodParams;<a name="line.3629"></a> |
| <span class="sourceLineNo">3630</span> private final Class<?>[][]<a name="line.3630"></a> |
| <span class="sourceLineNo">3631</span> postInitMethodParams,<a name="line.3631"></a> |
| <span class="sourceLineNo">3632</span> postInitChildFirstMethodParams,<a name="line.3632"></a> |
| <span class="sourceLineNo">3633</span> startCallMethodParams,<a name="line.3633"></a> |
| <span class="sourceLineNo">3634</span> endCallMethodParams,<a name="line.3634"></a> |
| <span class="sourceLineNo">3635</span> destroyMethodParams;<a name="line.3635"></a> |
| <span class="sourceLineNo">3636</span><a name="line.3636"></a> |
| <span class="sourceLineNo">3637</span> // In-memory cache of images and stylesheets in the org.apache.juneau.rest.htdocs package.<a name="line.3637"></a> |
| <span class="sourceLineNo">3638</span> private final Map<String,StaticFile> staticFilesCache = new ConcurrentHashMap<>();<a name="line.3638"></a> |
| <span class="sourceLineNo">3639</span><a name="line.3639"></a> |
| <span class="sourceLineNo">3640</span> private final ResourceManager staticResourceManager;<a name="line.3640"></a> |
| <span class="sourceLineNo">3641</span> @Deprecated private final ConcurrentHashMap<Integer,AtomicInteger> stackTraceHashes = new ConcurrentHashMap<>();<a name="line.3641"></a> |
| <span class="sourceLineNo">3642</span><a name="line.3642"></a> |
| <span class="sourceLineNo">3643</span> private final ThreadLocal<RestCall> call = new ThreadLocal<>();<a name="line.3643"></a> |
| <span class="sourceLineNo">3644</span><a name="line.3644"></a> |
| <span class="sourceLineNo">3645</span> private final ReflectionMap<Enablement> debugEnablement;<a name="line.3645"></a> |
| <span class="sourceLineNo">3646</span><a name="line.3646"></a> |
| <span class="sourceLineNo">3647</span> /**<a name="line.3647"></a> |
| <span class="sourceLineNo">3648</span> * Constructor.<a name="line.3648"></a> |
| <span class="sourceLineNo">3649</span> *<a name="line.3649"></a> |
| <span class="sourceLineNo">3650</span> * @param resource The resource annotated with <ja>@Rest</ja>.<a name="line.3650"></a> |
| <span class="sourceLineNo">3651</span> * @return A new builder object.<a name="line.3651"></a> |
| <span class="sourceLineNo">3652</span> * @throws ServletException Something bad happened.<a name="line.3652"></a> |
| <span class="sourceLineNo">3653</span> */<a name="line.3653"></a> |
| <span class="sourceLineNo">3654</span> public static RestContextBuilder create(Object resource) throws ServletException {<a name="line.3654"></a> |
| <span class="sourceLineNo">3655</span> return new RestContextBuilder(null, resource.getClass(), null).init(resource);<a name="line.3655"></a> |
| <span class="sourceLineNo">3656</span> }<a name="line.3656"></a> |
| <span class="sourceLineNo">3657</span><a name="line.3657"></a> |
| <span class="sourceLineNo">3658</span> /**<a name="line.3658"></a> |
| <span class="sourceLineNo">3659</span> * Constructor.<a name="line.3659"></a> |
| <span class="sourceLineNo">3660</span> *<a name="line.3660"></a> |
| <span class="sourceLineNo">3661</span> * @param servletConfig The servlet config passed into the servlet by the servlet container.<a name="line.3661"></a> |
| <span class="sourceLineNo">3662</span> * @param resourceClass The class annotated with <ja>@Rest</ja>.<a name="line.3662"></a> |
| <span class="sourceLineNo">3663</span> * @param parentContext The parent context, or <jk>null</jk> if there is no parent context.<a name="line.3663"></a> |
| <span class="sourceLineNo">3664</span> * @return A new builder object.<a name="line.3664"></a> |
| <span class="sourceLineNo">3665</span> * @throws ServletException Something bad happened.<a name="line.3665"></a> |
| <span class="sourceLineNo">3666</span> */<a name="line.3666"></a> |
| <span class="sourceLineNo">3667</span> static RestContextBuilder create(ServletConfig servletConfig, Class<?> resourceClass, RestContext parentContext) throws ServletException {<a name="line.3667"></a> |
| <span class="sourceLineNo">3668</span> return new RestContextBuilder(servletConfig, resourceClass, parentContext);<a name="line.3668"></a> |
| <span class="sourceLineNo">3669</span> }<a name="line.3669"></a> |
| <span class="sourceLineNo">3670</span><a name="line.3670"></a> |
| <span class="sourceLineNo">3671</span> /**<a name="line.3671"></a> |
| <span class="sourceLineNo">3672</span> * Constructor.<a name="line.3672"></a> |
| <span class="sourceLineNo">3673</span> *<a name="line.3673"></a> |
| <span class="sourceLineNo">3674</span> * @param builder The servlet configuration object.<a name="line.3674"></a> |
| <span class="sourceLineNo">3675</span> * @throws Exception If any initialization problems were encountered.<a name="line.3675"></a> |
| <span class="sourceLineNo">3676</span> */<a name="line.3676"></a> |
| <span class="sourceLineNo">3677</span> @SuppressWarnings("deprecation")<a name="line.3677"></a> |
| <span class="sourceLineNo">3678</span> public RestContext(RestContextBuilder builder) throws Exception {<a name="line.3678"></a> |
| <span class="sourceLineNo">3679</span> super(builder.getPropertyStore());<a name="line.3679"></a> |
| <span class="sourceLineNo">3680</span><a name="line.3680"></a> |
| <span class="sourceLineNo">3681</span> startTime = Instant.now();<a name="line.3681"></a> |
| <span class="sourceLineNo">3682</span><a name="line.3682"></a> |
| <span class="sourceLineNo">3683</span> REGISTRY.put(builder.resourceClass, this);<a name="line.3683"></a> |
| <span class="sourceLineNo">3684</span><a name="line.3684"></a> |
| <span class="sourceLineNo">3685</span> HttpException _initException = null;<a name="line.3685"></a> |
| <span class="sourceLineNo">3686</span><a name="line.3686"></a> |
| <span class="sourceLineNo">3687</span> try {<a name="line.3687"></a> |
| <span class="sourceLineNo">3688</span> ServletContext servletContext = builder.servletContext;<a name="line.3688"></a> |
| <span class="sourceLineNo">3689</span><a name="line.3689"></a> |
| <span class="sourceLineNo">3690</span> this.resource = builder.resource;<a name="line.3690"></a> |
| <span class="sourceLineNo">3691</span> this.builder = builder;<a name="line.3691"></a> |
| <span class="sourceLineNo">3692</span> this.parentContext = builder.parentContext;<a name="line.3692"></a> |
| <span class="sourceLineNo">3693</span><a name="line.3693"></a> |
| <span class="sourceLineNo">3694</span> Object defaultResourceResolver = parentContext == null ? (resource instanceof RestResourceResolver ? resource : BasicRestResourceResolver.class) : parentContext.resourceResolver;<a name="line.3694"></a> |
| <span class="sourceLineNo">3695</span> resourceResolver = getInstanceProperty(REST_resourceResolver, resource, RestResourceResolver.class, defaultResourceResolver, ResourceResolver.FUZZY, this);<a name="line.3695"></a> |
| <span class="sourceLineNo">3696</span><a name="line.3696"></a> |
| <span class="sourceLineNo">3697</span> varResolver = builder.varResolverBuilder<a name="line.3697"></a> |
| <span class="sourceLineNo">3698</span> .vars(<a name="line.3698"></a> |
| <span class="sourceLineNo">3699</span> FileVar.class,<a name="line.3699"></a> |
| <span class="sourceLineNo">3700</span> LocalizationVar.class,<a name="line.3700"></a> |
| <span class="sourceLineNo">3701</span> RequestAttributeVar.class,<a name="line.3701"></a> |
| <span class="sourceLineNo">3702</span> RequestFormDataVar.class,<a name="line.3702"></a> |
| <span class="sourceLineNo">3703</span> RequestHeaderVar.class,<a name="line.3703"></a> |
| <span class="sourceLineNo">3704</span> RequestPathVar.class,<a name="line.3704"></a> |
| <span class="sourceLineNo">3705</span> RequestQueryVar.class,<a name="line.3705"></a> |
| <span class="sourceLineNo">3706</span> RequestVar.class,<a name="line.3706"></a> |
| <span class="sourceLineNo">3707</span> RestInfoVar.class,<a name="line.3707"></a> |
| <span class="sourceLineNo">3708</span> SerializedRequestAttrVar.class,<a name="line.3708"></a> |
| <span class="sourceLineNo">3709</span> ServletInitParamVar.class,<a name="line.3709"></a> |
| <span class="sourceLineNo">3710</span> SwaggerVar.class,<a name="line.3710"></a> |
| <span class="sourceLineNo">3711</span> UrlVar.class,<a name="line.3711"></a> |
| <span class="sourceLineNo">3712</span> UrlEncodeVar.class,<a name="line.3712"></a> |
| <span class="sourceLineNo">3713</span> WidgetVar.class<a name="line.3713"></a> |
| <span class="sourceLineNo">3714</span> )<a name="line.3714"></a> |
| <span class="sourceLineNo">3715</span> .build()<a name="line.3715"></a> |
| <span class="sourceLineNo">3716</span> ;<a name="line.3716"></a> |
| <span class="sourceLineNo">3717</span><a name="line.3717"></a> |
| <span class="sourceLineNo">3718</span> VarResolverSession vrs = this.varResolver.createSession();<a name="line.3718"></a> |
| <span class="sourceLineNo">3719</span> config = builder.config.resolving(vrs);<a name="line.3719"></a> |
| <span class="sourceLineNo">3720</span><a name="line.3720"></a> |
| <span class="sourceLineNo">3721</span> ClassInfo rci = ClassInfo.of(resource).resolved();<a name="line.3721"></a> |
| <span class="sourceLineNo">3722</span><a name="line.3722"></a> |
| <span class="sourceLineNo">3723</span> PropertyStore ps = getPropertyStore();<a name="line.3723"></a> |
| <span class="sourceLineNo">3724</span><a name="line.3724"></a> |
| <span class="sourceLineNo">3725</span> uriContext = nullIfEmpty(getStringProperty(REST_uriContext, null));<a name="line.3725"></a> |
| <span class="sourceLineNo">3726</span> uriAuthority = nullIfEmpty(getStringProperty(REST_uriAuthority, null));<a name="line.3726"></a> |
| <span class="sourceLineNo">3727</span> uriResolution = getProperty(REST_uriResolution, UriResolution.class, UriResolution.ROOT_RELATIVE);<a name="line.3727"></a> |
| <span class="sourceLineNo">3728</span> uriRelativity = getProperty(REST_uriRelativity, UriRelativity.class, UriRelativity.RESOURCE);<a name="line.3728"></a> |
| <span class="sourceLineNo">3729</span><a name="line.3729"></a> |
| <span class="sourceLineNo">3730</span> allowBodyParam = getBooleanProperty(REST_allowBodyParam, true);<a name="line.3730"></a> |
| <span class="sourceLineNo">3731</span> allowedHeaderParams = newUnmodifiableSortedCaseInsensitiveSet(getStringPropertyWithNone(REST_allowedHeaderParams, "Accept,Content-Type"));<a name="line.3731"></a> |
| <span class="sourceLineNo">3732</span> allowedMethodParams = newUnmodifiableSortedCaseInsensitiveSet(getStringPropertyWithNone(REST_allowedMethodParams, "HEAD,OPTIONS"));<a name="line.3732"></a> |
| <span class="sourceLineNo">3733</span> allowedMethodHeaders = newUnmodifiableSortedCaseInsensitiveSet(getStringPropertyWithNone(REST_allowedMethodHeaders, ""));<a name="line.3733"></a> |
| <span class="sourceLineNo">3734</span> renderResponseStackTraces = getBooleanProperty(REST_renderResponseStackTraces, false);<a name="line.3734"></a> |
| <span class="sourceLineNo">3735</span> useStackTraceHashes = getBooleanProperty(REST_useStackTraceHashes, true);<a name="line.3735"></a> |
| <span class="sourceLineNo">3736</span> clientVersionHeader = getStringProperty(REST_clientVersionHeader, "X-Client-Version");<a name="line.3736"></a> |
| <span class="sourceLineNo">3737</span><a name="line.3737"></a> |
| <span class="sourceLineNo">3738</span> ReflectionMap.Builder<Enablement> deb = ReflectionMap.create(Enablement.class);<a name="line.3738"></a> |
| <span class="sourceLineNo">3739</span> for (String s : split(getStringProperty(REST_debugOn, ""))) {<a name="line.3739"></a> |
| <span class="sourceLineNo">3740</span> s = s.trim();<a name="line.3740"></a> |
| <span class="sourceLineNo">3741</span> if (! s.isEmpty()) {<a name="line.3741"></a> |
| <span class="sourceLineNo">3742</span> int i = s.indexOf('=');<a name="line.3742"></a> |
| <span class="sourceLineNo">3743</span> if (i == -1)<a name="line.3743"></a> |
| <span class="sourceLineNo">3744</span> deb.append(s.trim(), Enablement.TRUE);<a name="line.3744"></a> |
| <span class="sourceLineNo">3745</span> else<a name="line.3745"></a> |
| <span class="sourceLineNo">3746</span> deb.append(s.substring(0, i).trim(), Enablement.fromString(s.substring(i+1).trim()));<a name="line.3746"></a> |
| <span class="sourceLineNo">3747</span> }<a name="line.3747"></a> |
| <span class="sourceLineNo">3748</span> }<a name="line.3748"></a> |
| <span class="sourceLineNo">3749</span><a name="line.3749"></a> |
| <span class="sourceLineNo">3750</span> boolean debug = isDebug();<a name="line.3750"></a> |
| <span class="sourceLineNo">3751</span><a name="line.3751"></a> |
| <span class="sourceLineNo">3752</span> Enablement de = getInstanceProperty(REST_debug, Enablement.class, debug ? Enablement.TRUE : Enablement.FALSE);<a name="line.3752"></a> |
| <span class="sourceLineNo">3753</span> if (de != null)<a name="line.3753"></a> |
| <span class="sourceLineNo">3754</span> deb.append(rci.getFullName(), de);<a name="line.3754"></a> |
| <span class="sourceLineNo">3755</span> for (MethodInfo mi : rci.getPublicMethods())<a name="line.3755"></a> |
| <span class="sourceLineNo">3756</span> for (RestMethod a : mi.getAnnotations(RestMethod.class))<a name="line.3756"></a> |
| <span class="sourceLineNo">3757</span> if (a != null && ! a.debug().isEmpty())<a name="line.3757"></a> |
| <span class="sourceLineNo">3758</span> deb.append(mi.getFullName(), Enablement.fromString(a.debug()));<a name="line.3758"></a> |
| <span class="sourceLineNo">3759</span><a name="line.3759"></a> |
| <span class="sourceLineNo">3760</span> this.debugEnablement = deb.build();<a name="line.3760"></a> |
| <span class="sourceLineNo">3761</span><a name="line.3761"></a> |
| <span class="sourceLineNo">3762</span> this.debug = debugEnablement.find(rci.inner(), Enablement.class).orElse(Enablement.FALSE);<a name="line.3762"></a> |
| <span class="sourceLineNo">3763</span><a name="line.3763"></a> |
| <span class="sourceLineNo">3764</span> responseHandlers = getInstanceArrayProperty(REST_responseHandlers, resource, ResponseHandler.class, new ResponseHandler[0], resourceResolver, this);<a name="line.3764"></a> |
| <span class="sourceLineNo">3765</span><a name="line.3765"></a> |
| <span class="sourceLineNo">3766</span> AMap<Class<?>,RestMethodParam> _paramResolvers = AMap.of();<a name="line.3766"></a> |
| <span class="sourceLineNo">3767</span> for (RestMethodParam rp : getInstanceArrayProperty(REST_paramResolvers, RestMethodParam.class, new RestMethodParam[0], resourceResolver, this))<a name="line.3767"></a> |
| <span class="sourceLineNo">3768</span> _paramResolvers.put(rp.forClass(), rp);<a name="line.3768"></a> |
| <span class="sourceLineNo">3769</span> paramResolvers = _paramResolvers.unmodifiable();<a name="line.3769"></a> |
| <span class="sourceLineNo">3770</span><a name="line.3770"></a> |
| <span class="sourceLineNo">3771</span> Map<String,Object> _reqHeaders = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);<a name="line.3771"></a> |
| <span class="sourceLineNo">3772</span> _reqHeaders.putAll(getMapProperty(REST_reqHeaders, String.class));<a name="line.3772"></a> |
| <span class="sourceLineNo">3773</span> reqHeaders = AMap.unmodifiable(_reqHeaders);<a name="line.3773"></a> |
| <span class="sourceLineNo">3774</span><a name="line.3774"></a> |
| <span class="sourceLineNo">3775</span> reqAttrs = new OMap(getMapProperty(REST_reqAttrs, Object.class)).unmodifiable();<a name="line.3775"></a> |
| <span class="sourceLineNo">3776</span> resHeaders = getMapProperty(REST_resHeaders, Object.class);<a name="line.3776"></a> |
| <span class="sourceLineNo">3777</span> staticFileResponseHeaders = getMapProperty(REST_staticFileResponseHeaders, Object.class);<a name="line.3777"></a> |
| <span class="sourceLineNo">3778</span><a name="line.3778"></a> |
| <span class="sourceLineNo">3779</span> logger = getInstanceProperty(REST_logger, resource, RestLogger.class, NoOpRestLogger.class, resourceResolver, this);<a name="line.3779"></a> |
| <span class="sourceLineNo">3780</span><a name="line.3780"></a> |
| <span class="sourceLineNo">3781</span> Object clc = getProperty(REST_callLoggerConfig);<a name="line.3781"></a> |
| <span class="sourceLineNo">3782</span> if (this.debug == TRUE)<a name="line.3782"></a> |
| <span class="sourceLineNo">3783</span> this.callLoggerConfig = RestCallLoggerConfig.DEFAULT_DEBUG;<a name="line.3783"></a> |
| <span class="sourceLineNo">3784</span> else if (clc instanceof RestCallLoggerConfig)<a name="line.3784"></a> |
| <span class="sourceLineNo">3785</span> this.callLoggerConfig = (RestCallLoggerConfig)clc;<a name="line.3785"></a> |
| <span class="sourceLineNo">3786</span> else if (clc instanceof OMap)<a name="line.3786"></a> |
| <span class="sourceLineNo">3787</span> this.callLoggerConfig = RestCallLoggerConfig.create().apply((OMap)clc).build();<a name="line.3787"></a> |
| <span class="sourceLineNo">3788</span> else<a name="line.3788"></a> |
| <span class="sourceLineNo">3789</span> this.callLoggerConfig = RestCallLoggerConfig.DEFAULT_NOOP;<a name="line.3789"></a> |
| <span class="sourceLineNo">3790</span><a name="line.3790"></a> |
| <span class="sourceLineNo">3791</span> this.stackTraceDb = new StackTraceDatabase(callLoggerConfig.getStackTraceHashingTimeout(), RestMethodContext.class);<a name="line.3791"></a> |
| <span class="sourceLineNo">3792</span><a name="line.3792"></a> |
| <span class="sourceLineNo">3793</span> Object defaultRestCallLogger = resource instanceof RestCallLogger ? resource : BasicRestCallLogger.class;<a name="line.3793"></a> |
| <span class="sourceLineNo">3794</span> callLogger = getInstanceProperty(REST_callLogger, resource, RestCallLogger.class, defaultRestCallLogger, resourceResolver, this);<a name="line.3794"></a> |
| <span class="sourceLineNo">3795</span><a name="line.3795"></a> |
| <span class="sourceLineNo">3796</span> properties = builder.properties;<a name="line.3796"></a> |
| <span class="sourceLineNo">3797</span> serializers =<a name="line.3797"></a> |
| <span class="sourceLineNo">3798</span> SerializerGroup<a name="line.3798"></a> |
| <span class="sourceLineNo">3799</span> .create()<a name="line.3799"></a> |
| <span class="sourceLineNo">3800</span> .append(getInstanceArrayProperty(REST_serializers, Serializer.class, new Serializer[0], resourceResolver, resource, ps))<a name="line.3800"></a> |
| <span class="sourceLineNo">3801</span> .build();<a name="line.3801"></a> |
| <span class="sourceLineNo">3802</span> parsers =<a name="line.3802"></a> |
| <span class="sourceLineNo">3803</span> ParserGroup<a name="line.3803"></a> |
| <span class="sourceLineNo">3804</span> .create()<a name="line.3804"></a> |
| <span class="sourceLineNo">3805</span> .append(getInstanceArrayProperty(REST_parsers, Parser.class, new Parser[0], resourceResolver, resource, ps))<a name="line.3805"></a> |
| <span class="sourceLineNo">3806</span> .build();<a name="line.3806"></a> |
| <span class="sourceLineNo">3807</span> partSerializer = getInstanceProperty(REST_partSerializer, HttpPartSerializer.class, OpenApiSerializer.class, resourceResolver, resource, ps);<a name="line.3807"></a> |
| <span class="sourceLineNo">3808</span> partParser = getInstanceProperty(REST_partParser, HttpPartParser.class, OpenApiParser.class, resourceResolver, resource, ps);<a name="line.3808"></a> |
| <span class="sourceLineNo">3809</span> jsonSchemaGenerator =<a name="line.3809"></a> |
| <span class="sourceLineNo">3810</span> JsonSchemaGenerator<a name="line.3810"></a> |
| <span class="sourceLineNo">3811</span> .create()<a name="line.3811"></a> |
| <span class="sourceLineNo">3812</span> .apply(ps)<a name="line.3812"></a> |
| <span class="sourceLineNo">3813</span> .build();<a name="line.3813"></a> |
| <span class="sourceLineNo">3814</span><a name="line.3814"></a> |
| <span class="sourceLineNo">3815</span> mimetypesFileTypeMap = new ExtendedMimetypesFileTypeMap();<a name="line.3815"></a> |
| <span class="sourceLineNo">3816</span> for (String mimeType : getArrayProperty(REST_mimeTypes, String.class))<a name="line.3816"></a> |
| <span class="sourceLineNo">3817</span> mimetypesFileTypeMap.addMimeTypes(mimeType);<a name="line.3817"></a> |
| <span class="sourceLineNo">3818</span><a name="line.3818"></a> |
| <span class="sourceLineNo">3819</span> Object defaultResourceFinder = resource instanceof ResourceFinder ? resource : BasicResourceFinder.class;<a name="line.3819"></a> |
| <span class="sourceLineNo">3820</span> ResourceFinder rf = getInstanceProperty(REST_classpathResourceFinder, ResourceFinder.class, defaultResourceFinder, resourceResolver, this);<a name="line.3820"></a> |
| <span class="sourceLineNo">3821</span><a name="line.3821"></a> |
| <span class="sourceLineNo">3822</span> useClasspathResourceCaching = getProperty(REST_useClasspathResourceCaching, boolean.class, true);<a name="line.3822"></a> |
| <span class="sourceLineNo">3823</span> staticResourceManager = new ResourceManager(rci.inner(), rf, useClasspathResourceCaching);<a name="line.3823"></a> |
| <span class="sourceLineNo">3824</span><a name="line.3824"></a> |
| <span class="sourceLineNo">3825</span> consumes = getListProperty(REST_consumes, MediaType.class, parsers.getSupportedMediaTypes());<a name="line.3825"></a> |
| <span class="sourceLineNo">3826</span> produces = getListProperty(REST_produces, MediaType.class, serializers.getSupportedMediaTypes());<a name="line.3826"></a> |
| <span class="sourceLineNo">3827</span><a name="line.3827"></a> |
| <span class="sourceLineNo">3828</span> StaticFileMapping[] staticFileMappings = getArrayProperty(REST_staticFiles, StaticFileMapping.class, new StaticFileMapping[0]);<a name="line.3828"></a> |
| <span class="sourceLineNo">3829</span> staticFiles = new StaticFiles[staticFileMappings.length];<a name="line.3829"></a> |
| <span class="sourceLineNo">3830</span> for (int i = 0; i < staticFiles.length; i++)<a name="line.3830"></a> |
| <span class="sourceLineNo">3831</span> staticFiles[i] = new StaticFiles(staticFileMappings[i], staticResourceManager, mimetypesFileTypeMap, staticFileResponseHeaders);<a name="line.3831"></a> |
| <span class="sourceLineNo">3832</span><a name="line.3832"></a> |
| <span class="sourceLineNo">3833</span> Set<String> s = new TreeSet<>();<a name="line.3833"></a> |
| <span class="sourceLineNo">3834</span> for (StaticFiles sf : staticFiles)<a name="line.3834"></a> |
| <span class="sourceLineNo">3835</span> s.add(sf.getPath());<a name="line.3835"></a> |
| <span class="sourceLineNo">3836</span> staticFilesPaths = s.toArray(new String[s.size()]);<a name="line.3836"></a> |
| <span class="sourceLineNo">3837</span><a name="line.3837"></a> |
| <span class="sourceLineNo">3838</span> Tuple2<Class<?>,String>[] mbl = getInstanceArrayProperty(REST_messages, Tuple2.class, new Tuple2[0]);<a name="line.3838"></a> |
| <span class="sourceLineNo">3839</span> Messages msgs = null;<a name="line.3839"></a> |
| <span class="sourceLineNo">3840</span> for (int i = mbl.length-1; i >= 0; i--)<a name="line.3840"></a> |
| <span class="sourceLineNo">3841</span> msgs = Messages.create(firstNonNull(mbl[i].getA(), rci.inner())).name(mbl[i].getB()).parent(msgs).build();<a name="line.3841"></a> |
| <span class="sourceLineNo">3842</span> this.msgs = msgs;<a name="line.3842"></a> |
| <span class="sourceLineNo">3843</span><a name="line.3843"></a> |
| <span class="sourceLineNo">3844</span> this.fullPath = (builder.parentContext == null ? "" : (builder.parentContext.fullPath + '/')) + builder.getPath();<a name="line.3844"></a> |
| <span class="sourceLineNo">3845</span><a name="line.3845"></a> |
| <span class="sourceLineNo">3846</span> String p = builder.getPath();<a name="line.3846"></a> |
| <span class="sourceLineNo">3847</span> if (! p.endsWith("/*"))<a name="line.3847"></a> |
| <span class="sourceLineNo">3848</span> p += "/*";<a name="line.3848"></a> |
| <span class="sourceLineNo">3849</span> this.pathPattern = new UrlPathPattern(p);<a name="line.3849"></a> |
| <span class="sourceLineNo">3850</span><a name="line.3850"></a> |
| <span class="sourceLineNo">3851</span> this.childResources = Collections.synchronizedMap(new LinkedHashMap<String,RestContext>()); // Not unmodifiable on purpose so that children can be replaced.<a name="line.3851"></a> |
| <span class="sourceLineNo">3852</span><a name="line.3852"></a> |
| <span class="sourceLineNo">3853</span> //----------------------------------------------------------------------------------------------------<a name="line.3853"></a> |
| <span class="sourceLineNo">3854</span> // Initialize the child resources.<a name="line.3854"></a> |
| <span class="sourceLineNo">3855</span> // Done after initializing fields above since we pass this object to the child resources.<a name="line.3855"></a> |
| <span class="sourceLineNo">3856</span> //----------------------------------------------------------------------------------------------------<a name="line.3856"></a> |
| <span class="sourceLineNo">3857</span> List<String> methodsFound = new LinkedList<>(); // Temporary to help debug transient duplicate method issue.<a name="line.3857"></a> |
| <span class="sourceLineNo">3858</span> MethodMapBuilder methodMapBuilder = new MethodMapBuilder();<a name="line.3858"></a> |
| <span class="sourceLineNo">3859</span> AMap<String,Method><a name="line.3859"></a> |
| <span class="sourceLineNo">3860</span> _startCallMethods = AMap.of(),<a name="line.3860"></a> |
| <span class="sourceLineNo">3861</span> _preCallMethods = AMap.of(),<a name="line.3861"></a> |
| <span class="sourceLineNo">3862</span> _postCallMethods = AMap.of(),<a name="line.3862"></a> |
| <span class="sourceLineNo">3863</span> _endCallMethods = AMap.of(),<a name="line.3863"></a> |
| <span class="sourceLineNo">3864</span> _postInitMethods = AMap.of(),<a name="line.3864"></a> |
| <span class="sourceLineNo">3865</span> _postInitChildFirstMethods = AMap.of(),<a name="line.3865"></a> |
| <span class="sourceLineNo">3866</span> _destroyMethods = AMap.of();<a name="line.3866"></a> |
| <span class="sourceLineNo">3867</span> AList<RestMethodParam[]><a name="line.3867"></a> |
| <span class="sourceLineNo">3868</span> _preCallMethodParams = AList.of(),<a name="line.3868"></a> |
| <span class="sourceLineNo">3869</span> _postCallMethodParams = AList.of();<a name="line.3869"></a> |
| <span class="sourceLineNo">3870</span> AList<Class<?>[]><a name="line.3870"></a> |
| <span class="sourceLineNo">3871</span> _startCallMethodParams = AList.of(),<a name="line.3871"></a> |
| <span class="sourceLineNo">3872</span> _endCallMethodParams = AList.of(),<a name="line.3872"></a> |
| <span class="sourceLineNo">3873</span> _postInitMethodParams = AList.of(),<a name="line.3873"></a> |
| <span class="sourceLineNo">3874</span> _postInitChildFirstMethodParams = AList.of(),<a name="line.3874"></a> |
| <span class="sourceLineNo">3875</span> _destroyMethodParams = AList.of();<a name="line.3875"></a> |
| <span class="sourceLineNo">3876</span><a name="line.3876"></a> |
| <span class="sourceLineNo">3877</span> for (MethodInfo mi : rci.getPublicMethods()) {<a name="line.3877"></a> |
| <span class="sourceLineNo">3878</span> RestMethod a = mi.getLastAnnotation(RestMethod.class);<a name="line.3878"></a> |
| <span class="sourceLineNo">3879</span><a name="line.3879"></a> |
| <span class="sourceLineNo">3880</span> // Also include methods on @Rest-annotated interfaces.<a name="line.3880"></a> |
| <span class="sourceLineNo">3881</span> if (a == null) {<a name="line.3881"></a> |
| <span class="sourceLineNo">3882</span> for (Method mi2 : mi.getMatching()) {<a name="line.3882"></a> |
| <span class="sourceLineNo">3883</span> Class<?> ci2 = mi2.getDeclaringClass();<a name="line.3883"></a> |
| <span class="sourceLineNo">3884</span> if (ci2.isInterface() && ci2.getAnnotation(Rest.class) != null) {<a name="line.3884"></a> |
| <span class="sourceLineNo">3885</span> a = new RestMethodAnnotation();<a name="line.3885"></a> |
| <span class="sourceLineNo">3886</span> }<a name="line.3886"></a> |
| <span class="sourceLineNo">3887</span> }<a name="line.3887"></a> |
| <span class="sourceLineNo">3888</span> }<a name="line.3888"></a> |
| <span class="sourceLineNo">3889</span> if (a != null) {<a name="line.3889"></a> |
| <span class="sourceLineNo">3890</span> methodsFound.add(mi.getSimpleName() + "," + emptyIfNull(firstNonEmpty(a.name(), a.method())) + "," + fixMethodPath(a.path()));<a name="line.3890"></a> |
| <span class="sourceLineNo">3891</span> try {<a name="line.3891"></a> |
| <span class="sourceLineNo">3892</span> if (mi.isNotPublic())<a name="line.3892"></a> |
| <span class="sourceLineNo">3893</span> throw new RestServletException("@RestMethod method {0}.{1} must be defined as public.", rci.inner().getName(), mi.getSimpleName());<a name="line.3893"></a> |
| <span class="sourceLineNo">3894</span><a name="line.3894"></a> |
| <span class="sourceLineNo">3895</span> RestMethodContextBuilder rmcb = new RestMethodContextBuilder(resource, mi.inner(), this);<a name="line.3895"></a> |
| <span class="sourceLineNo">3896</span> RestMethodContext sm = new RestMethodContext(rmcb);<a name="line.3896"></a> |
| <span class="sourceLineNo">3897</span> String httpMethod = sm.getHttpMethod();<a name="line.3897"></a> |
| <span class="sourceLineNo">3898</span><a name="line.3898"></a> |
| <span class="sourceLineNo">3899</span> // RRPC is a special case where a method returns an interface that we<a name="line.3899"></a> |
| <span class="sourceLineNo">3900</span> // can perform REST calls against.<a name="line.3900"></a> |
| <span class="sourceLineNo">3901</span> // We override the CallMethod.invoke() method to insert our logic.<a name="line.3901"></a> |
| <span class="sourceLineNo">3902</span> if ("RRPC".equals(httpMethod)) {<a name="line.3902"></a> |
| <span class="sourceLineNo">3903</span><a name="line.3903"></a> |
| <span class="sourceLineNo">3904</span> final ClassMeta<?> interfaceClass = getClassMeta(mi.inner().getGenericReturnType());<a name="line.3904"></a> |
| <span class="sourceLineNo">3905</span> final RrpcInterfaceMeta rim = new RrpcInterfaceMeta(interfaceClass.getInnerClass(), null);<a name="line.3905"></a> |
| <span class="sourceLineNo">3906</span> if (rim.getMethodsByPath().isEmpty())<a name="line.3906"></a> |
| <span class="sourceLineNo">3907</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, "Method {0} returns an interface {1} that doesn't define any remote methods.", mi.getSignature(), interfaceClass.getFullName());<a name="line.3907"></a> |
| <span class="sourceLineNo">3908</span><a name="line.3908"></a> |
| <span class="sourceLineNo">3909</span> RestMethodContextBuilder smb = new RestMethodContextBuilder(resource, mi.inner(), this);<a name="line.3909"></a> |
| <span class="sourceLineNo">3910</span> smb.dotAll();<a name="line.3910"></a> |
| <span class="sourceLineNo">3911</span> sm = new RestMethodContext(smb) {<a name="line.3911"></a> |
| <span class="sourceLineNo">3912</span><a name="line.3912"></a> |
| <span class="sourceLineNo">3913</span> @Override<a name="line.3913"></a> |
| <span class="sourceLineNo">3914</span> void invoke(RestCall call) throws Throwable {<a name="line.3914"></a> |
| <span class="sourceLineNo">3915</span><a name="line.3915"></a> |
| <span class="sourceLineNo">3916</span> super.invoke(call);<a name="line.3916"></a> |
| <span class="sourceLineNo">3917</span><a name="line.3917"></a> |
| <span class="sourceLineNo">3918</span> final Object o = call.getOutput();<a name="line.3918"></a> |
| <span class="sourceLineNo">3919</span><a name="line.3919"></a> |
| <span class="sourceLineNo">3920</span> if ("GET".equals(call.getMethod())) {<a name="line.3920"></a> |
| <span class="sourceLineNo">3921</span> call.output(rim.getMethodsByPath().keySet());<a name="line.3921"></a> |
| <span class="sourceLineNo">3922</span> return;<a name="line.3922"></a> |
| <span class="sourceLineNo">3923</span><a name="line.3923"></a> |
| <span class="sourceLineNo">3924</span> } else if ("POST".equals(call.getMethod())) {<a name="line.3924"></a> |
| <span class="sourceLineNo">3925</span> String pip = call.getUrlPathInfo().getPath();<a name="line.3925"></a> |
| <span class="sourceLineNo">3926</span> if (pip.indexOf('/') != -1)<a name="line.3926"></a> |
| <span class="sourceLineNo">3927</span> pip = pip.substring(pip.lastIndexOf('/')+1);<a name="line.3927"></a> |
| <span class="sourceLineNo">3928</span> pip = urlDecode(pip);<a name="line.3928"></a> |
| <span class="sourceLineNo">3929</span> RrpcInterfaceMethodMeta rmm = rim.getMethodMetaByPath(pip);<a name="line.3929"></a> |
| <span class="sourceLineNo">3930</span> if (rmm != null) {<a name="line.3930"></a> |
| <span class="sourceLineNo">3931</span> Method m = rmm.getJavaMethod();<a name="line.3931"></a> |
| <span class="sourceLineNo">3932</span> try {<a name="line.3932"></a> |
| <span class="sourceLineNo">3933</span> RestRequest req = call.getRestRequest();<a name="line.3933"></a> |
| <span class="sourceLineNo">3934</span> // Parse the args and invoke the method.<a name="line.3934"></a> |
| <span class="sourceLineNo">3935</span> Parser p = req.getBody().getParser();<a name="line.3935"></a> |
| <span class="sourceLineNo">3936</span> Object[] args = null;<a name="line.3936"></a> |
| <span class="sourceLineNo">3937</span> if (m.getGenericParameterTypes().length == 0)<a name="line.3937"></a> |
| <span class="sourceLineNo">3938</span> args = new Object[0];<a name="line.3938"></a> |
| <span class="sourceLineNo">3939</span> else {<a name="line.3939"></a> |
| <span class="sourceLineNo">3940</span> try (Closeable in = p.isReaderParser() ? req.getReader() : req.getInputStream()) {<a name="line.3940"></a> |
| <span class="sourceLineNo">3941</span> args = p.parseArgs(in, m.getGenericParameterTypes());<a name="line.3941"></a> |
| <span class="sourceLineNo">3942</span> }<a name="line.3942"></a> |
| <span class="sourceLineNo">3943</span> }<a name="line.3943"></a> |
| <span class="sourceLineNo">3944</span> Object output = m.invoke(o, args);<a name="line.3944"></a> |
| <span class="sourceLineNo">3945</span> call.output(output);<a name="line.3945"></a> |
| <span class="sourceLineNo">3946</span> return;<a name="line.3946"></a> |
| <span class="sourceLineNo">3947</span> } catch (Exception e) {<a name="line.3947"></a> |
| <span class="sourceLineNo">3948</span> throw toHttpException(e, InternalServerError.class);<a name="line.3948"></a> |
| <span class="sourceLineNo">3949</span> }<a name="line.3949"></a> |
| <span class="sourceLineNo">3950</span> }<a name="line.3950"></a> |
| <span class="sourceLineNo">3951</span> }<a name="line.3951"></a> |
| <span class="sourceLineNo">3952</span> throw new NotFound();<a name="line.3952"></a> |
| <span class="sourceLineNo">3953</span> }<a name="line.3953"></a> |
| <span class="sourceLineNo">3954</span> };<a name="line.3954"></a> |
| <span class="sourceLineNo">3955</span><a name="line.3955"></a> |
| <span class="sourceLineNo">3956</span> methodMapBuilder.add("GET", sm).add("POST", sm);<a name="line.3956"></a> |
| <span class="sourceLineNo">3957</span><a name="line.3957"></a> |
| <span class="sourceLineNo">3958</span> } else {<a name="line.3958"></a> |
| <span class="sourceLineNo">3959</span> methodMapBuilder.add(httpMethod, sm);<a name="line.3959"></a> |
| <span class="sourceLineNo">3960</span> }<a name="line.3960"></a> |
| <span class="sourceLineNo">3961</span> } catch (Throwable e) {<a name="line.3961"></a> |
| <span class="sourceLineNo">3962</span> throw new RestServletException(e, "Problem occurred trying to initialize methods on class {0}, methods={1}", rci.inner().getName(), SimpleJsonSerializer.DEFAULT.serialize(methodsFound));<a name="line.3962"></a> |
| <span class="sourceLineNo">3963</span> }<a name="line.3963"></a> |
| <span class="sourceLineNo">3964</span> }<a name="line.3964"></a> |
| <span class="sourceLineNo">3965</span> }<a name="line.3965"></a> |
| <span class="sourceLineNo">3966</span><a name="line.3966"></a> |
| <span class="sourceLineNo">3967</span> for (MethodInfo m : rci.getAllMethodsParentFirst()) {<a name="line.3967"></a> |
| <span class="sourceLineNo">3968</span> if (m.isPublic() && m.hasAnnotation(RestHook.class)) {<a name="line.3968"></a> |
| <span class="sourceLineNo">3969</span> HookEvent he = m.getLastAnnotation(RestHook.class).value();<a name="line.3969"></a> |
| <span class="sourceLineNo">3970</span> String sig = m.getSignature();<a name="line.3970"></a> |
| <span class="sourceLineNo">3971</span> switch(he) {<a name="line.3971"></a> |
| <span class="sourceLineNo">3972</span> case PRE_CALL: {<a name="line.3972"></a> |
| <span class="sourceLineNo">3973</span> if (! _preCallMethods.containsKey(sig)) {<a name="line.3973"></a> |
| <span class="sourceLineNo">3974</span> m.setAccessible();<a name="line.3974"></a> |
| <span class="sourceLineNo">3975</span> _preCallMethods.put(sig, m.inner());<a name="line.3975"></a> |
| <span class="sourceLineNo">3976</span> _preCallMethodParams.add(findParams(m, true, null));<a name="line.3976"></a> |
| <span class="sourceLineNo">3977</span> }<a name="line.3977"></a> |
| <span class="sourceLineNo">3978</span> break;<a name="line.3978"></a> |
| <span class="sourceLineNo">3979</span> }<a name="line.3979"></a> |
| <span class="sourceLineNo">3980</span> case POST_CALL: {<a name="line.3980"></a> |
| <span class="sourceLineNo">3981</span> if (! _postCallMethods.containsKey(sig)) {<a name="line.3981"></a> |
| <span class="sourceLineNo">3982</span> m.setAccessible();<a name="line.3982"></a> |
| <span class="sourceLineNo">3983</span> _postCallMethods.put(sig, m.inner());<a name="line.3983"></a> |
| <span class="sourceLineNo">3984</span> _postCallMethodParams.add(findParams(m, true, null));<a name="line.3984"></a> |
| <span class="sourceLineNo">3985</span> }<a name="line.3985"></a> |
| <span class="sourceLineNo">3986</span> break;<a name="line.3986"></a> |
| <span class="sourceLineNo">3987</span> }<a name="line.3987"></a> |
| <span class="sourceLineNo">3988</span> case START_CALL: {<a name="line.3988"></a> |
| <span class="sourceLineNo">3989</span> if (! _startCallMethods.containsKey(sig)) {<a name="line.3989"></a> |
| <span class="sourceLineNo">3990</span> m.setAccessible();<a name="line.3990"></a> |
| <span class="sourceLineNo">3991</span> _startCallMethods.put(sig, m.inner());<a name="line.3991"></a> |
| <span class="sourceLineNo">3992</span> _startCallMethodParams.add((Class<?>[])m.getRawParamTypes().toArray());<a name="line.3992"></a> |
| <span class="sourceLineNo">3993</span> assertArgsOnlyOfType(m, HttpServletRequest.class, HttpServletResponse.class);<a name="line.3993"></a> |
| <span class="sourceLineNo">3994</span> }<a name="line.3994"></a> |
| <span class="sourceLineNo">3995</span> break;<a name="line.3995"></a> |
| <span class="sourceLineNo">3996</span> }<a name="line.3996"></a> |
| <span class="sourceLineNo">3997</span> case END_CALL: {<a name="line.3997"></a> |
| <span class="sourceLineNo">3998</span> if (! _endCallMethods.containsKey(sig)) {<a name="line.3998"></a> |
| <span class="sourceLineNo">3999</span> m.setAccessible();<a name="line.3999"></a> |
| <span class="sourceLineNo">4000</span> _endCallMethods.put(sig, m.inner());<a name="line.4000"></a> |
| <span class="sourceLineNo">4001</span> _endCallMethodParams.add((Class<?>[])m.getRawParamTypes().toArray());<a name="line.4001"></a> |
| <span class="sourceLineNo">4002</span> assertArgsOnlyOfType(m, HttpServletRequest.class, HttpServletResponse.class);<a name="line.4002"></a> |
| <span class="sourceLineNo">4003</span> }<a name="line.4003"></a> |
| <span class="sourceLineNo">4004</span> break;<a name="line.4004"></a> |
| <span class="sourceLineNo">4005</span> }<a name="line.4005"></a> |
| <span class="sourceLineNo">4006</span> case POST_INIT: {<a name="line.4006"></a> |
| <span class="sourceLineNo">4007</span> if (! _postInitMethods.containsKey(sig)) {<a name="line.4007"></a> |
| <span class="sourceLineNo">4008</span> m.setAccessible();<a name="line.4008"></a> |
| <span class="sourceLineNo">4009</span> _postInitMethods.put(sig, m.inner());<a name="line.4009"></a> |
| <span class="sourceLineNo">4010</span> _postInitMethodParams.add((Class<?>[])m.getRawParamTypes().toArray());<a name="line.4010"></a> |
| <span class="sourceLineNo">4011</span> assertArgsOnlyOfType(m, RestContext.class);<a name="line.4011"></a> |
| <span class="sourceLineNo">4012</span> }<a name="line.4012"></a> |
| <span class="sourceLineNo">4013</span> break;<a name="line.4013"></a> |
| <span class="sourceLineNo">4014</span> }<a name="line.4014"></a> |
| <span class="sourceLineNo">4015</span> case POST_INIT_CHILD_FIRST: {<a name="line.4015"></a> |
| <span class="sourceLineNo">4016</span> if (! _postInitChildFirstMethods.containsKey(sig)) {<a name="line.4016"></a> |
| <span class="sourceLineNo">4017</span> m.setAccessible();<a name="line.4017"></a> |
| <span class="sourceLineNo">4018</span> _postInitChildFirstMethods.put(sig, m.inner());<a name="line.4018"></a> |
| <span class="sourceLineNo">4019</span> _postInitChildFirstMethodParams.add((Class<?>[])m.getRawParamTypes().toArray());<a name="line.4019"></a> |
| <span class="sourceLineNo">4020</span> assertArgsOnlyOfType(m, RestContext.class);<a name="line.4020"></a> |
| <span class="sourceLineNo">4021</span> }<a name="line.4021"></a> |
| <span class="sourceLineNo">4022</span> break;<a name="line.4022"></a> |
| <span class="sourceLineNo">4023</span> }<a name="line.4023"></a> |
| <span class="sourceLineNo">4024</span> case DESTROY: {<a name="line.4024"></a> |
| <span class="sourceLineNo">4025</span> if (! _destroyMethods.containsKey(sig)) {<a name="line.4025"></a> |
| <span class="sourceLineNo">4026</span> m.setAccessible();<a name="line.4026"></a> |
| <span class="sourceLineNo">4027</span> _destroyMethods.put(sig, m.inner());<a name="line.4027"></a> |
| <span class="sourceLineNo">4028</span> _destroyMethodParams.add((Class<?>[])m.getRawParamTypes().toArray());<a name="line.4028"></a> |
| <span class="sourceLineNo">4029</span> assertArgsOnlyOfType(m, RestContext.class);<a name="line.4029"></a> |
| <span class="sourceLineNo">4030</span> }<a name="line.4030"></a> |
| <span class="sourceLineNo">4031</span> break;<a name="line.4031"></a> |
| <span class="sourceLineNo">4032</span> }<a name="line.4032"></a> |
| <span class="sourceLineNo">4033</span> default: // Ignore INIT<a name="line.4033"></a> |
| <span class="sourceLineNo">4034</span> }<a name="line.4034"></a> |
| <span class="sourceLineNo">4035</span> }<a name="line.4035"></a> |
| <span class="sourceLineNo">4036</span> }<a name="line.4036"></a> |
| <span class="sourceLineNo">4037</span><a name="line.4037"></a> |
| <span class="sourceLineNo">4038</span> this.preCallMethods = _preCallMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_preCallMethods.size()]);<a name="line.4038"></a> |
| <span class="sourceLineNo">4039</span> this.postCallMethods = _postCallMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_postCallMethods.size()]);<a name="line.4039"></a> |
| <span class="sourceLineNo">4040</span> this.startCallMethods = _startCallMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_startCallMethods.size()]);<a name="line.4040"></a> |
| <span class="sourceLineNo">4041</span> this.endCallMethods = _endCallMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_endCallMethods.size()]);<a name="line.4041"></a> |
| <span class="sourceLineNo">4042</span> this.postInitMethods = _postInitMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_postInitMethods.size()]);<a name="line.4042"></a> |
| <span class="sourceLineNo">4043</span> this.postInitChildFirstMethods = _postInitChildFirstMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_postInitChildFirstMethods.size()]);<a name="line.4043"></a> |
| <span class="sourceLineNo">4044</span> this.destroyMethods = _destroyMethods.values().stream().map(x->new MethodInvoker(x, getMethodExecStats(x))).collect(Collectors.toList()).toArray(new MethodInvoker[_destroyMethods.size()]);<a name="line.4044"></a> |
| <span class="sourceLineNo">4045</span> this.preCallMethodParams = _preCallMethodParams.toArray(new RestMethodParam[_preCallMethodParams.size()][]);<a name="line.4045"></a> |
| <span class="sourceLineNo">4046</span> this.postCallMethodParams = _postCallMethodParams.toArray(new RestMethodParam[_postCallMethodParams.size()][]);<a name="line.4046"></a> |
| <span class="sourceLineNo">4047</span> this.startCallMethodParams = _startCallMethodParams.toArray(new Class[_startCallMethodParams.size()][]);<a name="line.4047"></a> |
| <span class="sourceLineNo">4048</span> this.endCallMethodParams = _endCallMethodParams.toArray(new Class[_endCallMethodParams.size()][]);<a name="line.4048"></a> |
| <span class="sourceLineNo">4049</span> this.postInitMethodParams = _postInitMethodParams.toArray(new Class[_postInitMethodParams.size()][]);<a name="line.4049"></a> |
| <span class="sourceLineNo">4050</span> this.postInitChildFirstMethodParams = _postInitChildFirstMethodParams.toArray(new Class[_postInitChildFirstMethodParams.size()][]);<a name="line.4050"></a> |
| <span class="sourceLineNo">4051</span> this.destroyMethodParams = _destroyMethodParams.toArray(new Class[_destroyMethodParams.size()][]);<a name="line.4051"></a> |
| <span class="sourceLineNo">4052</span><a name="line.4052"></a> |
| <span class="sourceLineNo">4053</span> this.methodMap = methodMapBuilder.getMap();<a name="line.4053"></a> |
| <span class="sourceLineNo">4054</span> this.methods = methodMapBuilder.getList();<a name="line.4054"></a> |
| <span class="sourceLineNo">4055</span><a name="line.4055"></a> |
| <span class="sourceLineNo">4056</span> // Initialize our child resources.<a name="line.4056"></a> |
| <span class="sourceLineNo">4057</span> for (Object o : getArrayProperty(REST_children, Object.class)) {<a name="line.4057"></a> |
| <span class="sourceLineNo">4058</span> String path = null;<a name="line.4058"></a> |
| <span class="sourceLineNo">4059</span> Object r = null;<a name="line.4059"></a> |
| <span class="sourceLineNo">4060</span> if (o instanceof RestChild) {<a name="line.4060"></a> |
| <span class="sourceLineNo">4061</span> RestChild rc = (RestChild)o;<a name="line.4061"></a> |
| <span class="sourceLineNo">4062</span> path = rc.path;<a name="line.4062"></a> |
| <span class="sourceLineNo">4063</span> r = rc.resource;<a name="line.4063"></a> |
| <span class="sourceLineNo">4064</span> } else if (o instanceof Class<?>) {<a name="line.4064"></a> |
| <span class="sourceLineNo">4065</span> Class<?> c = (Class<?>)o;<a name="line.4065"></a> |
| <span class="sourceLineNo">4066</span> // Don't allow specifying yourself as a child. Causes an infinite loop.<a name="line.4066"></a> |
| <span class="sourceLineNo">4067</span> if (c == builder.resourceClass)<a name="line.4067"></a> |
| <span class="sourceLineNo">4068</span> continue;<a name="line.4068"></a> |
| <span class="sourceLineNo">4069</span> r = c;<a name="line.4069"></a> |
| <span class="sourceLineNo">4070</span> } else {<a name="line.4070"></a> |
| <span class="sourceLineNo">4071</span> r = o;<a name="line.4071"></a> |
| <span class="sourceLineNo">4072</span> }<a name="line.4072"></a> |
| <span class="sourceLineNo">4073</span><a name="line.4073"></a> |
| <span class="sourceLineNo">4074</span> RestContextBuilder childBuilder = null;<a name="line.4074"></a> |
| <span class="sourceLineNo">4075</span><a name="line.4075"></a> |
| <span class="sourceLineNo">4076</span> if (o instanceof Class) {<a name="line.4076"></a> |
| <span class="sourceLineNo">4077</span> Class<?> oc = (Class<?>)o;<a name="line.4077"></a> |
| <span class="sourceLineNo">4078</span> childBuilder = RestContext.create(builder.inner, oc, this);<a name="line.4078"></a> |
| <span class="sourceLineNo">4079</span> r = resourceResolver.resolve(resource, oc, childBuilder);<a name="line.4079"></a> |
| <span class="sourceLineNo">4080</span> } else {<a name="line.4080"></a> |
| <span class="sourceLineNo">4081</span> r = o;<a name="line.4081"></a> |
| <span class="sourceLineNo">4082</span> childBuilder = RestContext.create(builder.inner, o.getClass(), this);<a name="line.4082"></a> |
| <span class="sourceLineNo">4083</span> }<a name="line.4083"></a> |
| <span class="sourceLineNo">4084</span><a name="line.4084"></a> |
| <span class="sourceLineNo">4085</span> childBuilder.init(r);<a name="line.4085"></a> |
| <span class="sourceLineNo">4086</span> if (r instanceof RestServlet)<a name="line.4086"></a> |
| <span class="sourceLineNo">4087</span> ((RestServlet)r).innerInit(childBuilder);<a name="line.4087"></a> |
| <span class="sourceLineNo">4088</span> childBuilder.servletContext(servletContext);<a name="line.4088"></a> |
| <span class="sourceLineNo">4089</span> RestContext rc2 = childBuilder.build();<a name="line.4089"></a> |
| <span class="sourceLineNo">4090</span> if (r instanceof RestServlet)<a name="line.4090"></a> |
| <span class="sourceLineNo">4091</span> ((RestServlet)r).setContext(rc2);<a name="line.4091"></a> |
| <span class="sourceLineNo">4092</span> path = childBuilder.getPath();<a name="line.4092"></a> |
| <span class="sourceLineNo">4093</span> childResources.put(path, rc2);<a name="line.4093"></a> |
| <span class="sourceLineNo">4094</span> }<a name="line.4094"></a> |
| <span class="sourceLineNo">4095</span><a name="line.4095"></a> |
| <span class="sourceLineNo">4096</span> Object defaultRestInfoProvider = resource instanceof RestInfoProvider ? resource : BasicRestInfoProvider.class;<a name="line.4096"></a> |
| <span class="sourceLineNo">4097</span> infoProvider = getInstanceProperty(REST_infoProvider, resource, RestInfoProvider.class, defaultRestInfoProvider, resourceResolver, this);<a name="line.4097"></a> |
| <span class="sourceLineNo">4098</span><a name="line.4098"></a> |
| <span class="sourceLineNo">4099</span> } catch (HttpException e) {<a name="line.4099"></a> |
| <span class="sourceLineNo">4100</span> _initException = e;<a name="line.4100"></a> |
| <span class="sourceLineNo">4101</span> throw e;<a name="line.4101"></a> |
| <span class="sourceLineNo">4102</span> } catch (Exception e) {<a name="line.4102"></a> |
| <span class="sourceLineNo">4103</span> _initException = new InternalServerError(e);<a name="line.4103"></a> |
| <span class="sourceLineNo">4104</span> throw e;<a name="line.4104"></a> |
| <span class="sourceLineNo">4105</span> } finally {<a name="line.4105"></a> |
| <span class="sourceLineNo">4106</span> initException = _initException;<a name="line.4106"></a> |
| <span class="sourceLineNo">4107</span> }<a name="line.4107"></a> |
| <span class="sourceLineNo">4108</span> }<a name="line.4108"></a> |
| <span class="sourceLineNo">4109</span><a name="line.4109"></a> |
| <span class="sourceLineNo">4110</span> /**<a name="line.4110"></a> |
| <span class="sourceLineNo">4111</span> * Returns the resource resolver associated with this context.<a name="line.4111"></a> |
| <span class="sourceLineNo">4112</span> *<a name="line.4112"></a> |
| <span class="sourceLineNo">4113</span> * <p><a name="line.4113"></a> |
| <span class="sourceLineNo">4114</span> * The resource resolver is used for instantiating child resource classes.<a name="line.4114"></a> |
| <span class="sourceLineNo">4115</span> *<a name="line.4115"></a> |
| <span class="sourceLineNo">4116</span> * <ul class='seealso'><a name="line.4116"></a> |
| <span class="sourceLineNo">4117</span> * <li class='jf'>{@link #REST_resourceResolver}<a name="line.4117"></a> |
| <span class="sourceLineNo">4118</span> * </ul><a name="line.4118"></a> |
| <span class="sourceLineNo">4119</span> *<a name="line.4119"></a> |
| <span class="sourceLineNo">4120</span> * @return The resource resolver associated with this context.<a name="line.4120"></a> |
| <span class="sourceLineNo">4121</span> */<a name="line.4121"></a> |
| <span class="sourceLineNo">4122</span> protected RestResourceResolver getResourceResolver() {<a name="line.4122"></a> |
| <span class="sourceLineNo">4123</span> return resourceResolver;<a name="line.4123"></a> |
| <span class="sourceLineNo">4124</span> }<a name="line.4124"></a> |
| <span class="sourceLineNo">4125</span><a name="line.4125"></a> |
| <span class="sourceLineNo">4126</span> /**<a name="line.4126"></a> |
| <span class="sourceLineNo">4127</span> * Returns the time statistics gatherer for the specified method.<a name="line.4127"></a> |
| <span class="sourceLineNo">4128</span> *<a name="line.4128"></a> |
| <span class="sourceLineNo">4129</span> * @param m The method to get statistics for.<a name="line.4129"></a> |
| <span class="sourceLineNo">4130</span> * @return The cached time-stats object.<a name="line.4130"></a> |
| <span class="sourceLineNo">4131</span> */<a name="line.4131"></a> |
| <span class="sourceLineNo">4132</span> protected MethodExecStats getMethodExecStats(Method m) {<a name="line.4132"></a> |
| <span class="sourceLineNo">4133</span> String n = MethodInfo.of(m).getSimpleName();<a name="line.4133"></a> |
| <span class="sourceLineNo">4134</span> MethodExecStats ts = methodExecStats.get(n);<a name="line.4134"></a> |
| <span class="sourceLineNo">4135</span> if (ts == null) {<a name="line.4135"></a> |
| <span class="sourceLineNo">4136</span> methodExecStats.putIfAbsent(n, new MethodExecStats(m));<a name="line.4136"></a> |
| <span class="sourceLineNo">4137</span> ts = methodExecStats.get(n);<a name="line.4137"></a> |
| <span class="sourceLineNo">4138</span> }<a name="line.4138"></a> |
| <span class="sourceLineNo">4139</span> return ts;<a name="line.4139"></a> |
| <span class="sourceLineNo">4140</span> }<a name="line.4140"></a> |
| <span class="sourceLineNo">4141</span><a name="line.4141"></a> |
| <span class="sourceLineNo">4142</span> /**<a name="line.4142"></a> |
| <span class="sourceLineNo">4143</span> * Returns the variable resolver for this servlet.<a name="line.4143"></a> |
| <span class="sourceLineNo">4144</span> *<a name="line.4144"></a> |
| <span class="sourceLineNo">4145</span> * <p><a name="line.4145"></a> |
| <span class="sourceLineNo">4146</span> * Variable resolvers are used to replace variables in property values.<a name="line.4146"></a> |
| <span class="sourceLineNo">4147</span> * They can be nested arbitrarily deep.<a name="line.4147"></a> |
| <span class="sourceLineNo">4148</span> * They can also return values that themselves contain other variables.<a name="line.4148"></a> |
| <span class="sourceLineNo">4149</span> *<a name="line.4149"></a> |
| <span class="sourceLineNo">4150</span> * <h5 class='figure'>Example:</h5><a name="line.4150"></a> |
| <span class="sourceLineNo">4151</span> * <p class='bcode w800'><a name="line.4151"></a> |
| <span class="sourceLineNo">4152</span> * <ja>@Rest</ja>(<a name="line.4152"></a> |
| <span class="sourceLineNo">4153</span> * messages=<js>"nls/Messages"</js>,<a name="line.4153"></a> |
| <span class="sourceLineNo">4154</span> * properties={<a name="line.4154"></a> |
| <span class="sourceLineNo">4155</span> * <ja>@Property</ja>(name=<js>"title"</js>,value=<js>"$L{title}"</js>), <jc>// Localized variable in Messages.properties</jc><a name="line.4155"></a> |
| <span class="sourceLineNo">4156</span> * <ja>@Property</ja>(name=<js>"javaVendor"</js>,value=<js>"$S{java.vendor,Oracle}"</js>), <jc>// System property with default value</jc><a name="line.4156"></a> |
| <span class="sourceLineNo">4157</span> * <ja>@Property</ja>(name=<js>"foo"</js>,value=<js>"bar"</js>),<a name="line.4157"></a> |
| <span class="sourceLineNo">4158</span> * <ja>@Property</ja>(name=<js>"bar"</js>,value=<js>"baz"</js>),<a name="line.4158"></a> |
| <span class="sourceLineNo">4159</span> * <ja>@Property</ja>(name=<js>"v1"</js>,value=<js>"$R{foo}"</js>), <jc>// Request variable. value="bar"</jc><a name="line.4159"></a> |
| <span class="sourceLineNo">4160</span> * <ja>@Property</ja>(name=<js>"v1"</js>,value=<js>"$R{foo,bar}"</js>), <jc>// Request variable. value="bar"</jc><a name="line.4160"></a> |
| <span class="sourceLineNo">4161</span> * }<a name="line.4161"></a> |
| <span class="sourceLineNo">4162</span> * )<a name="line.4162"></a> |
| <span class="sourceLineNo">4163</span> * <jk>public class</jk> MyRestResource <jk>extends</jk> BasicRestServlet {<a name="line.4163"></a> |
| <span class="sourceLineNo">4164</span> * </p><a name="line.4164"></a> |
| <span class="sourceLineNo">4165</span> *<a name="line.4165"></a> |
| <span class="sourceLineNo">4166</span> * <p><a name="line.4166"></a> |
| <span class="sourceLineNo">4167</span> * A typical usage pattern involves using variables inside the {@link HtmlDocConfig @HtmlDocConfig} annotation:<a name="line.4167"></a> |
| <span class="sourceLineNo">4168</span> * <p class='bcode w800'><a name="line.4168"></a> |
| <span class="sourceLineNo">4169</span> * <ja>@RestMethod</ja>(<a name="line.4169"></a> |
| <span class="sourceLineNo">4170</span> * name=<jsf>GET</jsf>, path=<js>"/{name}/*"</js><a name="line.4170"></a> |
| <span class="sourceLineNo">4171</span> * )<a name="line.4171"></a> |
| <span class="sourceLineNo">4172</span> * <ja>@HtmlDocConfig</ja>(<a name="line.4172"></a> |
| <span class="sourceLineNo">4173</span> * navlinks={<a name="line.4173"></a> |
| <span class="sourceLineNo">4174</span> * <js>"up: $R{requestParentURI}"</js>,<a name="line.4174"></a> |
| <span class="sourceLineNo">4175</span> * <js>"options: servlet:/?method=OPTIONS"</js>,<a name="line.4175"></a> |
| <span class="sourceLineNo">4176</span> * <js>"stats: servlet:/stats"</js>,<a name="line.4176"></a> |
| <span class="sourceLineNo">4177</span> * <js>"editLevel: servlet:/editLevel?logger=$A{attribute.name, OFF}"</js><a name="line.4177"></a> |
| <span class="sourceLineNo">4178</span> * }<a name="line.4178"></a> |
| <span class="sourceLineNo">4179</span> * header={<a name="line.4179"></a> |
| <span class="sourceLineNo">4180</span> * <js>"&lt;h1&gt;$L{MyLocalizedPageTitle}&lt;/h1&gt;"</js><a name="line.4180"></a> |
| <span class="sourceLineNo">4181</span> * },<a name="line.4181"></a> |
| <span class="sourceLineNo">4182</span> * aside={<a name="line.4182"></a> |
| <span class="sourceLineNo">4183</span> * <js>"$F{resources/AsideText.html}"</js><a name="line.4183"></a> |
| <span class="sourceLineNo">4184</span> * }<a name="line.4184"></a> |
| <span class="sourceLineNo">4185</span> * )<a name="line.4185"></a> |
| <span class="sourceLineNo">4186</span> * <jk>public</jk> LoggerEntry getLogger(RestRequest req, <ja>@Path</ja> String name) <jk>throws</jk> Exception {<a name="line.4186"></a> |
| <span class="sourceLineNo">4187</span> * </p><a name="line.4187"></a> |
| <span class="sourceLineNo">4188</span> *<a name="line.4188"></a> |
| <span class="sourceLineNo">4189</span> * <ul class='seealso'><a name="line.4189"></a> |
| <span class="sourceLineNo">4190</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContextBuilder#vars(Class...)} - For adding custom vars.<a name="line.4190"></a> |
| <span class="sourceLineNo">4191</span> * <li class='link'>{@doc RestSvlVariables}<a name="line.4191"></a> |
| <span class="sourceLineNo">4192</span> * <li class='link'>{@doc RestSvlVariables}<a name="line.4192"></a> |
| <span class="sourceLineNo">4193</span> * </ul><a name="line.4193"></a> |
| <span class="sourceLineNo">4194</span> *<a name="line.4194"></a> |
| <span class="sourceLineNo">4195</span> * @return The var resolver in use by this resource.<a name="line.4195"></a> |
| <span class="sourceLineNo">4196</span> */<a name="line.4196"></a> |
| <span class="sourceLineNo">4197</span> public VarResolver getVarResolver() {<a name="line.4197"></a> |
| <span class="sourceLineNo">4198</span> return varResolver;<a name="line.4198"></a> |
| <span class="sourceLineNo">4199</span> }<a name="line.4199"></a> |
| <span class="sourceLineNo">4200</span><a name="line.4200"></a> |
| <span class="sourceLineNo">4201</span> /**<a name="line.4201"></a> |
| <span class="sourceLineNo">4202</span> * Returns the config file associated with this servlet.<a name="line.4202"></a> |
| <span class="sourceLineNo">4203</span> *<a name="line.4203"></a> |
| <span class="sourceLineNo">4204</span> * <p><a name="line.4204"></a> |
| <span class="sourceLineNo">4205</span> * The config file is identified via one of the following:<a name="line.4205"></a> |
| <span class="sourceLineNo">4206</span> * <ul class='javatree'><a name="line.4206"></a> |
| <span class="sourceLineNo">4207</span> * <li class='ja'>{@link Rest#config()}<a name="line.4207"></a> |
| <span class="sourceLineNo">4208</span> * <li class='jm'>{@link RestContextBuilder#config(Config)}<a name="line.4208"></a> |
| <span class="sourceLineNo">4209</span> * </ul><a name="line.4209"></a> |
| <span class="sourceLineNo">4210</span> *<a name="line.4210"></a> |
| <span class="sourceLineNo">4211</span> * @return<a name="line.4211"></a> |
| <span class="sourceLineNo">4212</span> * The resolving config file associated with this servlet.<a name="line.4212"></a> |
| <span class="sourceLineNo">4213</span> * <br>Never <jk>null</jk>.<a name="line.4213"></a> |
| <span class="sourceLineNo">4214</span> */<a name="line.4214"></a> |
| <span class="sourceLineNo">4215</span> public Config getConfig() {<a name="line.4215"></a> |
| <span class="sourceLineNo">4216</span> return config;<a name="line.4216"></a> |
| <span class="sourceLineNo">4217</span> }<a name="line.4217"></a> |
| <span class="sourceLineNo">4218</span><a name="line.4218"></a> |
| <span class="sourceLineNo">4219</span> /**<a name="line.4219"></a> |
| <span class="sourceLineNo">4220</span> * Resolve a static resource file.<a name="line.4220"></a> |
| <span class="sourceLineNo">4221</span> *<a name="line.4221"></a> |
| <span class="sourceLineNo">4222</span> * <p><a name="line.4222"></a> |
| <span class="sourceLineNo">4223</span> * The location of static resources are defined via:<a name="line.4223"></a> |
| <span class="sourceLineNo">4224</span> * <ul class='javatree'><a name="line.4224"></a> |
| <span class="sourceLineNo">4225</span> * <li class='jf'>{@link RestContext#REST_staticFiles RestContext.REST_staticFiles}<a name="line.4225"></a> |
| <span class="sourceLineNo">4226</span> * </ul><a name="line.4226"></a> |
| <span class="sourceLineNo">4227</span> *<a name="line.4227"></a> |
| <span class="sourceLineNo">4228</span> * @param pathInfo The unencoded path info.<a name="line.4228"></a> |
| <span class="sourceLineNo">4229</span> * @return The wrapped resource, never <jk>null</jk>.<a name="line.4229"></a> |
| <span class="sourceLineNo">4230</span> * @throws NotFound Invalid path.<a name="line.4230"></a> |
| <span class="sourceLineNo">4231</span> * @throws IOException Thrown by underlying stream.<a name="line.4231"></a> |
| <span class="sourceLineNo">4232</span> */<a name="line.4232"></a> |
| <span class="sourceLineNo">4233</span> protected StaticFile getStaticFile(String pathInfo) throws NotFound, IOException {<a name="line.4233"></a> |
| <span class="sourceLineNo">4234</span> if (! staticFilesCache.containsKey(pathInfo)) {<a name="line.4234"></a> |
| <span class="sourceLineNo">4235</span> String p = urlDecode(trimSlashes(pathInfo));<a name="line.4235"></a> |
| <span class="sourceLineNo">4236</span> if (p.indexOf("..") != -1)<a name="line.4236"></a> |
| <span class="sourceLineNo">4237</span> throw new NotFound("Invalid path");<a name="line.4237"></a> |
| <span class="sourceLineNo">4238</span> StaticFile sf = null;<a name="line.4238"></a> |
| <span class="sourceLineNo">4239</span> for (StaticFiles sfs : staticFiles) {<a name="line.4239"></a> |
| <span class="sourceLineNo">4240</span> sf = sfs.resolve(p);<a name="line.4240"></a> |
| <span class="sourceLineNo">4241</span> if (sf != null)<a name="line.4241"></a> |
| <span class="sourceLineNo">4242</span> break;<a name="line.4242"></a> |
| <span class="sourceLineNo">4243</span> }<a name="line.4243"></a> |
| <span class="sourceLineNo">4244</span> if (sf == null)<a name="line.4244"></a> |
| <span class="sourceLineNo">4245</span> sf = new StaticFile(null,null,null);<a name="line.4245"></a> |
| <span class="sourceLineNo">4246</span> if (useClasspathResourceCaching) {<a name="line.4246"></a> |
| <span class="sourceLineNo">4247</span> if (staticFilesCache.size() > 100)<a name="line.4247"></a> |
| <span class="sourceLineNo">4248</span> staticFilesCache.clear();<a name="line.4248"></a> |
| <span class="sourceLineNo">4249</span> staticFilesCache.put(pathInfo, sf);<a name="line.4249"></a> |
| <span class="sourceLineNo">4250</span> }<a name="line.4250"></a> |
| <span class="sourceLineNo">4251</span> return sf;<a name="line.4251"></a> |
| <span class="sourceLineNo">4252</span> }<a name="line.4252"></a> |
| <span class="sourceLineNo">4253</span> return staticFilesCache.get(pathInfo);<a name="line.4253"></a> |
| <span class="sourceLineNo">4254</span> }<a name="line.4254"></a> |
| <span class="sourceLineNo">4255</span><a name="line.4255"></a> |
| <span class="sourceLineNo">4256</span> /**<a name="line.4256"></a> |
| <span class="sourceLineNo">4257</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.4257"></a> |
| <span class="sourceLineNo">4258</span> * up the parent hierarchy chain.<a name="line.4258"></a> |
| <span class="sourceLineNo">4259</span> *<a name="line.4259"></a> |
| <span class="sourceLineNo">4260</span> * <p><a name="line.4260"></a> |
| <span class="sourceLineNo">4261</span> * If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.<a name="line.4261"></a> |
| <span class="sourceLineNo">4262</span> *<a name="line.4262"></a> |
| <span class="sourceLineNo">4263</span> * <p><a name="line.4263"></a> |
| <span class="sourceLineNo">4264</span> * If the <c>locale</c> is specified, then we look for resources whose name matches that locale.<a name="line.4264"></a> |
| <span class="sourceLineNo">4265</span> * <br>For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.4265"></a> |
| <span class="sourceLineNo">4266</span> * files in the following order:<a name="line.4266"></a> |
| <span class="sourceLineNo">4267</span> * <ol><a name="line.4267"></a> |
| <span class="sourceLineNo">4268</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.4268"></a> |
| <span class="sourceLineNo">4269</span> * <li><js>"MyResource_ja.txt"</js><a name="line.4269"></a> |
| <span class="sourceLineNo">4270</span> * <li><js>"MyResource.txt"</js><a name="line.4270"></a> |
| <span class="sourceLineNo">4271</span> * </ol><a name="line.4271"></a> |
| <span class="sourceLineNo">4272</span> *<a name="line.4272"></a> |
| <span class="sourceLineNo">4273</span> * <h5 class='section'>Example:</h5><a name="line.4273"></a> |
| <span class="sourceLineNo">4274</span> * <p class='bcode w800'><a name="line.4274"></a> |
| <span class="sourceLineNo">4275</span> * <jc>// A rest method that (unsafely!) returns the contents of a localized file </jc><a name="line.4275"></a> |
| <span class="sourceLineNo">4276</span> * <jc>// from the classpath.</jc><a name="line.4276"></a> |
| <span class="sourceLineNo">4277</span> * <ja>@RestMethod</ja>(path=<js>"/foo"</js>)<a name="line.4277"></a> |
| <span class="sourceLineNo">4278</span> * <jk>public</jk> Object myMethod(RestRequest req, <ja>@Query</ja>(<js>"file"</js>) String file) {<a name="line.4278"></a> |
| <span class="sourceLineNo">4279</span> * <jk>return</jk> getContext().getClasspathResource(file, req.getLocale());<a name="line.4279"></a> |
| <span class="sourceLineNo">4280</span> * }<a name="line.4280"></a> |
| <span class="sourceLineNo">4281</span> * </p><a name="line.4281"></a> |
| <span class="sourceLineNo">4282</span> *<a name="line.4282"></a> |
| <span class="sourceLineNo">4283</span> * <ul class='seealso'><a name="line.4283"></a> |
| <span class="sourceLineNo">4284</span> * <li class='jf'>{@link #REST_classpathResourceFinder}<a name="line.4284"></a> |
| <span class="sourceLineNo">4285</span> * </ul><a name="line.4285"></a> |
| <span class="sourceLineNo">4286</span> *<a name="line.4286"></a> |
| <span class="sourceLineNo">4287</span> * @param name The resource name.<a name="line.4287"></a> |
| <span class="sourceLineNo">4288</span> * @param locale<a name="line.4288"></a> |
| <span class="sourceLineNo">4289</span> * Optional locale.<a name="line.4289"></a> |
| <span class="sourceLineNo">4290</span> * <br>If <jk>null</jk>, won't look for localized file names.<a name="line.4290"></a> |
| <span class="sourceLineNo">4291</span> * @return An input stream of the resource, or <jk>null</jk> if the resource could not be found.<a name="line.4291"></a> |
| <span class="sourceLineNo">4292</span> * @throws IOException Thrown by underlying stream.<a name="line.4292"></a> |
| <span class="sourceLineNo">4293</span> */<a name="line.4293"></a> |
| <span class="sourceLineNo">4294</span> public InputStream getClasspathResource(String name, Locale locale) throws IOException {<a name="line.4294"></a> |
| <span class="sourceLineNo">4295</span> return staticResourceManager.getStream(name, locale);<a name="line.4295"></a> |
| <span class="sourceLineNo">4296</span> }<a name="line.4296"></a> |
| <span class="sourceLineNo">4297</span><a name="line.4297"></a> |
| <span class="sourceLineNo">4298</span> /**<a name="line.4298"></a> |
| <span class="sourceLineNo">4299</span> * Reads the input stream from {@link #getClasspathResource(String, Locale)} into a String.<a name="line.4299"></a> |
| <span class="sourceLineNo">4300</span> *<a name="line.4300"></a> |
| <span class="sourceLineNo">4301</span> * <h5 class='section'>Example:</h5><a name="line.4301"></a> |
| <span class="sourceLineNo">4302</span> * <p class='bcode w800'><a name="line.4302"></a> |
| <span class="sourceLineNo">4303</span> * <jc>// A rest method that (unsafely!) returns the contents of a localized file </jc><a name="line.4303"></a> |
| <span class="sourceLineNo">4304</span> * <jc>// from the classpath.</jc><a name="line.4304"></a> |
| <span class="sourceLineNo">4305</span> * <ja>@RestMethod</ja>(path=<js>"/foo"</js>)<a name="line.4305"></a> |
| <span class="sourceLineNo">4306</span> * <jk>public</jk> String myMethod(RestRequest req, <ja>@Query</ja>(<js>"file"</js>) String file) {<a name="line.4306"></a> |
| <span class="sourceLineNo">4307</span> * <jk>return</jk> getContext().getClasspathResourceAsString(file, req.getLocale());<a name="line.4307"></a> |
| <span class="sourceLineNo">4308</span> * }<a name="line.4308"></a> |
| <span class="sourceLineNo">4309</span> * </p><a name="line.4309"></a> |
| <span class="sourceLineNo">4310</span> *<a name="line.4310"></a> |
| <span class="sourceLineNo">4311</span> * <ul class='seealso'><a name="line.4311"></a> |
| <span class="sourceLineNo">4312</span> * <li class='jf'>{@link #REST_classpathResourceFinder}<a name="line.4312"></a> |
| <span class="sourceLineNo">4313</span> * </ul><a name="line.4313"></a> |
| <span class="sourceLineNo">4314</span> *<a name="line.4314"></a> |
| <span class="sourceLineNo">4315</span> * @param name The resource name.<a name="line.4315"></a> |
| <span class="sourceLineNo">4316</span> * @param locale<a name="line.4316"></a> |
| <span class="sourceLineNo">4317</span> * Optional locale.<a name="line.4317"></a> |
| <span class="sourceLineNo">4318</span> * <br>If <jk>null</jk>, won't look for localized file names.<a name="line.4318"></a> |
| <span class="sourceLineNo">4319</span> * @return The contents of the stream as a string, or <jk>null</jk> if the resource could not be found.<a name="line.4319"></a> |
| <span class="sourceLineNo">4320</span> * @throws IOException If resource could not be found.<a name="line.4320"></a> |
| <span class="sourceLineNo">4321</span> */<a name="line.4321"></a> |
| <span class="sourceLineNo">4322</span> public String getClasspathResourceAsString(String name, Locale locale) throws IOException {<a name="line.4322"></a> |
| <span class="sourceLineNo">4323</span> return staticResourceManager.getString(name, locale);<a name="line.4323"></a> |
| <span class="sourceLineNo">4324</span> }<a name="line.4324"></a> |
| <span class="sourceLineNo">4325</span><a name="line.4325"></a> |
| <span class="sourceLineNo">4326</span><a name="line.4326"></a> |
| <span class="sourceLineNo">4327</span> /**<a name="line.4327"></a> |
| <span class="sourceLineNo">4328</span> * Reads the input stream from {@link #getClasspathResource(String, Locale)} and parses it into a POJO using the parser<a name="line.4328"></a> |
| <span class="sourceLineNo">4329</span> * matched by the specified media type.<a name="line.4329"></a> |
| <span class="sourceLineNo">4330</span> *<a name="line.4330"></a> |
| <span class="sourceLineNo">4331</span> * <p><a name="line.4331"></a> |
| <span class="sourceLineNo">4332</span> * Useful if you want to load predefined POJOs from JSON files in your classpath.<a name="line.4332"></a> |
| <span class="sourceLineNo">4333</span> *<a name="line.4333"></a> |
| <span class="sourceLineNo">4334</span> * <h5 class='section'>Example:</h5><a name="line.4334"></a> |
| <span class="sourceLineNo">4335</span> * <p class='bcode w800'><a name="line.4335"></a> |
| <span class="sourceLineNo">4336</span> * <jc>// A rest method that (unsafely!) returns the contents of a localized file </jc><a name="line.4336"></a> |
| <span class="sourceLineNo">4337</span> * <jc>// from the classpath parsed as an array of beans.</jc><a name="line.4337"></a> |
| <span class="sourceLineNo">4338</span> * <ja>@RestMethod</ja>(path=<js>"/foo"</js>)<a name="line.4338"></a> |
| <span class="sourceLineNo">4339</span> * <jk>public</jk> MyBean[] myMethod(RestRequest req, <ja>@Query</ja>(<js>"file"</js>) String file) {<a name="line.4339"></a> |
| <span class="sourceLineNo">4340</span> * <jk>return</jk> getContext().getClasspathResource(MyBean[].<jk>class</jk>, <jsf>JSON</jsf>, file, req.getLocale());<a name="line.4340"></a> |
| <span class="sourceLineNo">4341</span> * }<a name="line.4341"></a> |
| <span class="sourceLineNo">4342</span> * </p><a name="line.4342"></a> |
| <span class="sourceLineNo">4343</span> *<a name="line.4343"></a> |
| <span class="sourceLineNo">4344</span> * <ul class='seealso'><a name="line.4344"></a> |
| <span class="sourceLineNo">4345</span> * <li class='jf'>{@link #REST_classpathResourceFinder}<a name="line.4345"></a> |
| <span class="sourceLineNo">4346</span> * </ul><a name="line.4346"></a> |
| <span class="sourceLineNo">4347</span> *<a name="line.4347"></a> |
| <span class="sourceLineNo">4348</span> * @param c The class type of the POJO to create.<a name="line.4348"></a> |
| <span class="sourceLineNo">4349</span> * @param mediaType The media type of the data in the stream (e.g. <js>"text/json"</js>)<a name="line.4349"></a> |
| <span class="sourceLineNo">4350</span> * @param name The resource name (e.g. "htdocs/styles.css").<a name="line.4350"></a> |
| <span class="sourceLineNo">4351</span> * @param locale<a name="line.4351"></a> |
| <span class="sourceLineNo">4352</span> * Optional locale.<a name="line.4352"></a> |
| <span class="sourceLineNo">4353</span> * <br>If <jk>null</jk>, won't look for localized file names.<a name="line.4353"></a> |
| <span class="sourceLineNo">4354</span> * @return The parsed resource, or <jk>null</jk> if the resource could not be found.<a name="line.4354"></a> |
| <span class="sourceLineNo">4355</span> * @throws IOException Thrown by underlying stream.<a name="line.4355"></a> |
| <span class="sourceLineNo">4356</span> * @throws ServletException If the media type was unknown or the input could not be parsed into a POJO.<a name="line.4356"></a> |
| <span class="sourceLineNo">4357</span> */<a name="line.4357"></a> |
| <span class="sourceLineNo">4358</span> public <T> T getClasspathResource(Class<T> c, MediaType mediaType, String name, Locale locale) throws IOException, ServletException {<a name="line.4358"></a> |
| <span class="sourceLineNo">4359</span> InputStream is = getClasspathResource(name, locale);<a name="line.4359"></a> |
| <span class="sourceLineNo">4360</span> if (is == null)<a name="line.4360"></a> |
| <span class="sourceLineNo">4361</span> return null;<a name="line.4361"></a> |
| <span class="sourceLineNo">4362</span> try {<a name="line.4362"></a> |
| <span class="sourceLineNo">4363</span> Parser p = parsers.getParser(mediaType);<a name="line.4363"></a> |
| <span class="sourceLineNo">4364</span> if (p == null) {<a name="line.4364"></a> |
| <span class="sourceLineNo">4365</span> if (mediaType == MediaType.JSON)<a name="line.4365"></a> |
| <span class="sourceLineNo">4366</span> p = JsonParser.DEFAULT;<a name="line.4366"></a> |
| <span class="sourceLineNo">4367</span> if (mediaType == MediaType.XML)<a name="line.4367"></a> |
| <span class="sourceLineNo">4368</span> p = XmlParser.DEFAULT;<a name="line.4368"></a> |
| <span class="sourceLineNo">4369</span> if (mediaType == MediaType.HTML)<a name="line.4369"></a> |
| <span class="sourceLineNo">4370</span> p = HtmlParser.DEFAULT;<a name="line.4370"></a> |
| <span class="sourceLineNo">4371</span> if (mediaType == MediaType.UON)<a name="line.4371"></a> |
| <span class="sourceLineNo">4372</span> p = UonParser.DEFAULT;<a name="line.4372"></a> |
| <span class="sourceLineNo">4373</span> if (mediaType == MediaType.URLENCODING)<a name="line.4373"></a> |
| <span class="sourceLineNo">4374</span> p = UrlEncodingParser.DEFAULT;<a name="line.4374"></a> |
| <span class="sourceLineNo">4375</span> if (mediaType == MediaType.MSGPACK)<a name="line.4375"></a> |
| <span class="sourceLineNo">4376</span> p = MsgPackParser.DEFAULT;<a name="line.4376"></a> |
| <span class="sourceLineNo">4377</span> }<a name="line.4377"></a> |
| <span class="sourceLineNo">4378</span> if (p != null) {<a name="line.4378"></a> |
| <span class="sourceLineNo">4379</span> try {<a name="line.4379"></a> |
| <span class="sourceLineNo">4380</span> try (Closeable in = p.isReaderParser() ? new InputStreamReader(is, UTF8) : is) {<a name="line.4380"></a> |
| <span class="sourceLineNo">4381</span> return p.parse(in, c);<a name="line.4381"></a> |
| <span class="sourceLineNo">4382</span> }<a name="line.4382"></a> |
| <span class="sourceLineNo">4383</span> } catch (ParseException e) {<a name="line.4383"></a> |
| <span class="sourceLineNo">4384</span> throw new ServletException("Could not parse resource '"+name+" as media type '"+mediaType+"'.", e);<a name="line.4384"></a> |
| <span class="sourceLineNo">4385</span> }<a name="line.4385"></a> |
| <span class="sourceLineNo">4386</span> }<a name="line.4386"></a> |
| <span class="sourceLineNo">4387</span> throw new ServletException("Unknown media type '"+mediaType+"'");<a name="line.4387"></a> |
| <span class="sourceLineNo">4388</span> } catch (Exception e) {<a name="line.4388"></a> |
| <span class="sourceLineNo">4389</span> throw new ServletException("Could not parse resource with name '"+name+"'", e);<a name="line.4389"></a> |
| <span class="sourceLineNo">4390</span> }<a name="line.4390"></a> |
| <span class="sourceLineNo">4391</span> }<a name="line.4391"></a> |
| <span class="sourceLineNo">4392</span><a name="line.4392"></a> |
| <span class="sourceLineNo">4393</span> /**<a name="line.4393"></a> |
| <span class="sourceLineNo">4394</span> * Returns the path for this resource as defined by the {@link Rest#path() @Rest(path)} annotation or<a name="line.4394"></a> |
| <span class="sourceLineNo">4395</span> * {@link RestContextBuilder#path(String)} method concatenated with those on all parent classes.<a name="line.4395"></a> |
| <span class="sourceLineNo">4396</span> *<a name="line.4396"></a> |
| <span class="sourceLineNo">4397</span> * <p><a name="line.4397"></a> |
| <span class="sourceLineNo">4398</span> * If path is not specified, returns <js>""</js>.<a name="line.4398"></a> |
| <span class="sourceLineNo">4399</span> *<a name="line.4399"></a> |
| <span class="sourceLineNo">4400</span> * <ul class='seealso'><a name="line.4400"></a> |
| <span class="sourceLineNo">4401</span> * <li class='jf'>{@link #REST_path}<a name="line.4401"></a> |
| <span class="sourceLineNo">4402</span> * </ul><a name="line.4402"></a> |
| <span class="sourceLineNo">4403</span> *<a name="line.4403"></a> |
| <span class="sourceLineNo">4404</span> * @return The servlet path.<a name="line.4404"></a> |
| <span class="sourceLineNo">4405</span> */<a name="line.4405"></a> |
| <span class="sourceLineNo">4406</span> public String getPath() {<a name="line.4406"></a> |
| <span class="sourceLineNo">4407</span> return fullPath;<a name="line.4407"></a> |
| <span class="sourceLineNo">4408</span> }<a name="line.4408"></a> |
| <span class="sourceLineNo">4409</span><a name="line.4409"></a> |
| <span class="sourceLineNo">4410</span> /**<a name="line.4410"></a> |
| <span class="sourceLineNo">4411</span> * Returns the logger to use for this resource.<a name="line.4411"></a> |
| <span class="sourceLineNo">4412</span> *<a name="line.4412"></a> |
| <span class="sourceLineNo">4413</span> * <div class='warn'><a name="line.4413"></a> |
| <span class="sourceLineNo">4414</span> * <b>Deprecated</b> - Use {@link #getCallLogger()}<a name="line.4414"></a> |
| <span class="sourceLineNo">4415</span> * </div><a name="line.4415"></a> |
| <span class="sourceLineNo">4416</span> *<a name="line.4416"></a> |
| <span class="sourceLineNo">4417</span> * <ul class='seealso'><a name="line.4417"></a> |
| <span class="sourceLineNo">4418</span> * <li class='jf'>{@link #REST_logger}<a name="line.4418"></a> |
| <span class="sourceLineNo">4419</span> * </ul><a name="line.4419"></a> |
| <span class="sourceLineNo">4420</span> *<a name="line.4420"></a> |
| <span class="sourceLineNo">4421</span> * @return<a name="line.4421"></a> |
| <span class="sourceLineNo">4422</span> * The logger to use for this resource.<a name="line.4422"></a> |
| <span class="sourceLineNo">4423</span> * <br>Never <jk>null</jk>.<a name="line.4423"></a> |
| <span class="sourceLineNo">4424</span> */<a name="line.4424"></a> |
| <span class="sourceLineNo">4425</span> @Deprecated<a name="line.4425"></a> |
| <span class="sourceLineNo">4426</span> public RestLogger getLogger() {<a name="line.4426"></a> |
| <span class="sourceLineNo">4427</span> return logger;<a name="line.4427"></a> |
| <span class="sourceLineNo">4428</span> }<a name="line.4428"></a> |
| <span class="sourceLineNo">4429</span><a name="line.4429"></a> |
| <span class="sourceLineNo">4430</span> /**<a name="line.4430"></a> |
| <span class="sourceLineNo">4431</span> * Returns the call logger to use for this resource.<a name="line.4431"></a> |
| <span class="sourceLineNo">4432</span> *<a name="line.4432"></a> |
| <span class="sourceLineNo">4433</span> * <ul class='seealso'><a name="line.4433"></a> |
| <span class="sourceLineNo">4434</span> * <li class='jf'>{@link #REST_callLogger}<a name="line.4434"></a> |
| <span class="sourceLineNo">4435</span> * </ul><a name="line.4435"></a> |
| <span class="sourceLineNo">4436</span> *<a name="line.4436"></a> |
| <span class="sourceLineNo">4437</span> * @return<a name="line.4437"></a> |
| <span class="sourceLineNo">4438</span> * The call logger to use for this resource.<a name="line.4438"></a> |
| <span class="sourceLineNo">4439</span> * <br>Never <jk>null</jk>.<a name="line.4439"></a> |
| <span class="sourceLineNo">4440</span> */<a name="line.4440"></a> |
| <span class="sourceLineNo">4441</span> public RestCallLogger getCallLogger() {<a name="line.4441"></a> |
| <span class="sourceLineNo">4442</span> return callLogger;<a name="line.4442"></a> |
| <span class="sourceLineNo">4443</span> }<a name="line.4443"></a> |
| <span class="sourceLineNo">4444</span><a name="line.4444"></a> |
| <span class="sourceLineNo">4445</span> /**<a name="line.4445"></a> |
| <span class="sourceLineNo">4446</span> * Returns the call logger config to use for this resource.<a name="line.4446"></a> |
| <span class="sourceLineNo">4447</span> *<a name="line.4447"></a> |
| <span class="sourceLineNo">4448</span> * <ul class='seealso'><a name="line.4448"></a> |
| <span class="sourceLineNo">4449</span> * <li class='jf'>{@link #REST_callLoggerConfig}<a name="line.4449"></a> |
| <span class="sourceLineNo">4450</span> * </ul><a name="line.4450"></a> |
| <span class="sourceLineNo">4451</span> *<a name="line.4451"></a> |
| <span class="sourceLineNo">4452</span> * @return<a name="line.4452"></a> |
| <span class="sourceLineNo">4453</span> * The call logger config to use for this resource.<a name="line.4453"></a> |
| <span class="sourceLineNo">4454</span> * <br>Never <jk>null</jk>.<a name="line.4454"></a> |
| <span class="sourceLineNo">4455</span> */<a name="line.4455"></a> |
| <span class="sourceLineNo">4456</span> public RestCallLoggerConfig getCallLoggerConfig() {<a name="line.4456"></a> |
| <span class="sourceLineNo">4457</span> return callLoggerConfig;<a name="line.4457"></a> |
| <span class="sourceLineNo">4458</span> }<a name="line.4458"></a> |
| <span class="sourceLineNo">4459</span><a name="line.4459"></a> |
| <span class="sourceLineNo">4460</span> /**<a name="line.4460"></a> |
| <span class="sourceLineNo">4461</span> * Returns the resource bundle used by this resource.<a name="line.4461"></a> |
| <span class="sourceLineNo">4462</span> *<a name="line.4462"></a> |
| <span class="sourceLineNo">4463</span> * <ul class='seealso'><a name="line.4463"></a> |
| <span class="sourceLineNo">4464</span> * <li class='jf'>{@link #REST_messages}<a name="line.4464"></a> |
| <span class="sourceLineNo">4465</span> * </ul><a name="line.4465"></a> |
| <span class="sourceLineNo">4466</span> *<a name="line.4466"></a> |
| <span class="sourceLineNo">4467</span> * @return<a name="line.4467"></a> |
| <span class="sourceLineNo">4468</span> * The resource bundle for this resource.<a name="line.4468"></a> |
| <span class="sourceLineNo">4469</span> * <br>Never <jk>null</jk>.<a name="line.4469"></a> |
| <span class="sourceLineNo">4470</span> */<a name="line.4470"></a> |
| <span class="sourceLineNo">4471</span> public Messages getMessages() {<a name="line.4471"></a> |
| <span class="sourceLineNo">4472</span> return msgs;<a name="line.4472"></a> |
| <span class="sourceLineNo">4473</span> }<a name="line.4473"></a> |
| <span class="sourceLineNo">4474</span><a name="line.4474"></a> |
| <span class="sourceLineNo">4475</span> /**<a name="line.4475"></a> |
| <span class="sourceLineNo">4476</span> * Returns the REST information provider used by this resource.<a name="line.4476"></a> |
| <span class="sourceLineNo">4477</span> *<a name="line.4477"></a> |
| <span class="sourceLineNo">4478</span> * <ul class='seealso'><a name="line.4478"></a> |
| <span class="sourceLineNo">4479</span> * <li class='jf'>{@link RestContext#REST_infoProvider}<a name="line.4479"></a> |
| <span class="sourceLineNo">4480</span> * </ul><a name="line.4480"></a> |
| <span class="sourceLineNo">4481</span> *<a name="line.4481"></a> |
| <span class="sourceLineNo">4482</span> * @return<a name="line.4482"></a> |
| <span class="sourceLineNo">4483</span> * The information provider for this resource.<a name="line.4483"></a> |
| <span class="sourceLineNo">4484</span> * <br>Never <jk>null</jk>.<a name="line.4484"></a> |
| <span class="sourceLineNo">4485</span> */<a name="line.4485"></a> |
| <span class="sourceLineNo">4486</span> public RestInfoProvider getInfoProvider() {<a name="line.4486"></a> |
| <span class="sourceLineNo">4487</span> return infoProvider;<a name="line.4487"></a> |
| <span class="sourceLineNo">4488</span> }<a name="line.4488"></a> |
| <span class="sourceLineNo">4489</span><a name="line.4489"></a> |
| <span class="sourceLineNo">4490</span> /**<a name="line.4490"></a> |
| <span class="sourceLineNo">4491</span> * Returns the resource object.<a name="line.4491"></a> |
| <span class="sourceLineNo">4492</span> *<a name="line.4492"></a> |
| <span class="sourceLineNo">4493</span> * <p><a name="line.4493"></a> |
| <span class="sourceLineNo">4494</span> * This is the instance of the class annotated with the {@link Rest @Rest} annotation, usually<a name="line.4494"></a> |
| <span class="sourceLineNo">4495</span> * an instance of {@link RestServlet}.<a name="line.4495"></a> |
| <span class="sourceLineNo">4496</span> *<a name="line.4496"></a> |
| <span class="sourceLineNo">4497</span> * @return<a name="line.4497"></a> |
| <span class="sourceLineNo">4498</span> * The resource object.<a name="line.4498"></a> |
| <span class="sourceLineNo">4499</span> * <br>Never <jk>null</jk>.<a name="line.4499"></a> |
| <span class="sourceLineNo">4500</span> */<a name="line.4500"></a> |
| <span class="sourceLineNo">4501</span> public Object getResource() {<a name="line.4501"></a> |
| <span class="sourceLineNo">4502</span> return resource;<a name="line.4502"></a> |
| <span class="sourceLineNo">4503</span> }<a name="line.4503"></a> |
| <span class="sourceLineNo">4504</span><a name="line.4504"></a> |
| <span class="sourceLineNo">4505</span> /**<a name="line.4505"></a> |
| <span class="sourceLineNo">4506</span> * Returns the resource object as a {@link RestServlet}.<a name="line.4506"></a> |
| <span class="sourceLineNo">4507</span> *<a name="line.4507"></a> |
| <span class="sourceLineNo">4508</span> * @return<a name="line.4508"></a> |
| <span class="sourceLineNo">4509</span> * The resource object cast to {@link RestServlet}, or <jk>null</jk> if the resource doesn't subclass from<a name="line.4509"></a> |
| <span class="sourceLineNo">4510</span> * {@link RestServlet}.<a name="line.4510"></a> |
| <span class="sourceLineNo">4511</span> */<a name="line.4511"></a> |
| <span class="sourceLineNo">4512</span> public RestServlet getRestServlet() {<a name="line.4512"></a> |
| <span class="sourceLineNo">4513</span> return resource instanceof RestServlet ? (RestServlet)resource : null;<a name="line.4513"></a> |
| <span class="sourceLineNo">4514</span> }<a name="line.4514"></a> |
| <span class="sourceLineNo">4515</span><a name="line.4515"></a> |
| <span class="sourceLineNo">4516</span> /**<a name="line.4516"></a> |
| <span class="sourceLineNo">4517</span> * Throws a {@link HttpException} if an exception occurred in the constructor of this object.<a name="line.4517"></a> |
| <span class="sourceLineNo">4518</span> *<a name="line.4518"></a> |
| <span class="sourceLineNo">4519</span> * @throws HttpException The initialization exception wrapped in a {@link HttpException}.<a name="line.4519"></a> |
| <span class="sourceLineNo">4520</span> */<a name="line.4520"></a> |
| <span class="sourceLineNo">4521</span> protected void checkForInitException() throws HttpException {<a name="line.4521"></a> |
| <span class="sourceLineNo">4522</span> if (initException != null)<a name="line.4522"></a> |
| <span class="sourceLineNo">4523</span> throw initException;<a name="line.4523"></a> |
| <span class="sourceLineNo">4524</span> }<a name="line.4524"></a> |
| <span class="sourceLineNo">4525</span><a name="line.4525"></a> |
| <span class="sourceLineNo">4526</span> /**<a name="line.4526"></a> |
| <span class="sourceLineNo">4527</span> * Returns the parent resource context (if this resource was initialized from a parent).<a name="line.4527"></a> |
| <span class="sourceLineNo">4528</span> *<a name="line.4528"></a> |
| <span class="sourceLineNo">4529</span> * <p><a name="line.4529"></a> |
| <span class="sourceLineNo">4530</span> * From this object, you can get access to the parent resource class itself using {@link #getResource()} or<a name="line.4530"></a> |
| <span class="sourceLineNo">4531</span> * {@link #getRestServlet()}<a name="line.4531"></a> |
| <span class="sourceLineNo">4532</span> *<a name="line.4532"></a> |
| <span class="sourceLineNo">4533</span> * @return The parent resource context, or <jk>null</jk> if there is no parent context.<a name="line.4533"></a> |
| <span class="sourceLineNo">4534</span> */<a name="line.4534"></a> |
| <span class="sourceLineNo">4535</span> public RestContext getParentContext() {<a name="line.4535"></a> |
| <span class="sourceLineNo">4536</span> return parentContext;<a name="line.4536"></a> |
| <span class="sourceLineNo">4537</span> }<a name="line.4537"></a> |
| <span class="sourceLineNo">4538</span><a name="line.4538"></a> |
| <span class="sourceLineNo">4539</span> /**<a name="line.4539"></a> |
| <span class="sourceLineNo">4540</span> * Returns the class-level properties associated with this servlet.<a name="line.4540"></a> |
| <span class="sourceLineNo">4541</span> *<a name="line.4541"></a> |
| <span class="sourceLineNo">4542</span> * <p><a name="line.4542"></a> |
| <span class="sourceLineNo">4543</span> * Properties at the class level are defined via the following:<a name="line.4543"></a> |
| <span class="sourceLineNo">4544</span> * <ul class='javatree'><a name="line.4544"></a> |
| <span class="sourceLineNo">4545</span> * <li class='ja'>{@link Rest#properties()}<a name="line.4545"></a> |
| <span class="sourceLineNo">4546</span> * <li class='jm'>{@link RestContextBuilder#set(String, Object)}<a name="line.4546"></a> |
| <span class="sourceLineNo">4547</span> * <li class='jm'>{@link RestContextBuilder#set(Map)}<a name="line.4547"></a> |
| <span class="sourceLineNo">4548</span> * </ul><a name="line.4548"></a> |
| <span class="sourceLineNo">4549</span> *<a name="line.4549"></a> |
| <span class="sourceLineNo">4550</span> * <ul class='notes'><a name="line.4550"></a> |
| <span class="sourceLineNo">4551</span> * <li><a name="line.4551"></a> |
| <span class="sourceLineNo">4552</span> * The returned {@code Map} is mutable.<a name="line.4552"></a> |
| <span class="sourceLineNo">4553</span> * <br>Therefore, subclasses are free to override or set additional initialization parameters in their {@code init()} method.<a name="line.4553"></a> |
| <span class="sourceLineNo">4554</span> * </ul><a name="line.4554"></a> |
| <span class="sourceLineNo">4555</span> *<a name="line.4555"></a> |
| <span class="sourceLineNo">4556</span> * @return The resource properties as a {@link RestContextProperties}.<a name="line.4556"></a> |
| <span class="sourceLineNo">4557</span> */<a name="line.4557"></a> |
| <span class="sourceLineNo">4558</span> public RestContextProperties getProperties() {<a name="line.4558"></a> |
| <span class="sourceLineNo">4559</span> return properties;<a name="line.4559"></a> |
| <span class="sourceLineNo">4560</span> }<a name="line.4560"></a> |
| <span class="sourceLineNo">4561</span><a name="line.4561"></a> |
| <span class="sourceLineNo">4562</span> /**<a name="line.4562"></a> |
| <span class="sourceLineNo">4563</span> * Returns the servlet init parameter returned by {@link ServletConfig#getInitParameter(String)}.<a name="line.4563"></a> |
| <span class="sourceLineNo">4564</span> *<a name="line.4564"></a> |
| <span class="sourceLineNo">4565</span> * @param name The init parameter name.<a name="line.4565"></a> |
| <span class="sourceLineNo">4566</span> * @return The servlet init parameter, or <jk>null</jk> if not found.<a name="line.4566"></a> |
| <span class="sourceLineNo">4567</span> */<a name="line.4567"></a> |
| <span class="sourceLineNo">4568</span> public String getServletInitParameter(String name) {<a name="line.4568"></a> |
| <span class="sourceLineNo">4569</span> return builder.getInitParameter(name);<a name="line.4569"></a> |
| <span class="sourceLineNo">4570</span> }<a name="line.4570"></a> |
| <span class="sourceLineNo">4571</span><a name="line.4571"></a> |
| <span class="sourceLineNo">4572</span> /**<a name="line.4572"></a> |
| <span class="sourceLineNo">4573</span> * Returns the child resources associated with this servlet.<a name="line.4573"></a> |
| <span class="sourceLineNo">4574</span> *<a name="line.4574"></a> |
| <span class="sourceLineNo">4575</span> * @return<a name="line.4575"></a> |
| <span class="sourceLineNo">4576</span> * An unmodifiable map of child resources.<a name="line.4576"></a> |
| <span class="sourceLineNo">4577</span> * Keys are the {@link Rest#path() @Rest(path)} annotation defined on the child resource.<a name="line.4577"></a> |
| <span class="sourceLineNo">4578</span> */<a name="line.4578"></a> |
| <span class="sourceLineNo">4579</span> public Map<String,RestContext> getChildResources() {<a name="line.4579"></a> |
| <span class="sourceLineNo">4580</span> return Collections.unmodifiableMap(childResources);<a name="line.4580"></a> |
| <span class="sourceLineNo">4581</span> }<a name="line.4581"></a> |
| <span class="sourceLineNo">4582</span><a name="line.4582"></a> |
| <span class="sourceLineNo">4583</span> /**<a name="line.4583"></a> |
| <span class="sourceLineNo">4584</span> * Returns the number of times this exception was thrown based on a hash of its stacktrace.<a name="line.4584"></a> |
| <span class="sourceLineNo">4585</span> *<a name="line.4585"></a> |
| <span class="sourceLineNo">4586</span> * <div class='warn'><a name="line.4586"></a> |
| <span class="sourceLineNo">4587</span> * <b>Deprecated</b> - Not used by new logging API.<a name="line.4587"></a> |
| <span class="sourceLineNo">4588</span> * </div><a name="line.4588"></a> |
| <span class="sourceLineNo">4589</span> *<a name="line.4589"></a> |
| <span class="sourceLineNo">4590</span> * <ul class='seealso'><a name="line.4590"></a> |
| <span class="sourceLineNo">4591</span> * <li class='jf'>{@link RestContext#REST_useStackTraceHashes}<a name="line.4591"></a> |
| <span class="sourceLineNo">4592</span> * </ul><a name="line.4592"></a> |
| <span class="sourceLineNo">4593</span> *<a name="line.4593"></a> |
| <span class="sourceLineNo">4594</span> * @param e The exception to check.<a name="line.4594"></a> |
| <span class="sourceLineNo">4595</span> * @return<a name="line.4595"></a> |
| <span class="sourceLineNo">4596</span> * The number of times this exception was thrown, or <c>0</c> if {@link #REST_useStackTraceHashes}<a name="line.4596"></a> |
| <span class="sourceLineNo">4597</span> * setting is not enabled.<a name="line.4597"></a> |
| <span class="sourceLineNo">4598</span> */<a name="line.4598"></a> |
| <span class="sourceLineNo">4599</span> @Deprecated<a name="line.4599"></a> |
| <span class="sourceLineNo">4600</span> public int getStackTraceOccurrence(Throwable e) {<a name="line.4600"></a> |
| <span class="sourceLineNo">4601</span> if (! useStackTraceHashes)<a name="line.4601"></a> |
| <span class="sourceLineNo">4602</span> return 0;<a name="line.4602"></a> |
| <span class="sourceLineNo">4603</span> int h = e.hashCode();<a name="line.4603"></a> |
| <span class="sourceLineNo">4604</span> stackTraceHashes.putIfAbsent(h, new AtomicInteger());<a name="line.4604"></a> |
| <span class="sourceLineNo">4605</span> return stackTraceHashes.get(h).incrementAndGet();<a name="line.4605"></a> |
| <span class="sourceLineNo">4606</span> }<a name="line.4606"></a> |
| <span class="sourceLineNo">4607</span><a name="line.4607"></a> |
| <span class="sourceLineNo">4608</span> /**<a name="line.4608"></a> |
| <span class="sourceLineNo">4609</span> * Returns whether it's safe to render stack traces in HTTP responses.<a name="line.4609"></a> |
| <span class="sourceLineNo">4610</span> *<a name="line.4610"></a> |
| <span class="sourceLineNo">4611</span> * <ul class='seealso'><a name="line.4611"></a> |
| <span class="sourceLineNo">4612</span> * <li class='jf'>{@link RestContext#REST_useStackTraceHashes}<a name="line.4612"></a> |
| <span class="sourceLineNo">4613</span> * </ul><a name="line.4613"></a> |
| <span class="sourceLineNo">4614</span> *<a name="line.4614"></a> |
| <span class="sourceLineNo">4615</span> * @return <jk>true</jk> if setting is enabled.<a name="line.4615"></a> |
| <span class="sourceLineNo">4616</span> */<a name="line.4616"></a> |
| <span class="sourceLineNo">4617</span> public boolean isRenderResponseStackTraces() {<a name="line.4617"></a> |
| <span class="sourceLineNo">4618</span> return renderResponseStackTraces;<a name="line.4618"></a> |
| <span class="sourceLineNo">4619</span> }<a name="line.4619"></a> |
| <span class="sourceLineNo">4620</span><a name="line.4620"></a> |
| <span class="sourceLineNo">4621</span> /**<a name="line.4621"></a> |
| <span class="sourceLineNo">4622</span> * Returns whether it's safe to pass the HTTP body as a <js>"body"</js> GET parameter.<a name="line.4622"></a> |
| <span class="sourceLineNo">4623</span> *<a name="line.4623"></a> |
| <span class="sourceLineNo">4624</span> * <ul class='seealso'><a name="line.4624"></a> |
| <span class="sourceLineNo">4625</span> * <li class='jf'>{@link RestContext#REST_allowBodyParam}<a name="line.4625"></a> |
| <span class="sourceLineNo">4626</span> * </ul><a name="line.4626"></a> |
| <span class="sourceLineNo">4627</span> *<a name="line.4627"></a> |
| <span class="sourceLineNo">4628</span> * @return <jk>true</jk> if setting is enabled.<a name="line.4628"></a> |
| <span class="sourceLineNo">4629</span> */<a name="line.4629"></a> |
| <span class="sourceLineNo">4630</span> public boolean isAllowBodyParam() {<a name="line.4630"></a> |
| <span class="sourceLineNo">4631</span> return allowBodyParam;<a name="line.4631"></a> |
| <span class="sourceLineNo">4632</span> }<a name="line.4632"></a> |
| <span class="sourceLineNo">4633</span><a name="line.4633"></a> |
| <span class="sourceLineNo">4634</span> /**<a name="line.4634"></a> |
| <span class="sourceLineNo">4635</span> * Allowed header URL parameters.<a name="line.4635"></a> |
| <span class="sourceLineNo">4636</span> *<a name="line.4636"></a> |
| <span class="sourceLineNo">4637</span> * <ul class='seealso'><a name="line.4637"></a> |
| <span class="sourceLineNo">4638</span> * <li class='jf'>{@link RestContext#REST_allowedHeaderParams}<a name="line.4638"></a> |
| <span class="sourceLineNo">4639</span> * </ul><a name="line.4639"></a> |
| <span class="sourceLineNo">4640</span> *<a name="line.4640"></a> |
| <span class="sourceLineNo">4641</span> * @return<a name="line.4641"></a> |
| <span class="sourceLineNo">4642</span> * The header names allowed to be passed as URL parameters.<a name="line.4642"></a> |
| <span class="sourceLineNo">4643</span> * <br>The set is case-insensitive ordered.<a name="line.4643"></a> |
| <span class="sourceLineNo">4644</span> */<a name="line.4644"></a> |
| <span class="sourceLineNo">4645</span> public Set<String> getAllowedHeaderParams() {<a name="line.4645"></a> |
| <span class="sourceLineNo">4646</span> return allowedHeaderParams;<a name="line.4646"></a> |
| <span class="sourceLineNo">4647</span> }<a name="line.4647"></a> |
| <span class="sourceLineNo">4648</span><a name="line.4648"></a> |
| <span class="sourceLineNo">4649</span> /**<a name="line.4649"></a> |
| <span class="sourceLineNo">4650</span> * Allowed method headers.<a name="line.4650"></a> |
| <span class="sourceLineNo">4651</span> *<a name="line.4651"></a> |
| <span class="sourceLineNo">4652</span> * <ul class='seealso'><a name="line.4652"></a> |
| <span class="sourceLineNo">4653</span> * <li class='jf'>{@link RestContext#REST_allowedMethodHeaders}<a name="line.4653"></a> |
| <span class="sourceLineNo">4654</span> * </ul><a name="line.4654"></a> |
| <span class="sourceLineNo">4655</span> *<a name="line.4655"></a> |
| <span class="sourceLineNo">4656</span> * @return<a name="line.4656"></a> |
| <span class="sourceLineNo">4657</span> * The method names allowed to be passed as <c>X-Method</c> headers.<a name="line.4657"></a> |
| <span class="sourceLineNo">4658</span> * <br>The set is case-insensitive ordered.<a name="line.4658"></a> |
| <span class="sourceLineNo">4659</span> */<a name="line.4659"></a> |
| <span class="sourceLineNo">4660</span> public Set<String> getAllowedMethodHeaders() {<a name="line.4660"></a> |
| <span class="sourceLineNo">4661</span> return allowedMethodHeaders;<a name="line.4661"></a> |
| <span class="sourceLineNo">4662</span> }<a name="line.4662"></a> |
| <span class="sourceLineNo">4663</span><a name="line.4663"></a> |
| <span class="sourceLineNo">4664</span> /**<a name="line.4664"></a> |
| <span class="sourceLineNo">4665</span> * Allowed method URL parameters.<a name="line.4665"></a> |
| <span class="sourceLineNo">4666</span> *<a name="line.4666"></a> |
| <span class="sourceLineNo">4667</span> * <ul class='seealso'><a name="line.4667"></a> |
| <span class="sourceLineNo">4668</span> * <li class='jf'>{@link RestContext#REST_allowedMethodParams}<a name="line.4668"></a> |
| <span class="sourceLineNo">4669</span> * </ul><a name="line.4669"></a> |
| <span class="sourceLineNo">4670</span> *<a name="line.4670"></a> |
| <span class="sourceLineNo">4671</span> * @return<a name="line.4671"></a> |
| <span class="sourceLineNo">4672</span> * The method names allowed to be passed as <c>method</c> URL parameters.<a name="line.4672"></a> |
| <span class="sourceLineNo">4673</span> * <br>The set is case-insensitive ordered.<a name="line.4673"></a> |
| <span class="sourceLineNo">4674</span> */<a name="line.4674"></a> |
| <span class="sourceLineNo">4675</span> public Set<String> getAllowedMethodParams() {<a name="line.4675"></a> |
| <span class="sourceLineNo">4676</span> return allowedMethodParams;<a name="line.4676"></a> |
| <span class="sourceLineNo">4677</span> }<a name="line.4677"></a> |
| <span class="sourceLineNo">4678</span><a name="line.4678"></a> |
| <span class="sourceLineNo">4679</span> /**<a name="line.4679"></a> |
| <span class="sourceLineNo">4680</span> * Returns the debug setting on this context for the specified method.<a name="line.4680"></a> |
| <span class="sourceLineNo">4681</span> *<a name="line.4681"></a> |
| <span class="sourceLineNo">4682</span> * @param method The java method.<a name="line.4682"></a> |
| <span class="sourceLineNo">4683</span> * @return The debug setting on this context or the debug value of the servlet context if not specified for this method.<a name="line.4683"></a> |
| <span class="sourceLineNo">4684</span> */<a name="line.4684"></a> |
| <span class="sourceLineNo">4685</span> public Enablement getDebug(Method method) {<a name="line.4685"></a> |
| <span class="sourceLineNo">4686</span> if (method == null)<a name="line.4686"></a> |
| <span class="sourceLineNo">4687</span> return null;<a name="line.4687"></a> |
| <span class="sourceLineNo">4688</span> return debugEnablement.find(method).orElse(debug);<a name="line.4688"></a> |
| <span class="sourceLineNo">4689</span> }<a name="line.4689"></a> |
| <span class="sourceLineNo">4690</span><a name="line.4690"></a> |
| <span class="sourceLineNo">4691</span> /**<a name="line.4691"></a> |
| <span class="sourceLineNo">4692</span> * Returns the name of the client version header name used by this resource.<a name="line.4692"></a> |
| <span class="sourceLineNo">4693</span> *<a name="line.4693"></a> |
| <span class="sourceLineNo">4694</span> * <ul class='seealso'><a name="line.4694"></a> |
| <span class="sourceLineNo">4695</span> * <li class='jf'>{@link RestContext#REST_clientVersionHeader}<a name="line.4695"></a> |
| <span class="sourceLineNo">4696</span> * </ul><a name="line.4696"></a> |
| <span class="sourceLineNo">4697</span> *<a name="line.4697"></a> |
| <span class="sourceLineNo">4698</span> * @return<a name="line.4698"></a> |
| <span class="sourceLineNo">4699</span> * The name of the client version header used by this resource.<a name="line.4699"></a> |
| <span class="sourceLineNo">4700</span> * <br>Never <jk>null</jk>.<a name="line.4700"></a> |
| <span class="sourceLineNo">4701</span> */<a name="line.4701"></a> |
| <span class="sourceLineNo">4702</span> public String getClientVersionHeader() {<a name="line.4702"></a> |
| <span class="sourceLineNo">4703</span> return clientVersionHeader;<a name="line.4703"></a> |
| <span class="sourceLineNo">4704</span> }<a name="line.4704"></a> |
| <span class="sourceLineNo">4705</span><a name="line.4705"></a> |
| <span class="sourceLineNo">4706</span> /**<a name="line.4706"></a> |
| <span class="sourceLineNo">4707</span> * Returns the HTTP-part parser associated with this resource.<a name="line.4707"></a> |
| <span class="sourceLineNo">4708</span> *<a name="line.4708"></a> |
| <span class="sourceLineNo">4709</span> * <ul class='seealso'><a name="line.4709"></a> |
| <span class="sourceLineNo">4710</span> * <li class='jf'>{@link RestContext#REST_partParser}<a name="line.4710"></a> |
| <span class="sourceLineNo">4711</span> * </ul><a name="line.4711"></a> |
| <span class="sourceLineNo">4712</span> *<a name="line.4712"></a> |
| <span class="sourceLineNo">4713</span> * @return<a name="line.4713"></a> |
| <span class="sourceLineNo">4714</span> * The HTTP-part parser associated with this resource.<a name="line.4714"></a> |
| <span class="sourceLineNo">4715</span> * <br>Never <jk>null</jk>.<a name="line.4715"></a> |
| <span class="sourceLineNo">4716</span> */<a name="line.4716"></a> |
| <span class="sourceLineNo">4717</span> public HttpPartParser getPartParser() {<a name="line.4717"></a> |
| <span class="sourceLineNo">4718</span> return partParser;<a name="line.4718"></a> |
| <span class="sourceLineNo">4719</span> }<a name="line.4719"></a> |
| <span class="sourceLineNo">4720</span><a name="line.4720"></a> |
| <span class="sourceLineNo">4721</span> /**<a name="line.4721"></a> |
| <span class="sourceLineNo">4722</span> * Returns the HTTP-part serializer associated with this resource.<a name="line.4722"></a> |
| <span class="sourceLineNo">4723</span> *<a name="line.4723"></a> |
| <span class="sourceLineNo">4724</span> * <ul class='seealso'><a name="line.4724"></a> |
| <span class="sourceLineNo">4725</span> * <li class='jf'>{@link RestContext#REST_partSerializer}<a name="line.4725"></a> |
| <span class="sourceLineNo">4726</span> * </ul><a name="line.4726"></a> |
| <span class="sourceLineNo">4727</span> *<a name="line.4727"></a> |
| <span class="sourceLineNo">4728</span> * @return<a name="line.4728"></a> |
| <span class="sourceLineNo">4729</span> * The HTTP-part serializer associated with this resource.<a name="line.4729"></a> |
| <span class="sourceLineNo">4730</span> * <br>Never <jk>null</jk>.<a name="line.4730"></a> |
| <span class="sourceLineNo">4731</span> */<a name="line.4731"></a> |
| <span class="sourceLineNo">4732</span> public HttpPartSerializer getPartSerializer() {<a name="line.4732"></a> |
| <span class="sourceLineNo">4733</span> return partSerializer;<a name="line.4733"></a> |
| <span class="sourceLineNo">4734</span> }<a name="line.4734"></a> |
| <span class="sourceLineNo">4735</span><a name="line.4735"></a> |
| <span class="sourceLineNo">4736</span> /**<a name="line.4736"></a> |
| <span class="sourceLineNo">4737</span> * Returns the JSON-Schema generator associated with this resource.<a name="line.4737"></a> |
| <span class="sourceLineNo">4738</span> *<a name="line.4738"></a> |
| <span class="sourceLineNo">4739</span> * @return<a name="line.4739"></a> |
| <span class="sourceLineNo">4740</span> * The HTTP-part serializer associated with this resource.<a name="line.4740"></a> |
| <span class="sourceLineNo">4741</span> * <br>Never <jk>null</jk>.<a name="line.4741"></a> |
| <span class="sourceLineNo">4742</span> */<a name="line.4742"></a> |
| <span class="sourceLineNo">4743</span> public JsonSchemaGenerator getJsonSchemaGenerator() {<a name="line.4743"></a> |
| <span class="sourceLineNo">4744</span> return jsonSchemaGenerator;<a name="line.4744"></a> |
| <span class="sourceLineNo">4745</span> }<a name="line.4745"></a> |
| <span class="sourceLineNo">4746</span><a name="line.4746"></a> |
| <span class="sourceLineNo">4747</span> /**<a name="line.4747"></a> |
| <span class="sourceLineNo">4748</span> * Returns the explicit list of supported accept types for this resource.<a name="line.4748"></a> |
| <span class="sourceLineNo">4749</span> *<a name="line.4749"></a> |
| <span class="sourceLineNo">4750</span> * <ul class='seealso'><a name="line.4750"></a> |
| <span class="sourceLineNo">4751</span> * <li class='jf'>{@link RestContext#REST_serializers}<a name="line.4751"></a> |
| <span class="sourceLineNo">4752</span> * <li class='jf'>{@link RestContext#REST_produces}<a name="line.4752"></a> |
| <span class="sourceLineNo">4753</span> * </ul><a name="line.4753"></a> |
| <span class="sourceLineNo">4754</span> *<a name="line.4754"></a> |
| <span class="sourceLineNo">4755</span> * @return<a name="line.4755"></a> |
| <span class="sourceLineNo">4756</span> * The supported <c>Accept</c> header values for this resource.<a name="line.4756"></a> |
| <span class="sourceLineNo">4757</span> * <br>Never <jk>null</jk>.<a name="line.4757"></a> |
| <span class="sourceLineNo">4758</span> */<a name="line.4758"></a> |
| <span class="sourceLineNo">4759</span> public List<MediaType> getProduces() {<a name="line.4759"></a> |
| <span class="sourceLineNo">4760</span> return produces;<a name="line.4760"></a> |
| <span class="sourceLineNo">4761</span> }<a name="line.4761"></a> |
| <span class="sourceLineNo">4762</span><a name="line.4762"></a> |
| <span class="sourceLineNo">4763</span> /**<a name="line.4763"></a> |
| <span class="sourceLineNo">4764</span> * Returns the explicit list of supported content types for this resource.<a name="line.4764"></a> |
| <span class="sourceLineNo">4765</span> *<a name="line.4765"></a> |
| <span class="sourceLineNo">4766</span> * <ul class='seealso'><a name="line.4766"></a> |
| <span class="sourceLineNo">4767</span> * <li class='jf'>{@link RestContext#REST_parsers}<a name="line.4767"></a> |
| <span class="sourceLineNo">4768</span> * <li class='jf'>{@link RestContext#REST_consumes}<a name="line.4768"></a> |
| <span class="sourceLineNo">4769</span> * </ul><a name="line.4769"></a> |
| <span class="sourceLineNo">4770</span> *<a name="line.4770"></a> |
| <span class="sourceLineNo">4771</span> * @return<a name="line.4771"></a> |
| <span class="sourceLineNo">4772</span> * The supported <c>Content-Type</c> header values for this resource.<a name="line.4772"></a> |
| <span class="sourceLineNo">4773</span> * <br>Never <jk>null</jk>.<a name="line.4773"></a> |
| <span class="sourceLineNo">4774</span> */<a name="line.4774"></a> |
| <span class="sourceLineNo">4775</span> public List<MediaType> getConsumes() {<a name="line.4775"></a> |
| <span class="sourceLineNo">4776</span> return consumes;<a name="line.4776"></a> |
| <span class="sourceLineNo">4777</span> }<a name="line.4777"></a> |
| <span class="sourceLineNo">4778</span><a name="line.4778"></a> |
| <span class="sourceLineNo">4779</span> /**<a name="line.4779"></a> |
| <span class="sourceLineNo">4780</span> * Returns the default request headers for this resource.<a name="line.4780"></a> |
| <span class="sourceLineNo">4781</span> *<a name="line.4781"></a> |
| <span class="sourceLineNo">4782</span> * <ul class='seealso'><a name="line.4782"></a> |
| <span class="sourceLineNo">4783</span> * <li class='jf'>{@link RestContext#REST_reqHeaders}<a name="line.4783"></a> |
| <span class="sourceLineNo">4784</span> * </ul><a name="line.4784"></a> |
| <span class="sourceLineNo">4785</span> *<a name="line.4785"></a> |
| <span class="sourceLineNo">4786</span> * @return<a name="line.4786"></a> |
| <span class="sourceLineNo">4787</span> * The default request headers for this resource.<a name="line.4787"></a> |
| <span class="sourceLineNo">4788</span> * <br>Never <jk>null</jk>.<a name="line.4788"></a> |
| <span class="sourceLineNo">4789</span> */<a name="line.4789"></a> |
| <span class="sourceLineNo">4790</span> public Map<String,Object> getReqHeaders() {<a name="line.4790"></a> |
| <span class="sourceLineNo">4791</span> return reqHeaders;<a name="line.4791"></a> |
| <span class="sourceLineNo">4792</span> }<a name="line.4792"></a> |
| <span class="sourceLineNo">4793</span><a name="line.4793"></a> |
| <span class="sourceLineNo">4794</span> /**<a name="line.4794"></a> |
| <span class="sourceLineNo">4795</span> * Returns the default request attributes for this resource.<a name="line.4795"></a> |
| <span class="sourceLineNo">4796</span> *<a name="line.4796"></a> |
| <span class="sourceLineNo">4797</span> * <ul class='seealso'><a name="line.4797"></a> |
| <span class="sourceLineNo">4798</span> * <li class='jf'>{@link RestContext#REST_reqAttrs}<a name="line.4798"></a> |
| <span class="sourceLineNo">4799</span> * </ul><a name="line.4799"></a> |
| <span class="sourceLineNo">4800</span> *<a name="line.4800"></a> |
| <span class="sourceLineNo">4801</span> * @return<a name="line.4801"></a> |
| <span class="sourceLineNo">4802</span> * The default request headers for this resource.<a name="line.4802"></a> |
| <span class="sourceLineNo">4803</span> * <br>Never <jk>null</jk>.<a name="line.4803"></a> |
| <span class="sourceLineNo">4804</span> */<a name="line.4804"></a> |
| <span class="sourceLineNo">4805</span> public OMap getReqAttrs() {<a name="line.4805"></a> |
| <span class="sourceLineNo">4806</span> return reqAttrs;<a name="line.4806"></a> |
| <span class="sourceLineNo">4807</span> }<a name="line.4807"></a> |
| <span class="sourceLineNo">4808</span><a name="line.4808"></a> |
| <span class="sourceLineNo">4809</span> /**<a name="line.4809"></a> |
| <span class="sourceLineNo">4810</span> * Returns the default response headers for this resource.<a name="line.4810"></a> |
| <span class="sourceLineNo">4811</span> *<a name="line.4811"></a> |
| <span class="sourceLineNo">4812</span> * <ul class='seealso'><a name="line.4812"></a> |
| <span class="sourceLineNo">4813</span> * <li class='jf'>{@link RestContext#REST_resHeaders}<a name="line.4813"></a> |
| <span class="sourceLineNo">4814</span> * </ul><a name="line.4814"></a> |
| <span class="sourceLineNo">4815</span> *<a name="line.4815"></a> |
| <span class="sourceLineNo">4816</span> * @return<a name="line.4816"></a> |
| <span class="sourceLineNo">4817</span> * The default response headers for this resource.<a name="line.4817"></a> |
| <span class="sourceLineNo">4818</span> * <br>Never <jk>null</jk>.<a name="line.4818"></a> |
| <span class="sourceLineNo">4819</span> */<a name="line.4819"></a> |
| <span class="sourceLineNo">4820</span> public Map<String,Object> getResHeaders() {<a name="line.4820"></a> |
| <span class="sourceLineNo">4821</span> return resHeaders;<a name="line.4821"></a> |
| <span class="sourceLineNo">4822</span> }<a name="line.4822"></a> |
| <span class="sourceLineNo">4823</span><a name="line.4823"></a> |
| <span class="sourceLineNo">4824</span> /**<a name="line.4824"></a> |
| <span class="sourceLineNo">4825</span> * Returns the response handlers associated with this resource.<a name="line.4825"></a> |
| <span class="sourceLineNo">4826</span> *<a name="line.4826"></a> |
| <span class="sourceLineNo">4827</span> * <ul class='seealso'><a name="line.4827"></a> |
| <span class="sourceLineNo">4828</span> * <li class='jf'>{@link RestContext#REST_responseHandlers}<a name="line.4828"></a> |
| <span class="sourceLineNo">4829</span> * </ul><a name="line.4829"></a> |
| <span class="sourceLineNo">4830</span> *<a name="line.4830"></a> |
| <span class="sourceLineNo">4831</span> * @return<a name="line.4831"></a> |
| <span class="sourceLineNo">4832</span> * The response handlers associated with this resource.<a name="line.4832"></a> |
| <span class="sourceLineNo">4833</span> * <br>Never <jk>null</jk>.<a name="line.4833"></a> |
| <span class="sourceLineNo">4834</span> */<a name="line.4834"></a> |
| <span class="sourceLineNo">4835</span> protected ResponseHandler[] getResponseHandlers() {<a name="line.4835"></a> |
| <span class="sourceLineNo">4836</span> return responseHandlers;<a name="line.4836"></a> |
| <span class="sourceLineNo">4837</span> }<a name="line.4837"></a> |
| <span class="sourceLineNo">4838</span><a name="line.4838"></a> |
| <span class="sourceLineNo">4839</span> /**<a name="line.4839"></a> |
| <span class="sourceLineNo">4840</span> * Returns the authority path of the resource.<a name="line.4840"></a> |
| <span class="sourceLineNo">4841</span> *<a name="line.4841"></a> |
| <span class="sourceLineNo">4842</span> * <ul class='seealso'><a name="line.4842"></a> |
| <span class="sourceLineNo">4843</span> * <li class='jf'>{@link RestContext#REST_uriAuthority}<a name="line.4843"></a> |
| <span class="sourceLineNo">4844</span> * </ul><a name="line.4844"></a> |
| <span class="sourceLineNo">4845</span> *<a name="line.4845"></a> |
| <span class="sourceLineNo">4846</span> * @return<a name="line.4846"></a> |
| <span class="sourceLineNo">4847</span> * The authority path of this resource.<a name="line.4847"></a> |
| <span class="sourceLineNo">4848</span> * <br>If not specified, returns the context path of the ascendant resource.<a name="line.4848"></a> |
| <span class="sourceLineNo">4849</span> */<a name="line.4849"></a> |
| <span class="sourceLineNo">4850</span> public String getUriAuthority() {<a name="line.4850"></a> |
| <span class="sourceLineNo">4851</span> if (uriAuthority != null)<a name="line.4851"></a> |
| <span class="sourceLineNo">4852</span> return uriAuthority;<a name="line.4852"></a> |
| <span class="sourceLineNo">4853</span> if (parentContext != null)<a name="line.4853"></a> |
| <span class="sourceLineNo">4854</span> return parentContext.getUriAuthority();<a name="line.4854"></a> |
| <span class="sourceLineNo">4855</span> return null;<a name="line.4855"></a> |
| <span class="sourceLineNo">4856</span> }<a name="line.4856"></a> |
| <span class="sourceLineNo">4857</span><a name="line.4857"></a> |
| <span class="sourceLineNo">4858</span> /**<a name="line.4858"></a> |
| <span class="sourceLineNo">4859</span> * Returns the context path of the resource.<a name="line.4859"></a> |
| <span class="sourceLineNo">4860</span> *<a name="line.4860"></a> |
| <span class="sourceLineNo">4861</span> * <ul class='seealso'><a name="line.4861"></a> |
| <span class="sourceLineNo">4862</span> * <li class='jf'>{@link RestContext#REST_uriContext}<a name="line.4862"></a> |
| <span class="sourceLineNo">4863</span> * </ul><a name="line.4863"></a> |
| <span class="sourceLineNo">4864</span> *<a name="line.4864"></a> |
| <span class="sourceLineNo">4865</span> * @return<a name="line.4865"></a> |
| <span class="sourceLineNo">4866</span> * The context path of this resource.<a name="line.4866"></a> |
| <span class="sourceLineNo">4867</span> * <br>If not specified, returns the context path of the ascendant resource.<a name="line.4867"></a> |
| <span class="sourceLineNo">4868</span> */<a name="line.4868"></a> |
| <span class="sourceLineNo">4869</span> public String getUriContext() {<a name="line.4869"></a> |
| <span class="sourceLineNo">4870</span> if (uriContext != null)<a name="line.4870"></a> |
| <span class="sourceLineNo">4871</span> return uriContext;<a name="line.4871"></a> |
| <span class="sourceLineNo">4872</span> if (parentContext != null)<a name="line.4872"></a> |
| <span class="sourceLineNo">4873</span> return parentContext.getUriContext();<a name="line.4873"></a> |
| <span class="sourceLineNo">4874</span> return null;<a name="line.4874"></a> |
| <span class="sourceLineNo">4875</span> }<a name="line.4875"></a> |
| <span class="sourceLineNo">4876</span><a name="line.4876"></a> |
| <span class="sourceLineNo">4877</span> /**<a name="line.4877"></a> |
| <span class="sourceLineNo">4878</span> * Returns the setting on how relative URIs should be interpreted as relative to.<a name="line.4878"></a> |
| <span class="sourceLineNo">4879</span> *<a name="line.4879"></a> |
| <span class="sourceLineNo">4880</span> * <ul class='seealso'><a name="line.4880"></a> |
| <span class="sourceLineNo">4881</span> * <li class='jf'>{@link RestContext#REST_uriRelativity}<a name="line.4881"></a> |
| <span class="sourceLineNo">4882</span> * </ul><a name="line.4882"></a> |
| <span class="sourceLineNo">4883</span> *<a name="line.4883"></a> |
| <span class="sourceLineNo">4884</span> * @return<a name="line.4884"></a> |
| <span class="sourceLineNo">4885</span> * The URI-resolution relativity setting value.<a name="line.4885"></a> |
| <span class="sourceLineNo">4886</span> * <br>Never <jk>null</jk>.<a name="line.4886"></a> |
| <span class="sourceLineNo">4887</span> */<a name="line.4887"></a> |
| <span class="sourceLineNo">4888</span> public UriRelativity getUriRelativity() {<a name="line.4888"></a> |
| <span class="sourceLineNo">4889</span> return uriRelativity;<a name="line.4889"></a> |
| <span class="sourceLineNo">4890</span> }<a name="line.4890"></a> |
| <span class="sourceLineNo">4891</span><a name="line.4891"></a> |
| <span class="sourceLineNo">4892</span> /**<a name="line.4892"></a> |
| <span class="sourceLineNo">4893</span> * Returns the setting on how relative URIs should be resolved.<a name="line.4893"></a> |
| <span class="sourceLineNo">4894</span> *<a name="line.4894"></a> |
| <span class="sourceLineNo">4895</span> * <ul class='seealso'><a name="line.4895"></a> |
| <span class="sourceLineNo">4896</span> * <li class='jf'>{@link RestContext#REST_uriResolution}<a name="line.4896"></a> |
| <span class="sourceLineNo">4897</span> * </ul><a name="line.4897"></a> |
| <span class="sourceLineNo">4898</span> *<a name="line.4898"></a> |
| <span class="sourceLineNo">4899</span> * @return<a name="line.4899"></a> |
| <span class="sourceLineNo">4900</span> * The URI-resolution setting value.<a name="line.4900"></a> |
| <span class="sourceLineNo">4901</span> * <br>Never <jk>null</jk>.<a name="line.4901"></a> |
| <span class="sourceLineNo">4902</span> */<a name="line.4902"></a> |
| <span class="sourceLineNo">4903</span> public UriResolution getUriResolution() {<a name="line.4903"></a> |
| <span class="sourceLineNo">4904</span> return uriResolution;<a name="line.4904"></a> |
| <span class="sourceLineNo">4905</span> }<a name="line.4905"></a> |
| <span class="sourceLineNo">4906</span><a name="line.4906"></a> |
| <span class="sourceLineNo">4907</span> /**<a name="line.4907"></a> |
| <span class="sourceLineNo">4908</span> * Returns the media type for the specified file name.<a name="line.4908"></a> |
| <span class="sourceLineNo">4909</span> *<a name="line.4909"></a> |
| <span class="sourceLineNo">4910</span> * <ul class='seealso'><a name="line.4910"></a> |
| <span class="sourceLineNo">4911</span> * <li class='jf'>{@link RestContext#REST_mimeTypes}<a name="line.4911"></a> |
| <span class="sourceLineNo">4912</span> * </ul><a name="line.4912"></a> |
| <span class="sourceLineNo">4913</span> *<a name="line.4913"></a> |
| <span class="sourceLineNo">4914</span> * @param name The file name.<a name="line.4914"></a> |
| <span class="sourceLineNo">4915</span> * @return The MIME-type, or <jk>null</jk> if it could not be determined.<a name="line.4915"></a> |
| <span class="sourceLineNo">4916</span> */<a name="line.4916"></a> |
| <span class="sourceLineNo">4917</span> public String getMediaTypeForName(String name) {<a name="line.4917"></a> |
| <span class="sourceLineNo">4918</span> return mimetypesFileTypeMap.getContentType(name);<a name="line.4918"></a> |
| <span class="sourceLineNo">4919</span> }<a name="line.4919"></a> |
| <span class="sourceLineNo">4920</span><a name="line.4920"></a> |
| <span class="sourceLineNo">4921</span> /**<a name="line.4921"></a> |
| <span class="sourceLineNo">4922</span> * Returns <jk>true</jk> if the specified path refers to a static file.<a name="line.4922"></a> |
| <span class="sourceLineNo">4923</span> *<a name="line.4923"></a> |
| <span class="sourceLineNo">4924</span> * <p><a name="line.4924"></a> |
| <span class="sourceLineNo">4925</span> * Static files are files pulled from the classpath and served up directly to the browser.<a name="line.4925"></a> |
| <span class="sourceLineNo">4926</span> *<a name="line.4926"></a> |
| <span class="sourceLineNo">4927</span> * <ul class='seealso'><a name="line.4927"></a> |
| <span class="sourceLineNo">4928</span> * <li class='jf'>{@link RestContext#REST_staticFiles}<a name="line.4928"></a> |
| <span class="sourceLineNo">4929</span> * </ul><a name="line.4929"></a> |
| <span class="sourceLineNo">4930</span> *<a name="line.4930"></a> |
| <span class="sourceLineNo">4931</span> * @param p The URL path remainder after the servlet match.<a name="line.4931"></a> |
| <span class="sourceLineNo">4932</span> * @return <jk>true</jk> if the specified path refers to a static file.<a name="line.4932"></a> |
| <span class="sourceLineNo">4933</span> */<a name="line.4933"></a> |
| <span class="sourceLineNo">4934</span> public boolean isStaticFile(String p) {<a name="line.4934"></a> |
| <span class="sourceLineNo">4935</span> return pathStartsWith(p, staticFilesPaths);<a name="line.4935"></a> |
| <span class="sourceLineNo">4936</span> }<a name="line.4936"></a> |
| <span class="sourceLineNo">4937</span><a name="line.4937"></a> |
| <span class="sourceLineNo">4938</span> /**<a name="line.4938"></a> |
| <span class="sourceLineNo">4939</span> * Returns the REST Java methods defined in this resource.<a name="line.4939"></a> |
| <span class="sourceLineNo">4940</span> *<a name="line.4940"></a> |
| <span class="sourceLineNo">4941</span> * <p><a name="line.4941"></a> |
| <span class="sourceLineNo">4942</span> * These are the methods annotated with the {@link RestMethod @RestMethod} annotation.<a name="line.4942"></a> |
| <span class="sourceLineNo">4943</span> *<a name="line.4943"></a> |
| <span class="sourceLineNo">4944</span> * @return<a name="line.4944"></a> |
| <span class="sourceLineNo">4945</span> * An unmodifiable map of Java method names to call method objects.<a name="line.4945"></a> |
| <span class="sourceLineNo">4946</span> */<a name="line.4946"></a> |
| <span class="sourceLineNo">4947</span> public List<RestMethodContext> getMethodContexts() {<a name="line.4947"></a> |
| <span class="sourceLineNo">4948</span> return methods;<a name="line.4948"></a> |
| <span class="sourceLineNo">4949</span> }<a name="line.4949"></a> |
| <span class="sourceLineNo">4950</span><a name="line.4950"></a> |
| <span class="sourceLineNo">4951</span> /**<a name="line.4951"></a> |
| <span class="sourceLineNo">4952</span> * Gives access to the internal stack trace database.<a name="line.4952"></a> |
| <span class="sourceLineNo">4953</span> *<a name="line.4953"></a> |
| <span class="sourceLineNo">4954</span> * @return The stack trace database.<a name="line.4954"></a> |
| <span class="sourceLineNo">4955</span> */<a name="line.4955"></a> |
| <span class="sourceLineNo">4956</span> public StackTraceDatabase getStackTraceDb() {<a name="line.4956"></a> |
| <span class="sourceLineNo">4957</span> return stackTraceDb;<a name="line.4957"></a> |
| <span class="sourceLineNo">4958</span> }<a name="line.4958"></a> |
| <span class="sourceLineNo">4959</span><a name="line.4959"></a> |
| <span class="sourceLineNo">4960</span> /**<a name="line.4960"></a> |
| <span class="sourceLineNo">4961</span> * Returns timing information on all method executions on this class.<a name="line.4961"></a> |
| <span class="sourceLineNo">4962</span> *<a name="line.4962"></a> |
| <span class="sourceLineNo">4963</span> * <p><a name="line.4963"></a> |
| <span class="sourceLineNo">4964</span> * Timing information is maintained for any <ja>@RestResource</ja>-annotated and hook methods.<a name="line.4964"></a> |
| <span class="sourceLineNo">4965</span> *<a name="line.4965"></a> |
| <span class="sourceLineNo">4966</span> * @return A list of timing statistics ordered by average execution time descending.<a name="line.4966"></a> |
| <span class="sourceLineNo">4967</span> */<a name="line.4967"></a> |
| <span class="sourceLineNo">4968</span> public List<MethodExecStats> getMethodExecStats() {<a name="line.4968"></a> |
| <span class="sourceLineNo">4969</span> return methodExecStats.values().stream().sorted().collect(Collectors.toList());<a name="line.4969"></a> |
| <span class="sourceLineNo">4970</span> }<a name="line.4970"></a> |
| <span class="sourceLineNo">4971</span><a name="line.4971"></a> |
| <span class="sourceLineNo">4972</span> /**<a name="line.4972"></a> |
| <span class="sourceLineNo">4973</span> * Gives access to the internal stack trace database.<a name="line.4973"></a> |
| <span class="sourceLineNo">4974</span> *<a name="line.4974"></a> |
| <span class="sourceLineNo">4975</span> * @return The stack trace database.<a name="line.4975"></a> |
| <span class="sourceLineNo">4976</span> */<a name="line.4976"></a> |
| <span class="sourceLineNo">4977</span> public RestContextStats getStats() {<a name="line.4977"></a> |
| <span class="sourceLineNo">4978</span> return new RestContextStats(startTime, getMethodExecStats());<a name="line.4978"></a> |
| <span class="sourceLineNo">4979</span> }<a name="line.4979"></a> |
| <span class="sourceLineNo">4980</span><a name="line.4980"></a> |
| <span class="sourceLineNo">4981</span> /**<a name="line.4981"></a> |
| <span class="sourceLineNo">4982</span> * Returns the timing information returned by {@link #getMethodExecStats()} in a readable format.<a name="line.4982"></a> |
| <span class="sourceLineNo">4983</span> *<a name="line.4983"></a> |
| <span class="sourceLineNo">4984</span> * @return A report of all method execution times ordered by .<a name="line.4984"></a> |
| <span class="sourceLineNo">4985</span> */<a name="line.4985"></a> |
| <span class="sourceLineNo">4986</span> public String getMethodExecStatsReport() {<a name="line.4986"></a> |
| <span class="sourceLineNo">4987</span> StringBuilder sb = new StringBuilder()<a name="line.4987"></a> |
| <span class="sourceLineNo">4988</span> .append(" Method Runs Running Errors Avg Total \n")<a name="line.4988"></a> |
| <span class="sourceLineNo">4989</span> .append("------------------------------ --------- --------- -------- ------------ -----------\n");<a name="line.4989"></a> |
| <span class="sourceLineNo">4990</span> getMethodExecStats()<a name="line.4990"></a> |
| <span class="sourceLineNo">4991</span> .stream()<a name="line.4991"></a> |
| <span class="sourceLineNo">4992</span> .sorted(Comparator.comparingDouble(MethodExecStats::getTotalTime).reversed())<a name="line.4992"></a> |
| <span class="sourceLineNo">4993</span> .forEach(x -> sb.append(String.format("%30s %9d %9d %9d %10dms %10dms\n", x.getMethod(), x.getRuns(), x.getRunning(), x.getErrors(), x.getAvgTime(), x.getTotalTime())));<a name="line.4993"></a> |
| <span class="sourceLineNo">4994</span> return sb.toString();<a name="line.4994"></a> |
| <span class="sourceLineNo">4995</span> }<a name="line.4995"></a> |
| <span class="sourceLineNo">4996</span><a name="line.4996"></a> |
| <span class="sourceLineNo">4997</span> /**<a name="line.4997"></a> |
| <span class="sourceLineNo">4998</span> * Finds the {@link RestMethodParam} instances to handle resolving objects on the calls to the specified Java method.<a name="line.4998"></a> |
| <span class="sourceLineNo">4999</span> *<a name="line.4999"></a> |
| <span class="sourceLineNo">5000</span> * @param mi The Java method being called.<a name="line.5000"></a> |
| <span class="sourceLineNo">5001</span> * @param isPreOrPost Whether this is a {@link HookEvent#PRE_CALL} or {@link HookEvent#POST_CALL}.<a name="line.5001"></a> |
| <span class="sourceLineNo">5002</span> * @param pathPattern The path pattern to match against.<a name="line.5002"></a> |
| <span class="sourceLineNo">5003</span> * @return The array of resolvers.<a name="line.5003"></a> |
| <span class="sourceLineNo">5004</span> * @throws ServletException If an annotation usage error was detected.<a name="line.5004"></a> |
| <span class="sourceLineNo">5005</span> */<a name="line.5005"></a> |
| <span class="sourceLineNo">5006</span> protected RestMethodParam[] findParams(MethodInfo mi, boolean isPreOrPost, UrlPathPattern pathPattern) throws ServletException {<a name="line.5006"></a> |
| <span class="sourceLineNo">5007</span><a name="line.5007"></a> |
| <span class="sourceLineNo">5008</span> List<ClassInfo> pt = mi.getParamTypes();<a name="line.5008"></a> |
| <span class="sourceLineNo">5009</span> RestMethodParam[] rp = new RestMethodParam[pt.size()];<a name="line.5009"></a> |
| <span class="sourceLineNo">5010</span> PropertyStore ps = getPropertyStore();<a name="line.5010"></a> |
| <span class="sourceLineNo">5011</span><a name="line.5011"></a> |
| <span class="sourceLineNo">5012</span> for (int i = 0; i < pt.size(); i++) {<a name="line.5012"></a> |
| <span class="sourceLineNo">5013</span><a name="line.5013"></a> |
| <span class="sourceLineNo">5014</span> ClassInfo t = pt.get(i);<a name="line.5014"></a> |
| <span class="sourceLineNo">5015</span> if (t.inner() != null) {<a name="line.5015"></a> |
| <span class="sourceLineNo">5016</span> Class<?> c = t.inner();<a name="line.5016"></a> |
| <span class="sourceLineNo">5017</span> rp[i] = paramResolvers.get(c);<a name="line.5017"></a> |
| <span class="sourceLineNo">5018</span> if (rp[i] == null)<a name="line.5018"></a> |
| <span class="sourceLineNo">5019</span> rp[i] = RestParamDefaults.STANDARD_RESOLVERS.get(c);<a name="line.5019"></a> |
| <span class="sourceLineNo">5020</span> }<a name="line.5020"></a> |
| <span class="sourceLineNo">5021</span><a name="line.5021"></a> |
| <span class="sourceLineNo">5022</span> ParamInfo mpi = mi.getParam(i);<a name="line.5022"></a> |
| <span class="sourceLineNo">5023</span><a name="line.5023"></a> |
| <span class="sourceLineNo">5024</span> if (mpi.hasAnnotation(Header.class)) {<a name="line.5024"></a> |
| <span class="sourceLineNo">5025</span> rp[i] = new RestParamDefaults.HeaderObject(mpi, ps);<a name="line.5025"></a> |
| <span class="sourceLineNo">5026</span> } else if (mpi.hasAnnotation(Attr.class)) {<a name="line.5026"></a> |
| <span class="sourceLineNo">5027</span> rp[i] = new RestParamDefaults.AttributeObject(mpi, ps);<a name="line.5027"></a> |
| <span class="sourceLineNo">5028</span> } else if (mpi.hasAnnotation(Query.class)) {<a name="line.5028"></a> |
| <span class="sourceLineNo">5029</span> rp[i] = new RestParamDefaults.QueryObject(mpi, ps);<a name="line.5029"></a> |
| <span class="sourceLineNo">5030</span> } else if (mpi.hasAnnotation(FormData.class)) {<a name="line.5030"></a> |
| <span class="sourceLineNo">5031</span> rp[i] = new RestParamDefaults.FormDataObject(mpi, ps);<a name="line.5031"></a> |
| <span class="sourceLineNo">5032</span> } else if (mpi.hasAnnotation(Path.class)) {<a name="line.5032"></a> |
| <span class="sourceLineNo">5033</span> rp[i] = new RestParamDefaults.PathObject(mpi, ps, pathPattern);<a name="line.5033"></a> |
| <span class="sourceLineNo">5034</span> } else if (mpi.hasAnnotation(Body.class)) {<a name="line.5034"></a> |
| <span class="sourceLineNo">5035</span> rp[i] = new RestParamDefaults.BodyObject(mpi, ps);<a name="line.5035"></a> |
| <span class="sourceLineNo">5036</span> } else if (mpi.hasAnnotation(Request.class)) {<a name="line.5036"></a> |
| <span class="sourceLineNo">5037</span> rp[i] = new RestParamDefaults.RequestObject(mpi, ps);<a name="line.5037"></a> |
| <span class="sourceLineNo">5038</span> } else if (mpi.hasAnnotation(Response.class)) {<a name="line.5038"></a> |
| <span class="sourceLineNo">5039</span> rp[i] = new RestParamDefaults.ResponseObject(mpi, ps);<a name="line.5039"></a> |
| <span class="sourceLineNo">5040</span> } else if (mpi.hasAnnotation(ResponseHeader.class)) {<a name="line.5040"></a> |
| <span class="sourceLineNo">5041</span> rp[i] = new RestParamDefaults.ResponseHeaderObject(mpi, ps);<a name="line.5041"></a> |
| <span class="sourceLineNo">5042</span> } else if (mpi.hasAnnotation(ResponseStatus.class)) {<a name="line.5042"></a> |
| <span class="sourceLineNo">5043</span> rp[i] = new RestParamDefaults.ResponseStatusObject(t);<a name="line.5043"></a> |
| <span class="sourceLineNo">5044</span> } else if (mpi.hasAnnotation(HasFormData.class)) {<a name="line.5044"></a> |
| <span class="sourceLineNo">5045</span> rp[i] = new RestParamDefaults.HasFormDataObject(mpi);<a name="line.5045"></a> |
| <span class="sourceLineNo">5046</span> } else if (mpi.hasAnnotation(HasQuery.class)) {<a name="line.5046"></a> |
| <span class="sourceLineNo">5047</span> rp[i] = new RestParamDefaults.HasQueryObject(mpi);<a name="line.5047"></a> |
| <span class="sourceLineNo">5048</span> } else if (mpi.hasAnnotation(org.apache.juneau.rest.annotation.Method.class)) {<a name="line.5048"></a> |
| <span class="sourceLineNo">5049</span> rp[i] = new RestParamDefaults.MethodObject(mi, t, mpi);<a name="line.5049"></a> |
| <span class="sourceLineNo">5050</span> }<a name="line.5050"></a> |
| <span class="sourceLineNo">5051</span><a name="line.5051"></a> |
| <span class="sourceLineNo">5052</span> if (rp[i] == null && ! isPreOrPost)<a name="line.5052"></a> |
| <span class="sourceLineNo">5053</span> throw new RestServletException("Invalid parameter specified for method ''{0}'' at index position {1}", mi.inner(), i);<a name="line.5053"></a> |
| <span class="sourceLineNo">5054</span> }<a name="line.5054"></a> |
| <span class="sourceLineNo">5055</span><a name="line.5055"></a> |
| <span class="sourceLineNo">5056</span> return rp;<a name="line.5056"></a> |
| <span class="sourceLineNo">5057</span> }<a name="line.5057"></a> |
| <span class="sourceLineNo">5058</span><a name="line.5058"></a> |
| <span class="sourceLineNo">5059</span><a name="line.5059"></a> |
| <span class="sourceLineNo">5060</span> //------------------------------------------------------------------------------------------------------------------<a name="line.5060"></a> |
| <span class="sourceLineNo">5061</span> // Call handling<a name="line.5061"></a> |
| <span class="sourceLineNo">5062</span> //------------------------------------------------------------------------------------------------------------------<a name="line.5062"></a> |
| <span class="sourceLineNo">5063</span><a name="line.5063"></a> |
| <span class="sourceLineNo">5064</span> /**<a name="line.5064"></a> |
| <span class="sourceLineNo">5065</span> * Wraps an incoming servlet request/response pair into a single {@link RestCall} object.<a name="line.5065"></a> |
| <span class="sourceLineNo">5066</span> *<a name="line.5066"></a> |
| <span class="sourceLineNo">5067</span> * <p><a name="line.5067"></a> |
| <span class="sourceLineNo">5068</span> * This is the first method called by {@link #execute(HttpServletRequest, HttpServletResponse)}.<a name="line.5068"></a> |
| <span class="sourceLineNo">5069</span> *<a name="line.5069"></a> |
| <span class="sourceLineNo">5070</span> * @param req The rest request.<a name="line.5070"></a> |
| <span class="sourceLineNo">5071</span> * @param res The rest response.<a name="line.5071"></a> |
| <span class="sourceLineNo">5072</span> * @return The wrapped request/response pair.<a name="line.5072"></a> |
| <span class="sourceLineNo">5073</span> */<a name="line.5073"></a> |
| <span class="sourceLineNo">5074</span> protected RestCall createCall(HttpServletRequest req, HttpServletResponse res) {<a name="line.5074"></a> |
| <span class="sourceLineNo">5075</span> return new RestCall(this, req, res).logger(getCallLogger()).loggerConfig(getCallLoggerConfig());<a name="line.5075"></a> |
| <span class="sourceLineNo">5076</span> }<a name="line.5076"></a> |
| <span class="sourceLineNo">5077</span><a name="line.5077"></a> |
| <span class="sourceLineNo">5078</span> /**<a name="line.5078"></a> |
| <span class="sourceLineNo">5079</span> * Creates a {@link RestRequest} object based on the specified incoming {@link HttpServletRequest} object.<a name="line.5079"></a> |
| <span class="sourceLineNo">5080</span> *<a name="line.5080"></a> |
| <span class="sourceLineNo">5081</span> * <p><a name="line.5081"></a> |
| <span class="sourceLineNo">5082</span> * This method is called immediately after {@link #startCall(RestCall)} has been called.<a name="line.5082"></a> |
| <span class="sourceLineNo">5083</span> *<a name="line.5083"></a> |
| <span class="sourceLineNo">5084</span> * @param call The current REST call.<a name="line.5084"></a> |
| <span class="sourceLineNo">5085</span> * @return The wrapped request object.<a name="line.5085"></a> |
| <span class="sourceLineNo">5086</span> * @throws ServletException If any errors occur trying to interpret the request.<a name="line.5086"></a> |
| <span class="sourceLineNo">5087</span> */<a name="line.5087"></a> |
| <span class="sourceLineNo">5088</span> public RestRequest createRequest(RestCall call) throws ServletException {<a name="line.5088"></a> |
| <span class="sourceLineNo">5089</span> return new RestRequest(call);<a name="line.5089"></a> |
| <span class="sourceLineNo">5090</span> }<a name="line.5090"></a> |
| <span class="sourceLineNo">5091</span><a name="line.5091"></a> |
| <span class="sourceLineNo">5092</span> /**<a name="line.5092"></a> |
| <span class="sourceLineNo">5093</span> * Creates a {@link RestResponse} object based on the specified incoming {@link HttpServletResponse} object<a name="line.5093"></a> |
| <span class="sourceLineNo">5094</span> * and the request returned by {@link #createRequest(RestCall)}.<a name="line.5094"></a> |
| <span class="sourceLineNo">5095</span> *<a name="line.5095"></a> |
| <span class="sourceLineNo">5096</span> * @param call The current REST call.<a name="line.5096"></a> |
| <span class="sourceLineNo">5097</span> * @return The wrapped response object.<a name="line.5097"></a> |
| <span class="sourceLineNo">5098</span> * @throws ServletException If any errors occur trying to interpret the request or response.<a name="line.5098"></a> |
| <span class="sourceLineNo">5099</span> */<a name="line.5099"></a> |
| <span class="sourceLineNo">5100</span> public RestResponse createResponse(RestCall call) throws ServletException {<a name="line.5100"></a> |
| <span class="sourceLineNo">5101</span> return new RestResponse(call);<a name="line.5101"></a> |
| <span class="sourceLineNo">5102</span> }<a name="line.5102"></a> |
| <span class="sourceLineNo">5103</span><a name="line.5103"></a> |
| <span class="sourceLineNo">5104</span> /**<a name="line.5104"></a> |
| <span class="sourceLineNo">5105</span> * The main service method.<a name="line.5105"></a> |
| <span class="sourceLineNo">5106</span> *<a name="line.5106"></a> |
| <span class="sourceLineNo">5107</span> * <p><a name="line.5107"></a> |
| <span class="sourceLineNo">5108</span> * Subclasses can optionally override this method if they want to tailor the behavior of requests.<a name="line.5108"></a> |
| <span class="sourceLineNo">5109</span> *<a name="line.5109"></a> |
| <span class="sourceLineNo">5110</span> * @param r1 The incoming HTTP servlet request object.<a name="line.5110"></a> |
| <span class="sourceLineNo">5111</span> * @param r2 The incoming HTTP servlet response object.<a name="line.5111"></a> |
| <span class="sourceLineNo">5112</span> * @throws ServletException General servlet exception.<a name="line.5112"></a> |
| <span class="sourceLineNo">5113</span> * @throws IOException Thrown by underlying stream.<a name="line.5113"></a> |
| <span class="sourceLineNo">5114</span> */<a name="line.5114"></a> |
| <span class="sourceLineNo">5115</span> public void execute(HttpServletRequest r1, HttpServletResponse r2) throws ServletException, IOException {<a name="line.5115"></a> |
| <span class="sourceLineNo">5116</span><a name="line.5116"></a> |
| <span class="sourceLineNo">5117</span> RestCall call = createCall(r1, r2);<a name="line.5117"></a> |
| <span class="sourceLineNo">5118</span><a name="line.5118"></a> |
| <span class="sourceLineNo">5119</span> // Must be careful not to bleed thread-locals.<a name="line.5119"></a> |
| <span class="sourceLineNo">5120</span> if (this.call.get() != null)<a name="line.5120"></a> |
| <span class="sourceLineNo">5121</span> System.err.println("WARNING: Thread-local call object was not cleaned up from previous request. " + this + ", thread=["+Thread.currentThread().getId()+"]");<a name="line.5121"></a> |
| <span class="sourceLineNo">5122</span> this.call.set(call);<a name="line.5122"></a> |
| <span class="sourceLineNo">5123</span><a name="line.5123"></a> |
| <span class="sourceLineNo">5124</span> try {<a name="line.5124"></a> |
| <span class="sourceLineNo">5125</span> checkForInitException();<a name="line.5125"></a> |
| <span class="sourceLineNo">5126</span><a name="line.5126"></a> |
| <span class="sourceLineNo">5127</span> // If the resource path contains variables (e.g. @Rest(path="/f/{a}/{b}"), then we want to resolve<a name="line.5127"></a> |
| <span class="sourceLineNo">5128</span> // those variables and push the servletPath to include the resolved variables. The new pathInfo will be<a name="line.5128"></a> |
| <span class="sourceLineNo">5129</span> // the remainder after the new servletPath.<a name="line.5129"></a> |
| <span class="sourceLineNo">5130</span> // Only do this for the top-level resource because the logic for child resources are processed next.<a name="line.5130"></a> |
| <span class="sourceLineNo">5131</span> if (pathPattern.hasVars() && getParentContext() == null) {<a name="line.5131"></a> |
| <span class="sourceLineNo">5132</span> String sp = call.getServletPath();<a name="line.5132"></a> |
| <span class="sourceLineNo">5133</span> String pi = call.getPathInfoUndecoded();<a name="line.5133"></a> |
| <span class="sourceLineNo">5134</span> UrlPathInfo upi2 = new UrlPathInfo(pi == null ? sp : sp + pi);<a name="line.5134"></a> |
| <span class="sourceLineNo">5135</span> UrlPathPatternMatch uppm = pathPattern.match(upi2);<a name="line.5135"></a> |
| <span class="sourceLineNo">5136</span> if (uppm != null && ! uppm.hasEmptyVars()) {<a name="line.5136"></a> |
| <span class="sourceLineNo">5137</span> call.addPathVars(uppm.getVars());<a name="line.5137"></a> |
| <span class="sourceLineNo">5138</span> call.request(<a name="line.5138"></a> |
| <span class="sourceLineNo">5139</span> new OverrideableHttpServletRequest(call.getRequest())<a name="line.5139"></a> |
| <span class="sourceLineNo">5140</span> .pathInfo(nullIfEmpty(urlDecode(uppm.getSuffix())))<a name="line.5140"></a> |
| <span class="sourceLineNo">5141</span> .servletPath(uppm.getPrefix())<a name="line.5141"></a> |
| <span class="sourceLineNo">5142</span> );<a name="line.5142"></a> |
| <span class="sourceLineNo">5143</span> } else {<a name="line.5143"></a> |
| <span class="sourceLineNo">5144</span> call.debug(isDebug(call)).status(SC_NOT_FOUND).finish();<a name="line.5144"></a> |
| <span class="sourceLineNo">5145</span> return;<a name="line.5145"></a> |
| <span class="sourceLineNo">5146</span> }<a name="line.5146"></a> |
| <span class="sourceLineNo">5147</span> }<a name="line.5147"></a> |
| <span class="sourceLineNo">5148</span><a name="line.5148"></a> |
| <span class="sourceLineNo">5149</span> // If this resource has child resources, try to recursively call them.<a name="line.5149"></a> |
| <span class="sourceLineNo">5150</span> String pi = call.getPathInfoUndecoded();<a name="line.5150"></a> |
| <span class="sourceLineNo">5151</span> if ((! childResources.isEmpty()) && pi != null && ! pi.equals("/")) {<a name="line.5151"></a> |
| <span class="sourceLineNo">5152</span> for (RestContext rc : getChildResources().values()) {<a name="line.5152"></a> |
| <span class="sourceLineNo">5153</span> UrlPathPattern upp = rc.pathPattern;<a name="line.5153"></a> |
| <span class="sourceLineNo">5154</span> UrlPathPatternMatch uppm = upp.match(call.getUrlPathInfo());<a name="line.5154"></a> |
| <span class="sourceLineNo">5155</span> if (uppm != null) {<a name="line.5155"></a> |
| <span class="sourceLineNo">5156</span> if (! uppm.hasEmptyVars()) {<a name="line.5156"></a> |
| <span class="sourceLineNo">5157</span> call.addPathVars(uppm.getVars());<a name="line.5157"></a> |
| <span class="sourceLineNo">5158</span> HttpServletRequest childRequest = new OverrideableHttpServletRequest(call.getRequest())<a name="line.5158"></a> |
| <span class="sourceLineNo">5159</span> .pathInfo(nullIfEmpty(urlDecode(uppm.getSuffix())))<a name="line.5159"></a> |
| <span class="sourceLineNo">5160</span> .servletPath(call.getServletPath() + uppm.getPrefix());<a name="line.5160"></a> |
| <span class="sourceLineNo">5161</span> rc.execute(childRequest, call.getResponse());<a name="line.5161"></a> |
| <span class="sourceLineNo">5162</span> } else {<a name="line.5162"></a> |
| <span class="sourceLineNo">5163</span> call.debug(isDebug(call)).status(SC_NOT_FOUND).finish();<a name="line.5163"></a> |
| <span class="sourceLineNo">5164</span> }<a name="line.5164"></a> |
| <span class="sourceLineNo">5165</span> return;<a name="line.5165"></a> |
| <span class="sourceLineNo">5166</span> }<a name="line.5166"></a> |
| <span class="sourceLineNo">5167</span> }<a name="line.5167"></a> |
| <span class="sourceLineNo">5168</span> }<a name="line.5168"></a> |
| <span class="sourceLineNo">5169</span><a name="line.5169"></a> |
| <span class="sourceLineNo">5170</span> if (isDebug(call))<a name="line.5170"></a> |
| <span class="sourceLineNo">5171</span> call.debug(true);<a name="line.5171"></a> |
| <span class="sourceLineNo">5172</span><a name="line.5172"></a> |
| <span class="sourceLineNo">5173</span> startCall(call);<a name="line.5173"></a> |
| <span class="sourceLineNo">5174</span><a name="line.5174"></a> |
| <span class="sourceLineNo">5175</span> createRequest(call);<a name="line.5175"></a> |
| <span class="sourceLineNo">5176</span> createResponse(call);<a name="line.5176"></a> |
| <span class="sourceLineNo">5177</span><a name="line.5177"></a> |
| <span class="sourceLineNo">5178</span> StaticFile r = null;<a name="line.5178"></a> |
| <span class="sourceLineNo">5179</span> if (call.getPathInfoUndecoded() != null) {<a name="line.5179"></a> |
| <span class="sourceLineNo">5180</span> String p = call.getPathInfoUndecoded().substring(1);<a name="line.5180"></a> |
| <span class="sourceLineNo">5181</span> if (isStaticFile(p)) {<a name="line.5181"></a> |
| <span class="sourceLineNo">5182</span> r = getStaticFile(p);<a name="line.5182"></a> |
| <span class="sourceLineNo">5183</span> if (! r.exists()) {<a name="line.5183"></a> |
| <span class="sourceLineNo">5184</span> call.output(null);<a name="line.5184"></a> |
| <span class="sourceLineNo">5185</span> r = null;<a name="line.5185"></a> |
| <span class="sourceLineNo">5186</span> }<a name="line.5186"></a> |
| <span class="sourceLineNo">5187</span> } else if (p.equals("favicon.ico")) {<a name="line.5187"></a> |
| <span class="sourceLineNo">5188</span> call.output(null);<a name="line.5188"></a> |
| <span class="sourceLineNo">5189</span> }<a name="line.5189"></a> |
| <span class="sourceLineNo">5190</span> }<a name="line.5190"></a> |
| <span class="sourceLineNo">5191</span><a name="line.5191"></a> |
| <span class="sourceLineNo">5192</span> if (r != null) {<a name="line.5192"></a> |
| <span class="sourceLineNo">5193</span> call.status(SC_OK);<a name="line.5193"></a> |
| <span class="sourceLineNo">5194</span> call.output(r);<a name="line.5194"></a> |
| <span class="sourceLineNo">5195</span> } else {<a name="line.5195"></a> |
| <span class="sourceLineNo">5196</span><a name="line.5196"></a> |
| <span class="sourceLineNo">5197</span> // If the specified method has been defined in a subclass, invoke it.<a name="line.5197"></a> |
| <span class="sourceLineNo">5198</span> try {<a name="line.5198"></a> |
| <span class="sourceLineNo">5199</span> findMethod(call).invoke(call);<a name="line.5199"></a> |
| <span class="sourceLineNo">5200</span> } catch (NotFound e) {<a name="line.5200"></a> |
| <span class="sourceLineNo">5201</span> if (call.getStatus() == 0)<a name="line.5201"></a> |
| <span class="sourceLineNo">5202</span> call.status(404);<a name="line.5202"></a> |
| <span class="sourceLineNo">5203</span> handleNotFound(call);<a name="line.5203"></a> |
| <span class="sourceLineNo">5204</span> }<a name="line.5204"></a> |
| <span class="sourceLineNo">5205</span> }<a name="line.5205"></a> |
| <span class="sourceLineNo">5206</span><a name="line.5206"></a> |
| <span class="sourceLineNo">5207</span> if (call.hasOutput()) {<a name="line.5207"></a> |
| <span class="sourceLineNo">5208</span> // Now serialize the output if there was any.<a name="line.5208"></a> |
| <span class="sourceLineNo">5209</span> // Some subclasses may write to the OutputStream or Writer directly.<a name="line.5209"></a> |
| <span class="sourceLineNo">5210</span> handleResponse(call);<a name="line.5210"></a> |
| <span class="sourceLineNo">5211</span> }<a name="line.5211"></a> |
| <span class="sourceLineNo">5212</span><a name="line.5212"></a> |
| <span class="sourceLineNo">5213</span><a name="line.5213"></a> |
| <span class="sourceLineNo">5214</span> } catch (Throwable e) {<a name="line.5214"></a> |
| <span class="sourceLineNo">5215</span> handleError(call, convertThrowable(e));<a name="line.5215"></a> |
| <span class="sourceLineNo">5216</span> } finally {<a name="line.5216"></a> |
| <span class="sourceLineNo">5217</span> clearState();<a name="line.5217"></a> |
| <span class="sourceLineNo">5218</span> }<a name="line.5218"></a> |
| <span class="sourceLineNo">5219</span><a name="line.5219"></a> |
| <span class="sourceLineNo">5220</span> call.finish();<a name="line.5220"></a> |
| <span class="sourceLineNo">5221</span> finishCall(call);<a name="line.5221"></a> |
| <span class="sourceLineNo">5222</span> }<a name="line.5222"></a> |
| <span class="sourceLineNo">5223</span><a name="line.5223"></a> |
| <span class="sourceLineNo">5224</span> private RestMethodContext findMethod(RestCall call) throws Throwable {<a name="line.5224"></a> |
| <span class="sourceLineNo">5225</span> String m = call.getMethod();<a name="line.5225"></a> |
| <span class="sourceLineNo">5226</span><a name="line.5226"></a> |
| <span class="sourceLineNo">5227</span> int rc = 0;<a name="line.5227"></a> |
| <span class="sourceLineNo">5228</span> if (methodMap.containsKey(m)) {<a name="line.5228"></a> |
| <span class="sourceLineNo">5229</span> for (RestMethodContext mc : methodMap.get(m)) {<a name="line.5229"></a> |
| <span class="sourceLineNo">5230</span> int mrc = mc.match(call);<a name="line.5230"></a> |
| <span class="sourceLineNo">5231</span> if (mrc == 2)<a name="line.5231"></a> |
| <span class="sourceLineNo">5232</span> return mc;<a name="line.5232"></a> |
| <span class="sourceLineNo">5233</span> rc = Math.max(rc, mrc);<a name="line.5233"></a> |
| <span class="sourceLineNo">5234</span> }<a name="line.5234"></a> |
| <span class="sourceLineNo">5235</span> }<a name="line.5235"></a> |
| <span class="sourceLineNo">5236</span><a name="line.5236"></a> |
| <span class="sourceLineNo">5237</span> if (methodMap.containsKey("*")) {<a name="line.5237"></a> |
| <span class="sourceLineNo">5238</span> for (RestMethodContext mc : methodMap.get("*")) {<a name="line.5238"></a> |
| <span class="sourceLineNo">5239</span> int mrc = mc.match(call);<a name="line.5239"></a> |
| <span class="sourceLineNo">5240</span> if (mrc == 2)<a name="line.5240"></a> |
| <span class="sourceLineNo">5241</span> return mc;<a name="line.5241"></a> |
| <span class="sourceLineNo">5242</span> rc = Math.max(rc, mrc);<a name="line.5242"></a> |
| <span class="sourceLineNo">5243</span> }<a name="line.5243"></a> |
| <span class="sourceLineNo">5244</span> }<a name="line.5244"></a> |
| <span class="sourceLineNo">5245</span><a name="line.5245"></a> |
| <span class="sourceLineNo">5246</span> // If no paths matched, see if the path matches any other methods.<a name="line.5246"></a> |
| <span class="sourceLineNo">5247</span> // Note that we don't want to match against "/*" patterns such as getOptions().<a name="line.5247"></a> |
| <span class="sourceLineNo">5248</span> if (rc == 0) {<a name="line.5248"></a> |
| <span class="sourceLineNo">5249</span> for (RestMethodContext mc : methods) {<a name="line.5249"></a> |
| <span class="sourceLineNo">5250</span> if (! mc.getPathPattern().endsWith("/*")) {<a name="line.5250"></a> |
| <span class="sourceLineNo">5251</span> int mrc = mc.match(call);<a name="line.5251"></a> |
| <span class="sourceLineNo">5252</span> if (mrc == 2)<a name="line.5252"></a> |
| <span class="sourceLineNo">5253</span> throw new MethodNotAllowed();<a name="line.5253"></a> |
| <span class="sourceLineNo">5254</span> }<a name="line.5254"></a> |
| <span class="sourceLineNo">5255</span> }<a name="line.5255"></a> |
| <span class="sourceLineNo">5256</span> }<a name="line.5256"></a> |
| <span class="sourceLineNo">5257</span><a name="line.5257"></a> |
| <span class="sourceLineNo">5258</span> if (rc == 1)<a name="line.5258"></a> |
| <span class="sourceLineNo">5259</span> throw new PreconditionFailed("Method ''{0}'' not found on resource on path ''{1}'' with matching matcher.", m, call.getPathInfo());<a name="line.5259"></a> |
| <span class="sourceLineNo">5260</span><a name="line.5260"></a> |
| <span class="sourceLineNo">5261</span> throw new NotFound();<a name="line.5261"></a> |
| <span class="sourceLineNo">5262</span> }<a name="line.5262"></a> |
| <span class="sourceLineNo">5263</span><a name="line.5263"></a> |
| <span class="sourceLineNo">5264</span> private boolean isDebug(RestCall call) {<a name="line.5264"></a> |
| <span class="sourceLineNo">5265</span> Enablement e = null;<a name="line.5265"></a> |
| <span class="sourceLineNo">5266</span> RestMethodContext mc = call.getRestMethodContext();<a name="line.5266"></a> |
| <span class="sourceLineNo">5267</span> if (mc != null)<a name="line.5267"></a> |
| <span class="sourceLineNo">5268</span> e = mc.getDebug();<a name="line.5268"></a> |
| <span class="sourceLineNo">5269</span> if (e == null)<a name="line.5269"></a> |
| <span class="sourceLineNo">5270</span> e = getDebug();<a name="line.5270"></a> |
| <span class="sourceLineNo">5271</span> if (e == TRUE)<a name="line.5271"></a> |
| <span class="sourceLineNo">5272</span> return true;<a name="line.5272"></a> |
| <span class="sourceLineNo">5273</span> if (e == FALSE)<a name="line.5273"></a> |
| <span class="sourceLineNo">5274</span> return false;<a name="line.5274"></a> |
| <span class="sourceLineNo">5275</span> if (e == PER_REQUEST)<a name="line.5275"></a> |
| <span class="sourceLineNo">5276</span> return "true".equalsIgnoreCase(call.getRequest().getHeader("X-Debug"));<a name="line.5276"></a> |
| <span class="sourceLineNo">5277</span> return false;<a name="line.5277"></a> |
| <span class="sourceLineNo">5278</span> }<a name="line.5278"></a> |
| <span class="sourceLineNo">5279</span><a name="line.5279"></a> |
| <span class="sourceLineNo">5280</span> /**<a name="line.5280"></a> |
| <span class="sourceLineNo">5281</span> * The main method for serializing POJOs passed in through the {@link RestResponse#setOutput(Object)} method or<a name="line.5281"></a> |
| <span class="sourceLineNo">5282</span> * returned by the Java method.<a name="line.5282"></a> |
| <span class="sourceLineNo">5283</span> *<a name="line.5283"></a> |
| <span class="sourceLineNo">5284</span> * <p><a name="line.5284"></a> |
| <span class="sourceLineNo">5285</span> * Subclasses may override this method if they wish to modify the way the output is rendered or support other output<a name="line.5285"></a> |
| <span class="sourceLineNo">5286</span> * formats.<a name="line.5286"></a> |
| <span class="sourceLineNo">5287</span> *<a name="line.5287"></a> |
| <span class="sourceLineNo">5288</span> * <p><a name="line.5288"></a> |
| <span class="sourceLineNo">5289</span> * The default implementation simply iterates through the response handlers on this resource<a name="line.5289"></a> |
| <span class="sourceLineNo">5290</span> * looking for the first one whose {@link ResponseHandler#handle(RestRequest,RestResponse)} method returns<a name="line.5290"></a> |
| <span class="sourceLineNo">5291</span> * <jk>true</jk>.<a name="line.5291"></a> |
| <span class="sourceLineNo">5292</span> *<a name="line.5292"></a> |
| <span class="sourceLineNo">5293</span> * @param call The HTTP call.<a name="line.5293"></a> |
| <span class="sourceLineNo">5294</span> * @throws IOException Thrown by underlying stream.<a name="line.5294"></a> |
| <span class="sourceLineNo">5295</span> * @throws HttpException Non-200 response.<a name="line.5295"></a> |
| <span class="sourceLineNo">5296</span> * @throws NotImplemented No registered response handlers could handle the call.<a name="line.5296"></a> |
| <span class="sourceLineNo">5297</span> */<a name="line.5297"></a> |
| <span class="sourceLineNo">5298</span> public void handleResponse(RestCall call) throws IOException, HttpException, NotImplemented {<a name="line.5298"></a> |
| <span class="sourceLineNo">5299</span><a name="line.5299"></a> |
| <span class="sourceLineNo">5300</span> RestRequest req = call.getRestRequest();<a name="line.5300"></a> |
| <span class="sourceLineNo">5301</span> RestResponse res = call.getRestResponse();<a name="line.5301"></a> |
| <span class="sourceLineNo">5302</span><a name="line.5302"></a> |
| <span class="sourceLineNo">5303</span> // Loop until we find the correct handler for the POJO.<a name="line.5303"></a> |
| <span class="sourceLineNo">5304</span> for (ResponseHandler h : getResponseHandlers())<a name="line.5304"></a> |
| <span class="sourceLineNo">5305</span> if (h.handle(req, res))<a name="line.5305"></a> |
| <span class="sourceLineNo">5306</span> return;<a name="line.5306"></a> |
| <span class="sourceLineNo">5307</span><a name="line.5307"></a> |
| <span class="sourceLineNo">5308</span> Object output = res.getOutput();<a name="line.5308"></a> |
| <span class="sourceLineNo">5309</span> throw new NotImplemented("No response handlers found to process output of type '"+(output == null ? null : output.getClass().getName())+"'");<a name="line.5309"></a> |
| <span class="sourceLineNo">5310</span> }<a name="line.5310"></a> |
| <span class="sourceLineNo">5311</span><a name="line.5311"></a> |
| <span class="sourceLineNo">5312</span> /**<a name="line.5312"></a> |
| <span class="sourceLineNo">5313</span> * Method that can be subclassed to allow uncaught throwables to be treated as other types of throwables.<a name="line.5313"></a> |
| <span class="sourceLineNo">5314</span> *<a name="line.5314"></a> |
| <span class="sourceLineNo">5315</span> * <p><a name="line.5315"></a> |
| <span class="sourceLineNo">5316</span> * The default implementation looks at the throwable class name to determine whether it can be converted to another type:<a name="line.5316"></a> |
| <span class="sourceLineNo">5317</span> *<a name="line.5317"></a> |
| <span class="sourceLineNo">5318</span> * <ul><a name="line.5318"></a> |
| <span class="sourceLineNo">5319</span> * <li><js>"*AccessDenied*"</js> - Converted to {@link Unauthorized}.<a name="line.5319"></a> |
| <span class="sourceLineNo">5320</span> * <li><js>"*Empty*"</js>,<js>"*NotFound*"</js> - Converted to {@link NotFound}.<a name="line.5320"></a> |
| <span class="sourceLineNo">5321</span> * </ul><a name="line.5321"></a> |
| <span class="sourceLineNo">5322</span> *<a name="line.5322"></a> |
| <span class="sourceLineNo">5323</span> * @param t The thrown object.<a name="line.5323"></a> |
| <span class="sourceLineNo">5324</span> * @return The converted thrown object.<a name="line.5324"></a> |
| <span class="sourceLineNo">5325</span> */<a name="line.5325"></a> |
| <span class="sourceLineNo">5326</span> @SuppressWarnings("deprecation")<a name="line.5326"></a> |
| <span class="sourceLineNo">5327</span> public Throwable convertThrowable(Throwable t) {<a name="line.5327"></a> |
| <span class="sourceLineNo">5328</span><a name="line.5328"></a> |
| <span class="sourceLineNo">5329</span> ClassInfo ci = ClassInfo.ofc(t);<a name="line.5329"></a> |
| <span class="sourceLineNo">5330</span> if (ci.is(InvocationTargetException.class)) {<a name="line.5330"></a> |
| <span class="sourceLineNo">5331</span> t = ((InvocationTargetException)t).getTargetException();<a name="line.5331"></a> |
| <span class="sourceLineNo">5332</span> ci = ClassInfo.ofc(t);<a name="line.5332"></a> |
| <span class="sourceLineNo">5333</span> }<a name="line.5333"></a> |
| <span class="sourceLineNo">5334</span><a name="line.5334"></a> |
| <span class="sourceLineNo">5335</span> if (ci.is(HttpRuntimeException.class)) {<a name="line.5335"></a> |
| <span class="sourceLineNo">5336</span> t = ((HttpRuntimeException)t).getInner();<a name="line.5336"></a> |
| <span class="sourceLineNo">5337</span> ci = ClassInfo.ofc(t);<a name="line.5337"></a> |
| <span class="sourceLineNo">5338</span> }<a name="line.5338"></a> |
| <span class="sourceLineNo">5339</span><a name="line.5339"></a> |
| <span class="sourceLineNo">5340</span> if (ci.isChildOf(RestException.class) || ci.hasAnnotation(Response.class))<a name="line.5340"></a> |
| <span class="sourceLineNo">5341</span> return t;<a name="line.5341"></a> |
| <span class="sourceLineNo">5342</span><a name="line.5342"></a> |
| <span class="sourceLineNo">5343</span> if (t instanceof ParseException || t instanceof InvalidDataConversionException)<a name="line.5343"></a> |
| <span class="sourceLineNo">5344</span> return new BadRequest(t);<a name="line.5344"></a> |
| <span class="sourceLineNo">5345</span><a name="line.5345"></a> |
| <span class="sourceLineNo">5346</span> String n = t.getClass().getName();<a name="line.5346"></a> |
| <span class="sourceLineNo">5347</span><a name="line.5347"></a> |
| <span class="sourceLineNo">5348</span> if (n.contains("AccessDenied") || n.contains("Unauthorized"))<a name="line.5348"></a> |
| <span class="sourceLineNo">5349</span> return new Unauthorized(t);<a name="line.5349"></a> |
| <span class="sourceLineNo">5350</span><a name="line.5350"></a> |
| <span class="sourceLineNo">5351</span> if (n.contains("Empty") || n.contains("NotFound"))<a name="line.5351"></a> |
| <span class="sourceLineNo">5352</span> return new NotFound(t);<a name="line.5352"></a> |
| <span class="sourceLineNo">5353</span><a name="line.5353"></a> |
| <span class="sourceLineNo">5354</span> return t;<a name="line.5354"></a> |
| <span class="sourceLineNo">5355</span> }<a name="line.5355"></a> |
| <span class="sourceLineNo">5356</span><a name="line.5356"></a> |
| <span class="sourceLineNo">5357</span> /**<a name="line.5357"></a> |
| <span class="sourceLineNo">5358</span> * Handle the case where a matching method was not found.<a name="line.5358"></a> |
| <span class="sourceLineNo">5359</span> *<a name="line.5359"></a> |
| <span class="sourceLineNo">5360</span> * <p><a name="line.5360"></a> |
| <span class="sourceLineNo">5361</span> * Subclasses can override this method to provide a 2nd-chance for specifying a response.<a name="line.5361"></a> |
| <span class="sourceLineNo">5362</span> * The default implementation will simply throw an exception with an appropriate message.<a name="line.5362"></a> |
| <span class="sourceLineNo">5363</span> *<a name="line.5363"></a> |
| <span class="sourceLineNo">5364</span> * @param call The HTTP call.<a name="line.5364"></a> |
| <span class="sourceLineNo">5365</span> * @throws Exception Any exception can be thrown.<a name="line.5365"></a> |
| <span class="sourceLineNo">5366</span> */<a name="line.5366"></a> |
| <span class="sourceLineNo">5367</span> public void handleNotFound(RestCall call) throws Exception {<a name="line.5367"></a> |
| <span class="sourceLineNo">5368</span> String pathInfo = call.getPathInfo();<a name="line.5368"></a> |
| <span class="sourceLineNo">5369</span> String methodUC = call.getMethod();<a name="line.5369"></a> |
| <span class="sourceLineNo">5370</span> int rc = call.getStatus();<a name="line.5370"></a> |
| <span class="sourceLineNo">5371</span> String onPath = pathInfo == null ? " on no pathInfo" : String.format(" on path '%s'", pathInfo);<a name="line.5371"></a> |
| <span class="sourceLineNo">5372</span> if (rc == SC_NOT_FOUND)<a name="line.5372"></a> |
| <span class="sourceLineNo">5373</span> throw new NotFound("Method ''{0}'' not found on resource with matching pattern{1}.", methodUC, onPath);<a name="line.5373"></a> |
| <span class="sourceLineNo">5374</span> else if (rc == SC_PRECONDITION_FAILED)<a name="line.5374"></a> |
| <span class="sourceLineNo">5375</span> throw new PreconditionFailed("Method ''{0}'' not found on resource{1} with matching matcher.", methodUC, onPath);<a name="line.5375"></a> |
| <span class="sourceLineNo">5376</span> else if (rc == SC_METHOD_NOT_ALLOWED)<a name="line.5376"></a> |
| <span class="sourceLineNo">5377</span> throw new MethodNotAllowed("Method ''{0}'' not found on resource{1}.", methodUC, onPath);<a name="line.5377"></a> |
| <span class="sourceLineNo">5378</span> else<a name="line.5378"></a> |
| <span class="sourceLineNo">5379</span> throw new ServletException("Invalid method response: " + rc);<a name="line.5379"></a> |
| <span class="sourceLineNo">5380</span> }<a name="line.5380"></a> |
| <span class="sourceLineNo">5381</span><a name="line.5381"></a> |
| <span class="sourceLineNo">5382</span> /**<a name="line.5382"></a> |
| <span class="sourceLineNo">5383</span> * Method for handling response errors.<a name="line.5383"></a> |
| <span class="sourceLineNo">5384</span> *<a name="line.5384"></a> |
| <span class="sourceLineNo">5385</span> * <p><a name="line.5385"></a> |
| <span class="sourceLineNo">5386</span> * Subclasses can override this method to provide their own custom error response handling.<a name="line.5386"></a> |
| <span class="sourceLineNo">5387</span> *<a name="line.5387"></a> |
| <span class="sourceLineNo">5388</span> * @param call The rest call.<a name="line.5388"></a> |
| <span class="sourceLineNo">5389</span> * @param e The exception that occurred.<a name="line.5389"></a> |
| <span class="sourceLineNo">5390</span> * @throws IOException Can be thrown if a problem occurred trying to write to the output stream.<a name="line.5390"></a> |
| <span class="sourceLineNo">5391</span> */<a name="line.5391"></a> |
| <span class="sourceLineNo">5392</span> @SuppressWarnings("deprecation")<a name="line.5392"></a> |
| <span class="sourceLineNo">5393</span> public synchronized void handleError(RestCall call, Throwable e) throws IOException {<a name="line.5393"></a> |
| <span class="sourceLineNo">5394</span><a name="line.5394"></a> |
| <span class="sourceLineNo">5395</span> call.exception(e);<a name="line.5395"></a> |
| <span class="sourceLineNo">5396</span><a name="line.5396"></a> |
| <span class="sourceLineNo">5397</span> if (call.isDebug())<a name="line.5397"></a> |
| <span class="sourceLineNo">5398</span> e.printStackTrace();<a name="line.5398"></a> |
| <span class="sourceLineNo">5399</span><a name="line.5399"></a> |
| <span class="sourceLineNo">5400</span> int occurrence = getStackTraceOccurrence(e);<a name="line.5400"></a> |
| <span class="sourceLineNo">5401</span><a name="line.5401"></a> |
| <span class="sourceLineNo">5402</span> int code = 500;<a name="line.5402"></a> |
| <span class="sourceLineNo">5403</span><a name="line.5403"></a> |
| <span class="sourceLineNo">5404</span> ClassInfo ci = ClassInfo.ofc(e);<a name="line.5404"></a> |
| <span class="sourceLineNo">5405</span> Response r = ci.getLastAnnotation(Response.class);<a name="line.5405"></a> |
| <span class="sourceLineNo">5406</span> if (r != null)<a name="line.5406"></a> |
| <span class="sourceLineNo">5407</span> if (r.code().length > 0)<a name="line.5407"></a> |
| <span class="sourceLineNo">5408</span> code = r.code()[0];<a name="line.5408"></a> |
| <span class="sourceLineNo">5409</span><a name="line.5409"></a> |
| <span class="sourceLineNo">5410</span> RestException e2 = (e instanceof RestException ? (RestException)e : new RestException(e, code)).setOccurrence(occurrence);<a name="line.5410"></a> |
| <span class="sourceLineNo">5411</span><a name="line.5411"></a> |
| <span class="sourceLineNo">5412</span> HttpServletRequest req = call.getRequest();<a name="line.5412"></a> |
| <span class="sourceLineNo">5413</span> HttpServletResponse res = call.getResponse();<a name="line.5413"></a> |
| <span class="sourceLineNo">5414</span><a name="line.5414"></a> |
| <span class="sourceLineNo">5415</span> Throwable t = null;<a name="line.5415"></a> |
| <span class="sourceLineNo">5416</span> if (e instanceof HttpRuntimeException)<a name="line.5416"></a> |
| <span class="sourceLineNo">5417</span> t = ((HttpRuntimeException)e).getInner();<a name="line.5417"></a> |
| <span class="sourceLineNo">5418</span> if (t == null)<a name="line.5418"></a> |
| <span class="sourceLineNo">5419</span> t = e2.getRootCause();<a name="line.5419"></a> |
| <span class="sourceLineNo">5420</span> if (t != null) {<a name="line.5420"></a> |
| <span class="sourceLineNo">5421</span> res.setHeader("Exception-Name", stripInvalidHttpHeaderChars(t.getClass().getName()));<a name="line.5421"></a> |
| <span class="sourceLineNo">5422</span> res.setHeader("Exception-Message", stripInvalidHttpHeaderChars(t.getMessage()));<a name="line.5422"></a> |
| <span class="sourceLineNo">5423</span> }<a name="line.5423"></a> |
| <span class="sourceLineNo">5424</span><a name="line.5424"></a> |
| <span class="sourceLineNo">5425</span> try {<a name="line.5425"></a> |
| <span class="sourceLineNo">5426</span> res.setContentType("text/plain");<a name="line.5426"></a> |
| <span class="sourceLineNo">5427</span> res.setHeader("Content-Encoding", "identity");<a name="line.5427"></a> |
| <span class="sourceLineNo">5428</span> res.setStatus(e2.getStatus());<a name="line.5428"></a> |
| <span class="sourceLineNo">5429</span><a name="line.5429"></a> |
| <span class="sourceLineNo">5430</span> PrintWriter w = null;<a name="line.5430"></a> |
| <span class="sourceLineNo">5431</span> try {<a name="line.5431"></a> |
| <span class="sourceLineNo">5432</span> w = res.getWriter();<a name="line.5432"></a> |
| <span class="sourceLineNo">5433</span> } catch (IllegalStateException x) {<a name="line.5433"></a> |
| <span class="sourceLineNo">5434</span> w = new PrintWriter(new OutputStreamWriter(res.getOutputStream(), UTF8));<a name="line.5434"></a> |
| <span class="sourceLineNo">5435</span> }<a name="line.5435"></a> |
| <span class="sourceLineNo">5436</span><a name="line.5436"></a> |
| <span class="sourceLineNo">5437</span> try (PrintWriter w2 = w) {<a name="line.5437"></a> |
| <span class="sourceLineNo">5438</span> String httpMessage = RestUtils.getHttpResponseText(e2.getStatus());<a name="line.5438"></a> |
| <span class="sourceLineNo">5439</span> if (httpMessage != null)<a name="line.5439"></a> |
| <span class="sourceLineNo">5440</span> w2.append("HTTP ").append(String.valueOf(e2.getStatus())).append(": ").append(httpMessage).append("\n\n");<a name="line.5440"></a> |
| <span class="sourceLineNo">5441</span> if (isRenderResponseStackTraces())<a name="line.5441"></a> |
| <span class="sourceLineNo">5442</span> e.printStackTrace(w2);<a name="line.5442"></a> |
| <span class="sourceLineNo">5443</span> else<a name="line.5443"></a> |
| <span class="sourceLineNo">5444</span> w2.append(e2.getFullStackMessage(true));<a name="line.5444"></a> |
| <span class="sourceLineNo">5445</span> }<a name="line.5445"></a> |
| <span class="sourceLineNo">5446</span><a name="line.5446"></a> |
| <span class="sourceLineNo">5447</span> } catch (Exception e1) {<a name="line.5447"></a> |
| <span class="sourceLineNo">5448</span> req.setAttribute("Exception", e1);<a name="line.5448"></a> |
| <span class="sourceLineNo">5449</span> }<a name="line.5449"></a> |
| <span class="sourceLineNo">5450</span> }<a name="line.5450"></a> |
| <span class="sourceLineNo">5451</span><a name="line.5451"></a> |
| <span class="sourceLineNo">5452</span> /**<a name="line.5452"></a> |
| <span class="sourceLineNo">5453</span> * Returns the session objects for the specified request.<a name="line.5453"></a> |
| <span class="sourceLineNo">5454</span> *<a name="line.5454"></a> |
| <span class="sourceLineNo">5455</span> * <p><a name="line.5455"></a> |
| <span class="sourceLineNo">5456</span> * The default implementation simply returns a single map containing <c>{'req':req,'res',res}</c>.<a name="line.5456"></a> |
| <span class="sourceLineNo">5457</span> *<a name="line.5457"></a> |
| <span class="sourceLineNo">5458</span> * @param call The current REST call.<a name="line.5458"></a> |
| <span class="sourceLineNo">5459</span> * @return The session objects for that request.<a name="line.5459"></a> |
| <span class="sourceLineNo">5460</span> */<a name="line.5460"></a> |
| <span class="sourceLineNo">5461</span> public Map<String,Object> getSessionObjects(RestCall call) {<a name="line.5461"></a> |
| <span class="sourceLineNo">5462</span> Map<String,Object> m = new HashMap<>();<a name="line.5462"></a> |
| <span class="sourceLineNo">5463</span> m.put("req", call.getRequest());<a name="line.5463"></a> |
| <span class="sourceLineNo">5464</span> m.put("res", call.getResponse());<a name="line.5464"></a> |
| <span class="sourceLineNo">5465</span> return m;<a name="line.5465"></a> |
| <span class="sourceLineNo">5466</span> }<a name="line.5466"></a> |
| <span class="sourceLineNo">5467</span><a name="line.5467"></a> |
| <span class="sourceLineNo">5468</span> /**<a name="line.5468"></a> |
| <span class="sourceLineNo">5469</span> * Called at the start of a request to invoke all {@link HookEvent#START_CALL} methods.<a name="line.5469"></a> |
| <span class="sourceLineNo">5470</span> *<a name="line.5470"></a> |
| <span class="sourceLineNo">5471</span> * @param call The current request.<a name="line.5471"></a> |
| <span class="sourceLineNo">5472</span> */<a name="line.5472"></a> |
| <span class="sourceLineNo">5473</span> protected void startCall(RestCall call) {<a name="line.5473"></a> |
| <span class="sourceLineNo">5474</span> for (int i = 0; i < startCallMethods.length; i++)<a name="line.5474"></a> |
| <span class="sourceLineNo">5475</span> startOrFinish(resource, startCallMethods[i], startCallMethodParams[i], call.getRequest(), call.getResponse());<a name="line.5475"></a> |
| <span class="sourceLineNo">5476</span> }<a name="line.5476"></a> |
| <span class="sourceLineNo">5477</span><a name="line.5477"></a> |
| <span class="sourceLineNo">5478</span> /**<a name="line.5478"></a> |
| <span class="sourceLineNo">5479</span> * Called during a request to invoke all {@link HookEvent#PRE_CALL} methods.<a name="line.5479"></a> |
| <span class="sourceLineNo">5480</span> *<a name="line.5480"></a> |
| <span class="sourceLineNo">5481</span> * @param call The current request.<a name="line.5481"></a> |
| <span class="sourceLineNo">5482</span> * @throws HttpException If thrown from call methods.<a name="line.5482"></a> |
| <span class="sourceLineNo">5483</span> */<a name="line.5483"></a> |
| <span class="sourceLineNo">5484</span> protected void preCall(RestCall call) throws HttpException {<a name="line.5484"></a> |
| <span class="sourceLineNo">5485</span> for (int i = 0; i < preCallMethods.length; i++)<a name="line.5485"></a> |
| <span class="sourceLineNo">5486</span> preOrPost(resource, preCallMethods[i], preCallMethodParams[i], call);<a name="line.5486"></a> |
| <span class="sourceLineNo">5487</span> }<a name="line.5487"></a> |
| <span class="sourceLineNo">5488</span><a name="line.5488"></a> |
| <span class="sourceLineNo">5489</span> /**<a name="line.5489"></a> |
| <span class="sourceLineNo">5490</span> * Called during a request to invoke all {@link HookEvent#POST_CALL} methods.<a name="line.5490"></a> |
| <span class="sourceLineNo">5491</span> *<a name="line.5491"></a> |
| <span class="sourceLineNo">5492</span> * @param call The current request.<a name="line.5492"></a> |
| <span class="sourceLineNo">5493</span> * @throws HttpException If thrown from call methods.<a name="line.5493"></a> |
| <span class="sourceLineNo">5494</span> */<a name="line.5494"></a> |
| <span class="sourceLineNo">5495</span> protected void postCall(RestCall call) throws HttpException {<a name="line.5495"></a> |
| <span class="sourceLineNo">5496</span> for (int i = 0; i < postCallMethods.length; i++)<a name="line.5496"></a> |
| <span class="sourceLineNo">5497</span> preOrPost(resource, postCallMethods[i], postCallMethodParams[i], call);<a name="line.5497"></a> |
| <span class="sourceLineNo">5498</span> }<a name="line.5498"></a> |
| <span class="sourceLineNo">5499</span><a name="line.5499"></a> |
| <span class="sourceLineNo">5500</span> private static void preOrPost(Object resource, MethodInvoker m, RestMethodParam[] mp, RestCall call) throws HttpException {<a name="line.5500"></a> |
| <span class="sourceLineNo">5501</span> if (m != null) {<a name="line.5501"></a> |
| <span class="sourceLineNo">5502</span> Object[] args = new Object[mp.length];<a name="line.5502"></a> |
| <span class="sourceLineNo">5503</span> for (int i = 0; i < mp.length; i++) {<a name="line.5503"></a> |
| <span class="sourceLineNo">5504</span> try {<a name="line.5504"></a> |
| <span class="sourceLineNo">5505</span> args[i] = mp[i].resolve(call.getRestRequest(), call.getRestResponse());<a name="line.5505"></a> |
| <span class="sourceLineNo">5506</span> } catch (Exception e) {<a name="line.5506"></a> |
| <span class="sourceLineNo">5507</span> throw toHttpException(e, BadRequest.class, "Invalid data conversion. Could not convert {0} ''{1}'' to type ''{2}'' on method ''{3}.{4}''.", mp[i].getParamType().name(), mp[i].getName(), mp[i].getType(), m.getDeclaringClass().getName(), m.getName());<a name="line.5507"></a> |
| <span class="sourceLineNo">5508</span> }<a name="line.5508"></a> |
| <span class="sourceLineNo">5509</span> }<a name="line.5509"></a> |
| <span class="sourceLineNo">5510</span> try {<a name="line.5510"></a> |
| <span class="sourceLineNo">5511</span> m.invoke(resource, args);<a name="line.5511"></a> |
| <span class="sourceLineNo">5512</span> } catch (Exception e) {<a name="line.5512"></a> |
| <span class="sourceLineNo">5513</span> throw toHttpException(e, InternalServerError.class);<a name="line.5513"></a> |
| <span class="sourceLineNo">5514</span> }<a name="line.5514"></a> |
| <span class="sourceLineNo">5515</span> }<a name="line.5515"></a> |
| <span class="sourceLineNo">5516</span> }<a name="line.5516"></a> |
| <span class="sourceLineNo">5517</span><a name="line.5517"></a> |
| <span class="sourceLineNo">5518</span> /**<a name="line.5518"></a> |
| <span class="sourceLineNo">5519</span> * Called at the end of a request to invoke all {@link HookEvent#END_CALL} methods.<a name="line.5519"></a> |
| <span class="sourceLineNo">5520</span> *<a name="line.5520"></a> |
| <span class="sourceLineNo">5521</span> * <p><a name="line.5521"></a> |
| <span class="sourceLineNo">5522</span> * This is the very last method called in {@link #execute(HttpServletRequest, HttpServletResponse)}.<a name="line.5522"></a> |
| <span class="sourceLineNo">5523</span> *<a name="line.5523"></a> |
| <span class="sourceLineNo">5524</span> * @param call The current request.<a name="line.5524"></a> |
| <span class="sourceLineNo">5525</span> */<a name="line.5525"></a> |
| <span class="sourceLineNo">5526</span> protected void finishCall(RestCall call) {<a name="line.5526"></a> |
| <span class="sourceLineNo">5527</span> for (int i = 0; i < endCallMethods.length; i++)<a name="line.5527"></a> |
| <span class="sourceLineNo">5528</span> startOrFinish(resource, endCallMethods[i], endCallMethodParams[i], call.getRequest(), call.getResponse());<a name="line.5528"></a> |
| <span class="sourceLineNo">5529</span> }<a name="line.5529"></a> |
| <span class="sourceLineNo">5530</span><a name="line.5530"></a> |
| <span class="sourceLineNo">5531</span> private static void startOrFinish(Object resource, MethodInvoker m, Class<?>[] p, HttpServletRequest req, HttpServletResponse res) throws HttpException, InternalServerError {<a name="line.5531"></a> |
| <span class="sourceLineNo">5532</span> if (m != null) {<a name="line.5532"></a> |
| <span class="sourceLineNo">5533</span> Object[] args = new Object[p.length];<a name="line.5533"></a> |
| <span class="sourceLineNo">5534</span> for (int i = 0; i < p.length; i++) {<a name="line.5534"></a> |
| <span class="sourceLineNo">5535</span> if (p[i] == HttpServletRequest.class)<a name="line.5535"></a> |
| <span class="sourceLineNo">5536</span> args[i] = req;<a name="line.5536"></a> |
| <span class="sourceLineNo">5537</span> else if (p[i] == HttpServletResponse.class)<a name="line.5537"></a> |
| <span class="sourceLineNo">5538</span> args[i] = res;<a name="line.5538"></a> |
| <span class="sourceLineNo">5539</span> }<a name="line.5539"></a> |
| <span class="sourceLineNo">5540</span> try {<a name="line.5540"></a> |
| <span class="sourceLineNo">5541</span> m.invoke(resource, args);<a name="line.5541"></a> |
| <span class="sourceLineNo">5542</span> } catch (Exception e) {<a name="line.5542"></a> |
| <span class="sourceLineNo">5543</span> throw toHttpException(e, InternalServerError.class);<a name="line.5543"></a> |
| <span class="sourceLineNo">5544</span> }<a name="line.5544"></a> |
| <span class="sourceLineNo">5545</span> }<a name="line.5545"></a> |
| <span class="sourceLineNo">5546</span> }<a name="line.5546"></a> |
| <span class="sourceLineNo">5547</span><a name="line.5547"></a> |
| <span class="sourceLineNo">5548</span> /**<a name="line.5548"></a> |
| <span class="sourceLineNo">5549</span> * Called during servlet initialization to invoke all {@link HookEvent#POST_INIT} methods.<a name="line.5549"></a> |
| <span class="sourceLineNo">5550</span> *<a name="line.5550"></a> |
| <span class="sourceLineNo">5551</span> * @return This object (for method chaining).<a name="line.5551"></a> |
| <span class="sourceLineNo">5552</span> * @throws ServletException Error occurred.<a name="line.5552"></a> |
| <span class="sourceLineNo">5553</span> */<a name="line.5553"></a> |
| <span class="sourceLineNo">5554</span> public RestContext postInit() throws ServletException {<a name="line.5554"></a> |
| <span class="sourceLineNo">5555</span> for (int i = 0; i < postInitMethods.length; i++)<a name="line.5555"></a> |
| <span class="sourceLineNo">5556</span> postInitOrDestroy(resource, postInitMethods[i], postInitMethodParams[i]);<a name="line.5556"></a> |
| <span class="sourceLineNo">5557</span> for (RestContext childContext : this.childResources.values())<a name="line.5557"></a> |
| <span class="sourceLineNo">5558</span> childContext.postInit();<a name="line.5558"></a> |
| <span class="sourceLineNo">5559</span> return this;<a name="line.5559"></a> |
| <span class="sourceLineNo">5560</span> }<a name="line.5560"></a> |
| <span class="sourceLineNo">5561</span><a name="line.5561"></a> |
| <span class="sourceLineNo">5562</span> /**<a name="line.5562"></a> |
| <span class="sourceLineNo">5563</span> * Called during servlet initialization to invoke all {@link HookEvent#POST_INIT_CHILD_FIRST} methods.<a name="line.5563"></a> |
| <span class="sourceLineNo">5564</span> *<a name="line.5564"></a> |
| <span class="sourceLineNo">5565</span> * @return This object (for method chaining).<a name="line.5565"></a> |
| <span class="sourceLineNo">5566</span> * @throws ServletException Error occurred.<a name="line.5566"></a> |
| <span class="sourceLineNo">5567</span> */<a name="line.5567"></a> |
| <span class="sourceLineNo">5568</span> public RestContext postInitChildFirst() throws ServletException {<a name="line.5568"></a> |
| <span class="sourceLineNo">5569</span> for (RestContext childContext : this.childResources.values())<a name="line.5569"></a> |
| <span class="sourceLineNo">5570</span> childContext.postInitChildFirst();<a name="line.5570"></a> |
| <span class="sourceLineNo">5571</span> for (int i = 0; i < postInitChildFirstMethods.length; i++)<a name="line.5571"></a> |
| <span class="sourceLineNo">5572</span> postInitOrDestroy(resource, postInitChildFirstMethods[i], postInitChildFirstMethodParams[i]);<a name="line.5572"></a> |
| <span class="sourceLineNo">5573</span> return this;<a name="line.5573"></a> |
| <span class="sourceLineNo">5574</span> }<a name="line.5574"></a> |
| <span class="sourceLineNo">5575</span><a name="line.5575"></a> |
| <span class="sourceLineNo">5576</span> private void postInitOrDestroy(Object r, MethodInvoker m, Class<?>[] p) {<a name="line.5576"></a> |
| <span class="sourceLineNo">5577</span> if (m != null) {<a name="line.5577"></a> |
| <span class="sourceLineNo">5578</span> Object[] args = new Object[p.length];<a name="line.5578"></a> |
| <span class="sourceLineNo">5579</span> for (int i = 0; i < p.length; i++) {<a name="line.5579"></a> |
| <span class="sourceLineNo">5580</span> if (p[i] == RestContext.class)<a name="line.5580"></a> |
| <span class="sourceLineNo">5581</span> args[i] = this;<a name="line.5581"></a> |
| <span class="sourceLineNo">5582</span> else if (p[i] == RestContextBuilder.class)<a name="line.5582"></a> |
| <span class="sourceLineNo">5583</span> args[i] = this.builder;<a name="line.5583"></a> |
| <span class="sourceLineNo">5584</span> else if (p[i] == ServletConfig.class)<a name="line.5584"></a> |
| <span class="sourceLineNo">5585</span> args[i] = this.builder.inner;<a name="line.5585"></a> |
| <span class="sourceLineNo">5586</span> }<a name="line.5586"></a> |
| <span class="sourceLineNo">5587</span> try {<a name="line.5587"></a> |
| <span class="sourceLineNo">5588</span> m.invoke(r, args);<a name="line.5588"></a> |
| <span class="sourceLineNo">5589</span> } catch (Exception e) {<a name="line.5589"></a> |
| <span class="sourceLineNo">5590</span> if (e instanceof RuntimeException && ClassInfo.of(e).hasAnnotation(Response.class))<a name="line.5590"></a> |
| <span class="sourceLineNo">5591</span> throw (RuntimeException)e;<a name="line.5591"></a> |
| <span class="sourceLineNo">5592</span> throw new InternalServerError(e);<a name="line.5592"></a> |
| <span class="sourceLineNo">5593</span> }<a name="line.5593"></a> |
| <span class="sourceLineNo">5594</span> }<a name="line.5594"></a> |
| <span class="sourceLineNo">5595</span> }<a name="line.5595"></a> |
| <span class="sourceLineNo">5596</span><a name="line.5596"></a> |
| <span class="sourceLineNo">5597</span> /**<a name="line.5597"></a> |
| <span class="sourceLineNo">5598</span> * Called during servlet initialization to invoke all {@link HookEvent#DESTROY} methods.<a name="line.5598"></a> |
| <span class="sourceLineNo">5599</span> */<a name="line.5599"></a> |
| <span class="sourceLineNo">5600</span> protected void destroy() {<a name="line.5600"></a> |
| <span class="sourceLineNo">5601</span> for (int i = 0; i < destroyMethods.length; i++) {<a name="line.5601"></a> |
| <span class="sourceLineNo">5602</span> try {<a name="line.5602"></a> |
| <span class="sourceLineNo">5603</span> postInitOrDestroy(resource, destroyMethods[i], destroyMethodParams[i]);<a name="line.5603"></a> |
| <span class="sourceLineNo">5604</span> } catch (Exception e) {<a name="line.5604"></a> |
| <span class="sourceLineNo">5605</span> e.printStackTrace();<a name="line.5605"></a> |
| <span class="sourceLineNo">5606</span> }<a name="line.5606"></a> |
| <span class="sourceLineNo">5607</span> }<a name="line.5607"></a> |
| <span class="sourceLineNo">5608</span><a name="line.5608"></a> |
| <span class="sourceLineNo">5609</span> for (RestContext r : childResources.values()) {<a name="line.5609"></a> |
| <span class="sourceLineNo">5610</span> r.destroy();<a name="line.5610"></a> |
| <span class="sourceLineNo">5611</span> if (r.resource instanceof Servlet)<a name="line.5611"></a> |
| <span class="sourceLineNo">5612</span> ((Servlet)r.resource).destroy();<a name="line.5612"></a> |
| <span class="sourceLineNo">5613</span> }<a name="line.5613"></a> |
| <span class="sourceLineNo">5614</span> }<a name="line.5614"></a> |
| <span class="sourceLineNo">5615</span><a name="line.5615"></a> |
| <span class="sourceLineNo">5616</span> /**<a name="line.5616"></a> |
| <span class="sourceLineNo">5617</span> * Returns the HTTP request object for the current request.<a name="line.5617"></a> |
| <span class="sourceLineNo">5618</span> *<a name="line.5618"></a> |
| <span class="sourceLineNo">5619</span> * @return The HTTP request object, or <jk>null</jk> if it hasn't been created.<a name="line.5619"></a> |
| <span class="sourceLineNo">5620</span> */<a name="line.5620"></a> |
| <span class="sourceLineNo">5621</span> public RestRequest getRequest() {<a name="line.5621"></a> |
| <span class="sourceLineNo">5622</span> RestCall rc = call.get();<a name="line.5622"></a> |
| <span class="sourceLineNo">5623</span> return rc == null ? null : rc.getRestRequest();<a name="line.5623"></a> |
| <span class="sourceLineNo">5624</span> }<a name="line.5624"></a> |
| <span class="sourceLineNo">5625</span><a name="line.5625"></a> |
| <span class="sourceLineNo">5626</span> /**<a name="line.5626"></a> |
| <span class="sourceLineNo">5627</span> * Returns the HTTP response object for the current request.<a name="line.5627"></a> |
| <span class="sourceLineNo">5628</span> *<a name="line.5628"></a> |
| <span class="sourceLineNo">5629</span> * @return The HTTP response object, or <jk>null</jk> if it hasn't been created.<a name="line.5629"></a> |
| <span class="sourceLineNo">5630</span> */<a name="line.5630"></a> |
| <span class="sourceLineNo">5631</span> public RestResponse getResponse() {<a name="line.5631"></a> |
| <span class="sourceLineNo">5632</span> RestCall rc = call.get();<a name="line.5632"></a> |
| <span class="sourceLineNo">5633</span> return rc == null ? null : rc.getRestResponse();<a name="line.5633"></a> |
| <span class="sourceLineNo">5634</span> }<a name="line.5634"></a> |
| <span class="sourceLineNo">5635</span><a name="line.5635"></a> |
| <span class="sourceLineNo">5636</span> /**<a name="line.5636"></a> |
| <span class="sourceLineNo">5637</span> * If the specified object is annotated with {@link Response}, this returns the response metadata about that object.<a name="line.5637"></a> |
| <span class="sourceLineNo">5638</span> *<a name="line.5638"></a> |
| <span class="sourceLineNo">5639</span> * @param o The object to check.<a name="line.5639"></a> |
| <span class="sourceLineNo">5640</span> * @return The response metadata, or <jk>null</jk> if it wasn't annotated with {@link Response}.<a name="line.5640"></a> |
| <span class="sourceLineNo">5641</span> */<a name="line.5641"></a> |
| <span class="sourceLineNo">5642</span> public ResponseBeanMeta getResponseBeanMeta(Object o) {<a name="line.5642"></a> |
| <span class="sourceLineNo">5643</span> if (o == null)<a name="line.5643"></a> |
| <span class="sourceLineNo">5644</span> return null;<a name="line.5644"></a> |
| <span class="sourceLineNo">5645</span> Class<?> c = o.getClass();<a name="line.5645"></a> |
| <span class="sourceLineNo">5646</span> ResponseBeanMeta rbm = responseBeanMetas.get(c);<a name="line.5646"></a> |
| <span class="sourceLineNo">5647</span> if (rbm == null) {<a name="line.5647"></a> |
| <span class="sourceLineNo">5648</span> rbm = ResponseBeanMeta.create(c, serializers.getPropertyStore());<a name="line.5648"></a> |
| <span class="sourceLineNo">5649</span> if (rbm == null)<a name="line.5649"></a> |
| <span class="sourceLineNo">5650</span> rbm = ResponseBeanMeta.NULL;<a name="line.5650"></a> |
| <span class="sourceLineNo">5651</span> responseBeanMetas.put(c, rbm);<a name="line.5651"></a> |
| <span class="sourceLineNo">5652</span> }<a name="line.5652"></a> |
| <span class="sourceLineNo">5653</span> if (rbm == ResponseBeanMeta.NULL)<a name="line.5653"></a> |
| <span class="sourceLineNo">5654</span> return null;<a name="line.5654"></a> |
| <span class="sourceLineNo">5655</span> return rbm;<a name="line.5655"></a> |
| <span class="sourceLineNo">5656</span> }<a name="line.5656"></a> |
| <span class="sourceLineNo">5657</span><a name="line.5657"></a> |
| <span class="sourceLineNo">5658</span> Enablement getDebug() {<a name="line.5658"></a> |
| <span class="sourceLineNo">5659</span> return debug;<a name="line.5659"></a> |
| <span class="sourceLineNo">5660</span> }<a name="line.5660"></a> |
| <span class="sourceLineNo">5661</span><a name="line.5661"></a> |
| <span class="sourceLineNo">5662</span> /**<a name="line.5662"></a> |
| <span class="sourceLineNo">5663</span> * Clear any request state information on this context.<a name="line.5663"></a> |
| <span class="sourceLineNo">5664</span> * This should always be called in a finally block in the RestServlet.<a name="line.5664"></a> |
| <span class="sourceLineNo">5665</span> */<a name="line.5665"></a> |
| <span class="sourceLineNo">5666</span> void clearState() {<a name="line.5666"></a> |
| <span class="sourceLineNo">5667</span> call.remove();<a name="line.5667"></a> |
| <span class="sourceLineNo">5668</span> }<a name="line.5668"></a> |
| <span class="sourceLineNo">5669</span><a name="line.5669"></a> |
| <span class="sourceLineNo">5670</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.5670"></a> |
| <span class="sourceLineNo">5671</span> // Other methods.<a name="line.5671"></a> |
| <span class="sourceLineNo">5672</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.5672"></a> |
| <span class="sourceLineNo">5673</span><a name="line.5673"></a> |
| <span class="sourceLineNo">5674</span> @Override /* Context */<a name="line.5674"></a> |
| <span class="sourceLineNo">5675</span> public OMap toMap() {<a name="line.5675"></a> |
| <span class="sourceLineNo">5676</span> return super.toMap()<a name="line.5676"></a> |
| <span class="sourceLineNo">5677</span> .a("RestContext", new DefaultFilteringOMap()<a name="line.5677"></a> |
| <span class="sourceLineNo">5678</span> .a("allowBodyParam", allowBodyParam)<a name="line.5678"></a> |
| <span class="sourceLineNo">5679</span> .a("allowedMethodHeader", allowedMethodHeaders)<a name="line.5679"></a> |
| <span class="sourceLineNo">5680</span> .a("allowedMethodParams", allowedMethodParams)<a name="line.5680"></a> |
| <span class="sourceLineNo">5681</span> .a("allowedHeaderParams", allowedHeaderParams)<a name="line.5681"></a> |
| <span class="sourceLineNo">5682</span> .a("clientVersionHeader", clientVersionHeader)<a name="line.5682"></a> |
| <span class="sourceLineNo">5683</span> .a("consumes", consumes)<a name="line.5683"></a> |
| <span class="sourceLineNo">5684</span> .a("infoProvider", infoProvider)<a name="line.5684"></a> |
| <span class="sourceLineNo">5685</span> .a("logger", logger)<a name="line.5685"></a> |
| <span class="sourceLineNo">5686</span> .a("paramResolvers", paramResolvers)<a name="line.5686"></a> |
| <span class="sourceLineNo">5687</span> .a("parsers", parsers)<a name="line.5687"></a> |
| <span class="sourceLineNo">5688</span> .a("partParser", partParser)<a name="line.5688"></a> |
| <span class="sourceLineNo">5689</span> .a("partSerializer", partSerializer)<a name="line.5689"></a> |
| <span class="sourceLineNo">5690</span> .a("produces", produces)<a name="line.5690"></a> |
| <span class="sourceLineNo">5691</span> .a("properties", properties)<a name="line.5691"></a> |
| <span class="sourceLineNo">5692</span> .a("renderResponseStackTraces", renderResponseStackTraces)<a name="line.5692"></a> |
| <span class="sourceLineNo">5693</span> .a("reqHeaders", reqHeaders)<a name="line.5693"></a> |
| <span class="sourceLineNo">5694</span> .a("resHeaders", resHeaders)<a name="line.5694"></a> |
| <span class="sourceLineNo">5695</span> .a("resourceResolver", resourceResolver)<a name="line.5695"></a> |
| <span class="sourceLineNo">5696</span> .a("responseHandlers", responseHandlers)<a name="line.5696"></a> |
| <span class="sourceLineNo">5697</span> .a("serializers", serializers)<a name="line.5697"></a> |
| <span class="sourceLineNo">5698</span> .a("staticFileResponseHeaders", staticFileResponseHeaders)<a name="line.5698"></a> |
| <span class="sourceLineNo">5699</span> .a("staticFiles", staticFiles)<a name="line.5699"></a> |
| <span class="sourceLineNo">5700</span> .a("uriAuthority", uriAuthority)<a name="line.5700"></a> |
| <span class="sourceLineNo">5701</span> .a("uriContext", uriContext)<a name="line.5701"></a> |
| <span class="sourceLineNo">5702</span> .a("uriRelativity", uriRelativity)<a name="line.5702"></a> |
| <span class="sourceLineNo">5703</span> .a("uriResolution", uriResolution)<a name="line.5703"></a> |
| <span class="sourceLineNo">5704</span> .a("useClasspathResourceCaching", useClasspathResourceCaching)<a name="line.5704"></a> |
| <span class="sourceLineNo">5705</span> );<a name="line.5705"></a> |
| <span class="sourceLineNo">5706</span> }<a name="line.5706"></a> |
| <span class="sourceLineNo">5707</span><a name="line.5707"></a> |
| <span class="sourceLineNo">5708</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.5708"></a> |
| <span class="sourceLineNo">5709</span> // Helpers.<a name="line.5709"></a> |
| <span class="sourceLineNo">5710</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.5710"></a> |
| <span class="sourceLineNo">5711</span><a name="line.5711"></a> |
| <span class="sourceLineNo">5712</span> static class MethodMapBuilder {<a name="line.5712"></a> |
| <span class="sourceLineNo">5713</span> TreeMap<String,TreeSet<RestMethodContext>> map = new TreeMap<>();<a name="line.5713"></a> |
| <span class="sourceLineNo">5714</span> Set<RestMethodContext> set = ASet.of();<a name="line.5714"></a> |
| <span class="sourceLineNo">5715</span><a name="line.5715"></a> |
| <span class="sourceLineNo">5716</span><a name="line.5716"></a> |
| <span class="sourceLineNo">5717</span> MethodMapBuilder add(String httpMethodName, RestMethodContext mc) {<a name="line.5717"></a> |
| <span class="sourceLineNo">5718</span> httpMethodName = httpMethodName.toUpperCase();<a name="line.5718"></a> |
| <span class="sourceLineNo">5719</span> if (! map.containsKey(httpMethodName))<a name="line.5719"></a> |
| <span class="sourceLineNo">5720</span> map.put(httpMethodName, new TreeSet<>());<a name="line.5720"></a> |
| <span class="sourceLineNo">5721</span> map.get(httpMethodName).add(mc);<a name="line.5721"></a> |
| <span class="sourceLineNo">5722</span> set.add(mc);<a name="line.5722"></a> |
| <span class="sourceLineNo">5723</span> return this;<a name="line.5723"></a> |
| <span class="sourceLineNo">5724</span> }<a name="line.5724"></a> |
| <span class="sourceLineNo">5725</span><a name="line.5725"></a> |
| <span class="sourceLineNo">5726</span> Map<String,List<RestMethodContext>> getMap() {<a name="line.5726"></a> |
| <span class="sourceLineNo">5727</span> AMap<String,List<RestMethodContext>> m = AMap.of();<a name="line.5727"></a> |
| <span class="sourceLineNo">5728</span> for (Map.Entry<String,TreeSet<RestMethodContext>> e : map.entrySet())<a name="line.5728"></a> |
| <span class="sourceLineNo">5729</span> m.put(e.getKey(), AList.of(e.getValue()));<a name="line.5729"></a> |
| <span class="sourceLineNo">5730</span> return m.unmodifiable();<a name="line.5730"></a> |
| <span class="sourceLineNo">5731</span> }<a name="line.5731"></a> |
| <span class="sourceLineNo">5732</span><a name="line.5732"></a> |
| <span class="sourceLineNo">5733</span> List<RestMethodContext> getList() {<a name="line.5733"></a> |
| <span class="sourceLineNo">5734</span> return AList.of(set).unmodifiable();<a name="line.5734"></a> |
| <span class="sourceLineNo">5735</span> }<a name="line.5735"></a> |
| <span class="sourceLineNo">5736</span> }<a name="line.5736"></a> |
| <span class="sourceLineNo">5737</span>}<a name="line.5737"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
