http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/9b48e212/content/site/apidocs/src-html/org/apache/juneau/rest/RestInfoProvider.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestInfoProvider.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestInfoProvider.html index 59193c1..97e87f7 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestInfoProvider.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestInfoProvider.html @@ -53,413 +53,413 @@ <span class="sourceLineNo">045</span><a name="line.45"></a> <span class="sourceLineNo">046</span> private final RestContext context;<a name="line.46"></a> <span class="sourceLineNo">047</span> private final String<a name="line.47"></a> -<span class="sourceLineNo">048</span> title,<a name="line.48"></a> -<span class="sourceLineNo">049</span> description,<a name="line.49"></a> -<span class="sourceLineNo">050</span> termsOfService,<a name="line.50"></a> -<span class="sourceLineNo">051</span> contact,<a name="line.51"></a> -<span class="sourceLineNo">052</span> license,<a name="line.52"></a> -<span class="sourceLineNo">053</span> version,<a name="line.53"></a> -<span class="sourceLineNo">054</span> tags,<a name="line.54"></a> -<span class="sourceLineNo">055</span> externalDocs;<a name="line.55"></a> -<span class="sourceLineNo">056</span> private final ConcurrentHashMap<Locale,Swagger> swaggers = new ConcurrentHashMap<Locale,Swagger>();<a name="line.56"></a> -<span class="sourceLineNo">057</span><a name="line.57"></a> -<span class="sourceLineNo">058</span> /**<a name="line.58"></a> -<span class="sourceLineNo">059</span> * Constructor.<a name="line.59"></a> -<span class="sourceLineNo">060</span> *<a name="line.60"></a> -<span class="sourceLineNo">061</span> * @param context The resource context.<a name="line.61"></a> -<span class="sourceLineNo">062</span> */<a name="line.62"></a> -<span class="sourceLineNo">063</span> public RestInfoProvider(RestContext context) {<a name="line.63"></a> -<span class="sourceLineNo">064</span> this.context = context;<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> Builder b = new Builder(context);<a name="line.66"></a> -<span class="sourceLineNo">067</span> this.title = b.title;<a name="line.67"></a> -<span class="sourceLineNo">068</span> this.description = b.description;<a name="line.68"></a> -<span class="sourceLineNo">069</span> this.termsOfService = b.termsOfService;<a name="line.69"></a> -<span class="sourceLineNo">070</span> this.contact = b.contact;<a name="line.70"></a> -<span class="sourceLineNo">071</span> this.license = b.license;<a name="line.71"></a> -<span class="sourceLineNo">072</span> this.version = b.version;<a name="line.72"></a> -<span class="sourceLineNo">073</span> this.tags = b.tags;<a name="line.73"></a> -<span class="sourceLineNo">074</span> this.externalDocs = b.externalDocs;<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span><a name="line.76"></a> -<span class="sourceLineNo">077</span> private static class Builder {<a name="line.77"></a> -<span class="sourceLineNo">078</span> private String<a name="line.78"></a> -<span class="sourceLineNo">079</span> title,<a name="line.79"></a> -<span class="sourceLineNo">080</span> description,<a name="line.80"></a> -<span class="sourceLineNo">081</span> termsOfService,<a name="line.81"></a> -<span class="sourceLineNo">082</span> contact,<a name="line.82"></a> -<span class="sourceLineNo">083</span> license,<a name="line.83"></a> -<span class="sourceLineNo">084</span> version,<a name="line.84"></a> -<span class="sourceLineNo">085</span> tags,<a name="line.85"></a> -<span class="sourceLineNo">086</span> externalDocs;<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> Builder(RestContext context) {<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> LinkedHashMap<Class<?>,RestResource> restResourceAnnotationsParentFirst = findAnnotationsMapParentFirst(RestResource.class, context.getResource().getClass());<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> for (RestResource r : restResourceAnnotationsParentFirst.values()) {<a name="line.92"></a> -<span class="sourceLineNo">093</span> if (! r.title().isEmpty())<a name="line.93"></a> -<span class="sourceLineNo">094</span> title = r.title();<a name="line.94"></a> -<span class="sourceLineNo">095</span> if (! r.description().isEmpty())<a name="line.95"></a> -<span class="sourceLineNo">096</span> description = r.description();<a name="line.96"></a> -<span class="sourceLineNo">097</span> ResourceSwagger sr = r.swagger();<a name="line.97"></a> -<span class="sourceLineNo">098</span> if (! sr.termsOfService().isEmpty())<a name="line.98"></a> -<span class="sourceLineNo">099</span> termsOfService = sr.termsOfService();<a name="line.99"></a> -<span class="sourceLineNo">100</span> if (! sr.contact().isEmpty())<a name="line.100"></a> -<span class="sourceLineNo">101</span> contact = sr.contact();<a name="line.101"></a> -<span class="sourceLineNo">102</span> if (! sr.license().isEmpty())<a name="line.102"></a> -<span class="sourceLineNo">103</span> license = sr.license();<a name="line.103"></a> -<span class="sourceLineNo">104</span> if (! sr.version().isEmpty())<a name="line.104"></a> -<span class="sourceLineNo">105</span> version = sr.version();<a name="line.105"></a> -<span class="sourceLineNo">106</span> if (! sr.tags().isEmpty())<a name="line.106"></a> -<span class="sourceLineNo">107</span> tags = sr.tags();<a name="line.107"></a> -<span class="sourceLineNo">108</span> if (! sr.externalDocs().isEmpty())<a name="line.108"></a> -<span class="sourceLineNo">109</span> externalDocs = sr.externalDocs();<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span> }<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Returns the localized swagger for this REST resource.<a name="line.115"></a> -<span class="sourceLineNo">116</span> *<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param req The incoming HTTP request.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @return A new Swagger instance.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @throws RestException<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> protected Swagger getSwagger(RestRequest req) throws RestException {<a name="line.121"></a> -<span class="sourceLineNo">122</span> try {<a name="line.122"></a> -<span class="sourceLineNo">123</span> // If a file is defined, use that.<a name="line.123"></a> -<span class="sourceLineNo">124</span> Swagger s = req.getSwaggerFromFile();<a name="line.124"></a> -<span class="sourceLineNo">125</span> if (s != null)<a name="line.125"></a> -<span class="sourceLineNo">126</span> return s;<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> s = swagger(<a name="line.128"></a> -<span class="sourceLineNo">129</span> info(getTitle(req), getVersion(req))<a name="line.129"></a> -<span class="sourceLineNo">130</span> .contact(getContact(req))<a name="line.130"></a> -<span class="sourceLineNo">131</span> .license(getLicense(req))<a name="line.131"></a> -<span class="sourceLineNo">132</span> .description(getDescription(req))<a name="line.132"></a> -<span class="sourceLineNo">133</span> .termsOfService(getTermsOfService(req))<a name="line.133"></a> -<span class="sourceLineNo">134</span> )<a name="line.134"></a> -<span class="sourceLineNo">135</span> .consumes(context.getSupportedAcceptTypes())<a name="line.135"></a> -<span class="sourceLineNo">136</span> .produces(context.getSupportedContentTypes())<a name="line.136"></a> -<span class="sourceLineNo">137</span> .tags(getTags(req))<a name="line.137"></a> -<span class="sourceLineNo">138</span> .externalDocs(getExternalDocs(req));<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> for (CallMethod sm : context.getCallMethods().values()) {<a name="line.140"></a> -<span class="sourceLineNo">141</span> if (sm.isRequestAllowed(req)) {<a name="line.141"></a> -<span class="sourceLineNo">142</span> Operation o = sm.getSwaggerOperation(req);<a name="line.142"></a> -<span class="sourceLineNo">143</span> s.path(<a name="line.143"></a> -<span class="sourceLineNo">144</span> sm.getPathPattern(),<a name="line.144"></a> -<span class="sourceLineNo">145</span> sm.getHttpMethod().toLowerCase(),<a name="line.145"></a> -<span class="sourceLineNo">146</span> o<a name="line.146"></a> -<span class="sourceLineNo">147</span> );<a name="line.147"></a> -<span class="sourceLineNo">148</span> }<a name="line.148"></a> -<span class="sourceLineNo">149</span> }<a name="line.149"></a> -<span class="sourceLineNo">150</span> return s;<a name="line.150"></a> -<span class="sourceLineNo">151</span> } catch (RestException e) {<a name="line.151"></a> -<span class="sourceLineNo">152</span> throw e;<a name="line.152"></a> -<span class="sourceLineNo">153</span> } catch (Exception e) {<a name="line.153"></a> -<span class="sourceLineNo">154</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.154"></a> -<span class="sourceLineNo">155</span> }<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> /**<a name="line.158"></a> -<span class="sourceLineNo">159</span> * Returns the localized Swagger from the file system.<a name="line.159"></a> -<span class="sourceLineNo">160</span> *<a name="line.160"></a> -<span class="sourceLineNo">161</span> * <p><a name="line.161"></a> -<span class="sourceLineNo">162</span> * Looks for a file called <js>"{ServletClass}_{locale}.json"</js> in the same package as this servlet and returns<a name="line.162"></a> -<span class="sourceLineNo">163</span> * it as a parsed {@link Swagger} object.<a name="line.163"></a> -<span class="sourceLineNo">164</span> *<a name="line.164"></a> -<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> -<span class="sourceLineNo">166</span> * Returned objects are cached for later quick-lookup.<a name="line.166"></a> -<span class="sourceLineNo">167</span> *<a name="line.167"></a> -<span class="sourceLineNo">168</span> * @param locale The locale of the swagger.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @return The parsed swagger object, or <jk>null</jk> if the swagger file could not be found.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @throws RestException<a name="line.170"></a> -<span class="sourceLineNo">171</span> */<a name="line.171"></a> -<span class="sourceLineNo">172</span> protected Swagger getSwaggerFromFile(Locale locale) throws RestException {<a name="line.172"></a> -<span class="sourceLineNo">173</span> Swagger s = swaggers.get(locale);<a name="line.173"></a> -<span class="sourceLineNo">174</span> if (s == null) {<a name="line.174"></a> -<span class="sourceLineNo">175</span> try {<a name="line.175"></a> -<span class="sourceLineNo">176</span> s = context.getResource(Swagger.class, MediaType.JSON, getClass().getSimpleName() + ".json", locale);<a name="line.176"></a> -<span class="sourceLineNo">177</span> swaggers.putIfAbsent(locale, s == null ? Swagger.NULL : s);<a name="line.177"></a> -<span class="sourceLineNo">178</span> } catch (Exception e) {<a name="line.178"></a> -<span class="sourceLineNo">179</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.179"></a> -<span class="sourceLineNo">180</span> }<a name="line.180"></a> -<span class="sourceLineNo">181</span> }<a name="line.181"></a> -<span class="sourceLineNo">182</span> return s == Swagger.NULL ? null : s;<a name="line.182"></a> -<span class="sourceLineNo">183</span> }<a name="line.183"></a> -<span class="sourceLineNo">184</span><a name="line.184"></a> -<span class="sourceLineNo">185</span> /**<a name="line.185"></a> -<span class="sourceLineNo">186</span> * Returns the localized summary of the specified java method on this servlet.<a name="line.186"></a> -<span class="sourceLineNo">187</span> *<a name="line.187"></a> -<span class="sourceLineNo">188</span> * <p><a name="line.188"></a> -<span class="sourceLineNo">189</span> * Subclasses can override this method to provide their own summary.<a name="line.189"></a> -<span class="sourceLineNo">190</span> *<a name="line.190"></a> -<span class="sourceLineNo">191</span> * <p><a name="line.191"></a> -<span class="sourceLineNo">192</span> * The default implementation returns the summary from the following locations (whichever matches first):<a name="line.192"></a> -<span class="sourceLineNo">193</span> * <ol><a name="line.193"></a> -<span class="sourceLineNo">194</span> * <li>{@link RestMethod#summary() @RestMethod.summary()} annotation on the method.<a name="line.194"></a> -<span class="sourceLineNo">195</span> * <li><ck>[ClassName].[javaMethodName].summary</ck> property in resource bundle identified by<a name="line.195"></a> -<span class="sourceLineNo">196</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * <li><ck>[javaMethodName].summary</ck> property in resource bundle identified by<a name="line.197"></a> -<span class="sourceLineNo">198</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * </ol><a name="line.199"></a> -<span class="sourceLineNo">200</span> *<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @param javaMethodName The name of the Java method whose description we're retrieving.<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param req The current request.<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @return The localized summary of the method, or a blank string if no summary was found.<a name="line.203"></a> -<span class="sourceLineNo">204</span> */<a name="line.204"></a> -<span class="sourceLineNo">205</span> public String getMethodSummary(String javaMethodName, RestRequest req) {<a name="line.205"></a> -<span class="sourceLineNo">206</span> CallMethod m = context.getCallMethods().get(javaMethodName);<a name="line.206"></a> -<span class="sourceLineNo">207</span> if (m != null)<a name="line.207"></a> -<span class="sourceLineNo">208</span> return m.getSummary(req);<a name="line.208"></a> -<span class="sourceLineNo">209</span> return "";<a name="line.209"></a> -<span class="sourceLineNo">210</span> }<a name="line.210"></a> -<span class="sourceLineNo">211</span><a name="line.211"></a> -<span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * Returns the localized description of the specified java method on this servlet.<a name="line.213"></a> -<span class="sourceLineNo">214</span> *<a name="line.214"></a> -<span class="sourceLineNo">215</span> * <p><a name="line.215"></a> -<span class="sourceLineNo">216</span> * Subclasses can override this method to provide their own description.<a name="line.216"></a> -<span class="sourceLineNo">217</span> *<a name="line.217"></a> -<span class="sourceLineNo">218</span> * <p><a name="line.218"></a> -<span class="sourceLineNo">219</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.219"></a> -<span class="sourceLineNo">220</span> * <ol><a name="line.220"></a> -<span class="sourceLineNo">221</span> * <li>{@link RestMethod#description() @RestMethod.description()} annotation on the method.<a name="line.221"></a> -<span class="sourceLineNo">222</span> * <li><ck>[ClassName].[javaMethodName].description</ck> property in resource bundle identified by<a name="line.222"></a> -<span class="sourceLineNo">223</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.223"></a> -<span class="sourceLineNo">224</span> * <li><ck>[javaMethodName].description</ck> property in resource bundle identified by<a name="line.224"></a> -<span class="sourceLineNo">225</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.225"></a> -<span class="sourceLineNo">226</span> * </ol><a name="line.226"></a> -<span class="sourceLineNo">227</span> *<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @param javaMethodName The name of the Java method whose description we're retrieving.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @param req The current request.<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @return The localized description of the method, or a blank string if no description was found.<a name="line.230"></a> -<span class="sourceLineNo">231</span> */<a name="line.231"></a> -<span class="sourceLineNo">232</span> protected String getMethodDescription(String javaMethodName, RestRequest req) {<a name="line.232"></a> -<span class="sourceLineNo">233</span> CallMethod m = context.getCallMethods().get(javaMethodName);<a name="line.233"></a> -<span class="sourceLineNo">234</span> if (m != null)<a name="line.234"></a> -<span class="sourceLineNo">235</span> return m.getDescription(req);<a name="line.235"></a> -<span class="sourceLineNo">236</span> return "";<a name="line.236"></a> -<span class="sourceLineNo">237</span> }<a name="line.237"></a> -<span class="sourceLineNo">238</span><a name="line.238"></a> -<span class="sourceLineNo">239</span> /**<a name="line.239"></a> -<span class="sourceLineNo">240</span> * Returns the localized title of this REST resource.<a name="line.240"></a> -<span class="sourceLineNo">241</span> *<a name="line.241"></a> -<span class="sourceLineNo">242</span> * <p><a name="line.242"></a> -<span class="sourceLineNo">243</span> * Subclasses can override this method to provide their own title.<a name="line.243"></a> -<span class="sourceLineNo">244</span> *<a name="line.244"></a> -<span class="sourceLineNo">245</span> * <p><a name="line.245"></a> -<span class="sourceLineNo">246</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.246"></a> -<span class="sourceLineNo">247</span> * <ol><a name="line.247"></a> -<span class="sourceLineNo">248</span> * <li>{@link RestResource#title() @RestResourcel.title()} annotation on this class, and then any parent classes.<a name="line.248"></a> -<span class="sourceLineNo">249</span> * <li><ck>[ClassName].title</ck> property in resource bundle identified by<a name="line.249"></a> -<span class="sourceLineNo">250</span> * {@link RestResource#messages() @ResourceBundle.messages()} annotation for this class, then any parent<a name="line.250"></a> -<span class="sourceLineNo">251</span> * classes.<a name="line.251"></a> -<span class="sourceLineNo">252</span> * <li><ck>title</ck> in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}<a name="line.252"></a> -<span class="sourceLineNo">253</span> * annotation for this class, then any parent classes.<a name="line.253"></a> -<span class="sourceLineNo">254</span> * <li><ck>/info/title</ck> entry in swagger file.<a name="line.254"></a> -<span class="sourceLineNo">255</span> * </ol><a name="line.255"></a> -<span class="sourceLineNo">256</span> *<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @param req The current request.<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public String getTitle(RestRequest req) {<a name="line.260"></a> -<span class="sourceLineNo">261</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.261"></a> -<span class="sourceLineNo">262</span> if (this.title != null)<a name="line.262"></a> -<span class="sourceLineNo">263</span> return vr.resolve(this.title);<a name="line.263"></a> -<span class="sourceLineNo">264</span> String title = context.getMessages().findFirstString(req.getLocale(), "title");<a name="line.264"></a> -<span class="sourceLineNo">265</span> if (title != null)<a name="line.265"></a> -<span class="sourceLineNo">266</span> return vr.resolve(title);<a name="line.266"></a> -<span class="sourceLineNo">267</span> Swagger s = req.getSwaggerFromFile();<a name="line.267"></a> -<span class="sourceLineNo">268</span> if (s != null && s.getInfo() != null)<a name="line.268"></a> -<span class="sourceLineNo">269</span> return s.getInfo().getTitle();<a name="line.269"></a> -<span class="sourceLineNo">270</span> return null;<a name="line.270"></a> -<span class="sourceLineNo">271</span> }<a name="line.271"></a> -<span class="sourceLineNo">272</span><a name="line.272"></a> -<span class="sourceLineNo">273</span> /**<a name="line.273"></a> -<span class="sourceLineNo">274</span> * Returns the localized description of this REST resource.<a name="line.274"></a> -<span class="sourceLineNo">275</span> *<a name="line.275"></a> -<span class="sourceLineNo">276</span> * <p><a name="line.276"></a> -<span class="sourceLineNo">277</span> * Subclasses can override this method to provide their own description.<a name="line.277"></a> -<span class="sourceLineNo">278</span> *<a name="line.278"></a> -<span class="sourceLineNo">279</span> * <p><a name="line.279"></a> -<span class="sourceLineNo">280</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.280"></a> -<span class="sourceLineNo">281</span> * <ol><a name="line.281"></a> -<span class="sourceLineNo">282</span> * <li>{@link RestResource#description() @RestResource.description()} annotation on this class, and then any<a name="line.282"></a> -<span class="sourceLineNo">283</span> * parent classes.<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <li><ck>[ClassName].description</ck> property in resource bundle identified by<a name="line.284"></a> -<span class="sourceLineNo">285</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.285"></a> -<span class="sourceLineNo">286</span> * <li><ck>description</ck> property in resource bundle identified by<a name="line.286"></a> -<span class="sourceLineNo">287</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.287"></a> -<span class="sourceLineNo">288</span> * <li><ck>/info/description</ck> entry in swagger file.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * </ol><a name="line.289"></a> -<span class="sourceLineNo">290</span> *<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @param req The current request.<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.<a name="line.292"></a> -<span class="sourceLineNo">293</span> */<a name="line.293"></a> -<span class="sourceLineNo">294</span> public String getDescription(RestRequest req) {<a name="line.294"></a> -<span class="sourceLineNo">295</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.295"></a> -<span class="sourceLineNo">296</span> if (this.description != null)<a name="line.296"></a> -<span class="sourceLineNo">297</span> return vr.resolve(this.description);<a name="line.297"></a> -<span class="sourceLineNo">298</span> String description = context.getMessages().findFirstString(req.getLocale(), "description");<a name="line.298"></a> -<span class="sourceLineNo">299</span> if (description != null)<a name="line.299"></a> -<span class="sourceLineNo">300</span> return vr.resolve(description);<a name="line.300"></a> -<span class="sourceLineNo">301</span> Swagger s = req.getSwaggerFromFile();<a name="line.301"></a> -<span class="sourceLineNo">302</span> if (s != null && s.getInfo() != null)<a name="line.302"></a> -<span class="sourceLineNo">303</span> return s.getInfo().getDescription();<a name="line.303"></a> -<span class="sourceLineNo">304</span> return null;<a name="line.304"></a> -<span class="sourceLineNo">305</span> }<a name="line.305"></a> -<span class="sourceLineNo">306</span><a name="line.306"></a> -<span class="sourceLineNo">307</span> /**<a name="line.307"></a> -<span class="sourceLineNo">308</span> * Returns the localized contact information of this REST resource.<a name="line.308"></a> -<span class="sourceLineNo">309</span> *<a name="line.309"></a> -<span class="sourceLineNo">310</span> * <p><a name="line.310"></a> -<span class="sourceLineNo">311</span> * Subclasses can override this method to provide their own contact information.<a name="line.311"></a> -<span class="sourceLineNo">312</span> *<a name="line.312"></a> -<span class="sourceLineNo">313</span> * <p><a name="line.313"></a> -<span class="sourceLineNo">314</span> * The default implementation returns the contact information from the following locations (whichever matches first):<a name="line.314"></a> -<span class="sourceLineNo">315</span> * <ol><a name="line.315"></a> -<span class="sourceLineNo">316</span> * <li>{@link ResourceSwagger#contact() @ResourceSwagger.contact()} annotation on this class, and then any parent<a name="line.316"></a> -<span class="sourceLineNo">317</span> * classes.<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <li><ck>[ClassName].contact</ck> property in resource bundle identified by<a name="line.318"></a> -<span class="sourceLineNo">319</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.319"></a> -<span class="sourceLineNo">320</span> * <li><ck>contact</ck> property in resource bundle identified by<a name="line.320"></a> -<span class="sourceLineNo">321</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.321"></a> -<span class="sourceLineNo">322</span> * <li><ck>/info/contact</ck> entry in swagger file.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * </ol><a name="line.323"></a> -<span class="sourceLineNo">324</span> *<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @param req The current request.<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @return<a name="line.326"></a> -<span class="sourceLineNo">327</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.327"></a> +<span class="sourceLineNo">048</span> siteName,<a name="line.48"></a> +<span class="sourceLineNo">049</span> title,<a name="line.49"></a> +<span class="sourceLineNo">050</span> description,<a name="line.50"></a> +<span class="sourceLineNo">051</span> termsOfService,<a name="line.51"></a> +<span class="sourceLineNo">052</span> contact,<a name="line.52"></a> +<span class="sourceLineNo">053</span> license,<a name="line.53"></a> +<span class="sourceLineNo">054</span> version,<a name="line.54"></a> +<span class="sourceLineNo">055</span> tags,<a name="line.55"></a> +<span class="sourceLineNo">056</span> externalDocs;<a name="line.56"></a> +<span class="sourceLineNo">057</span> private final ConcurrentHashMap<Locale,Swagger> swaggers = new ConcurrentHashMap<Locale,Swagger>();<a name="line.57"></a> +<span class="sourceLineNo">058</span><a name="line.58"></a> +<span class="sourceLineNo">059</span> /**<a name="line.59"></a> +<span class="sourceLineNo">060</span> * Constructor.<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param context The resource context.<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> public RestInfoProvider(RestContext context) {<a name="line.64"></a> +<span class="sourceLineNo">065</span> this.context = context;<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> Builder b = new Builder(context);<a name="line.67"></a> +<span class="sourceLineNo">068</span> this.siteName = b.siteName;<a name="line.68"></a> +<span class="sourceLineNo">069</span> this.title = b.title;<a name="line.69"></a> +<span class="sourceLineNo">070</span> this.description = b.description;<a name="line.70"></a> +<span class="sourceLineNo">071</span> this.termsOfService = b.termsOfService;<a name="line.71"></a> +<span class="sourceLineNo">072</span> this.contact = b.contact;<a name="line.72"></a> +<span class="sourceLineNo">073</span> this.license = b.license;<a name="line.73"></a> +<span class="sourceLineNo">074</span> this.version = b.version;<a name="line.74"></a> +<span class="sourceLineNo">075</span> this.tags = b.tags;<a name="line.75"></a> +<span class="sourceLineNo">076</span> this.externalDocs = b.externalDocs;<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span> private static class Builder {<a name="line.79"></a> +<span class="sourceLineNo">080</span> private String<a name="line.80"></a> +<span class="sourceLineNo">081</span> siteName,<a name="line.81"></a> +<span class="sourceLineNo">082</span> title,<a name="line.82"></a> +<span class="sourceLineNo">083</span> description,<a name="line.83"></a> +<span class="sourceLineNo">084</span> termsOfService,<a name="line.84"></a> +<span class="sourceLineNo">085</span> contact,<a name="line.85"></a> +<span class="sourceLineNo">086</span> license,<a name="line.86"></a> +<span class="sourceLineNo">087</span> version,<a name="line.87"></a> +<span class="sourceLineNo">088</span> tags,<a name="line.88"></a> +<span class="sourceLineNo">089</span> externalDocs;<a name="line.89"></a> +<span class="sourceLineNo">090</span><a name="line.90"></a> +<span class="sourceLineNo">091</span> Builder(RestContext context) {<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> LinkedHashMap<Class<?>,RestResource> restResourceAnnotationsParentFirst = findAnnotationsMapParentFirst(RestResource.class, context.getResource().getClass());<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> for (RestResource r : restResourceAnnotationsParentFirst.values()) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> if (! r.siteName().isEmpty())<a name="line.96"></a> +<span class="sourceLineNo">097</span> siteName = r.siteName();<a name="line.97"></a> +<span class="sourceLineNo">098</span> if (! r.title().isEmpty())<a name="line.98"></a> +<span class="sourceLineNo">099</span> title = r.title();<a name="line.99"></a> +<span class="sourceLineNo">100</span> if (! r.description().isEmpty())<a name="line.100"></a> +<span class="sourceLineNo">101</span> description = r.description();<a name="line.101"></a> +<span class="sourceLineNo">102</span> ResourceSwagger sr = r.swagger();<a name="line.102"></a> +<span class="sourceLineNo">103</span> if (! sr.termsOfService().isEmpty())<a name="line.103"></a> +<span class="sourceLineNo">104</span> termsOfService = sr.termsOfService();<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (! sr.contact().isEmpty())<a name="line.105"></a> +<span class="sourceLineNo">106</span> contact = sr.contact();<a name="line.106"></a> +<span class="sourceLineNo">107</span> if (! sr.license().isEmpty())<a name="line.107"></a> +<span class="sourceLineNo">108</span> license = sr.license();<a name="line.108"></a> +<span class="sourceLineNo">109</span> if (! sr.version().isEmpty())<a name="line.109"></a> +<span class="sourceLineNo">110</span> version = sr.version();<a name="line.110"></a> +<span class="sourceLineNo">111</span> if (! sr.tags().isEmpty())<a name="line.111"></a> +<span class="sourceLineNo">112</span> tags = sr.tags();<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (! sr.externalDocs().isEmpty())<a name="line.113"></a> +<span class="sourceLineNo">114</span> externalDocs = sr.externalDocs();<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span><a name="line.118"></a> +<span class="sourceLineNo">119</span> /**<a name="line.119"></a> +<span class="sourceLineNo">120</span> * Returns the localized swagger for this REST resource.<a name="line.120"></a> +<span class="sourceLineNo">121</span> *<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @param req The incoming HTTP request.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @return A new Swagger instance.<a name="line.123"></a> +<span class="sourceLineNo">124</span> * @throws RestException<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> protected Swagger getSwagger(RestRequest req) throws RestException {<a name="line.126"></a> +<span class="sourceLineNo">127</span> try {<a name="line.127"></a> +<span class="sourceLineNo">128</span> // If a file is defined, use that.<a name="line.128"></a> +<span class="sourceLineNo">129</span> Swagger s = req.getSwaggerFromFile();<a name="line.129"></a> +<span class="sourceLineNo">130</span> if (s != null)<a name="line.130"></a> +<span class="sourceLineNo">131</span> return s;<a name="line.131"></a> +<span class="sourceLineNo">132</span><a name="line.132"></a> +<span class="sourceLineNo">133</span> s = swagger(<a name="line.133"></a> +<span class="sourceLineNo">134</span> info(getTitle(req), getVersion(req))<a name="line.134"></a> +<span class="sourceLineNo">135</span> .contact(getContact(req))<a name="line.135"></a> +<span class="sourceLineNo">136</span> .license(getLicense(req))<a name="line.136"></a> +<span class="sourceLineNo">137</span> .description(getDescription(req))<a name="line.137"></a> +<span class="sourceLineNo">138</span> .termsOfService(getTermsOfService(req))<a name="line.138"></a> +<span class="sourceLineNo">139</span> )<a name="line.139"></a> +<span class="sourceLineNo">140</span> .consumes(context.getSupportedAcceptTypes())<a name="line.140"></a> +<span class="sourceLineNo">141</span> .produces(context.getSupportedContentTypes())<a name="line.141"></a> +<span class="sourceLineNo">142</span> .tags(getTags(req))<a name="line.142"></a> +<span class="sourceLineNo">143</span> .externalDocs(getExternalDocs(req));<a name="line.143"></a> +<span class="sourceLineNo">144</span><a name="line.144"></a> +<span class="sourceLineNo">145</span> for (CallMethod sm : context.getCallMethods().values()) {<a name="line.145"></a> +<span class="sourceLineNo">146</span> if (sm.isRequestAllowed(req)) {<a name="line.146"></a> +<span class="sourceLineNo">147</span> Operation o = sm.getSwaggerOperation(req);<a name="line.147"></a> +<span class="sourceLineNo">148</span> s.path(<a name="line.148"></a> +<span class="sourceLineNo">149</span> sm.getPathPattern(),<a name="line.149"></a> +<span class="sourceLineNo">150</span> sm.getHttpMethod().toLowerCase(),<a name="line.150"></a> +<span class="sourceLineNo">151</span> o<a name="line.151"></a> +<span class="sourceLineNo">152</span> );<a name="line.152"></a> +<span class="sourceLineNo">153</span> }<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span> return s;<a name="line.155"></a> +<span class="sourceLineNo">156</span> } catch (RestException e) {<a name="line.156"></a> +<span class="sourceLineNo">157</span> throw e;<a name="line.157"></a> +<span class="sourceLineNo">158</span> } catch (Exception e) {<a name="line.158"></a> +<span class="sourceLineNo">159</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<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><a name="line.162"></a> +<span class="sourceLineNo">163</span> /**<a name="line.163"></a> +<span class="sourceLineNo">164</span> * Returns the localized Swagger from the file system.<a name="line.164"></a> +<span class="sourceLineNo">165</span> *<a name="line.165"></a> +<span class="sourceLineNo">166</span> * <p><a name="line.166"></a> +<span class="sourceLineNo">167</span> * Looks for a file called <js>"{ServletClass}_{locale}.json"</js> in the same package as this servlet and returns<a name="line.167"></a> +<span class="sourceLineNo">168</span> * it as a parsed {@link Swagger} object.<a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * <p><a name="line.170"></a> +<span class="sourceLineNo">171</span> * Returned objects are cached for later quick-lookup.<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param locale The locale of the swagger.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @return The parsed swagger object, or <jk>null</jk> if the swagger file could not be found.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @throws RestException<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> protected Swagger getSwaggerFromFile(Locale locale) throws RestException {<a name="line.177"></a> +<span class="sourceLineNo">178</span> Swagger s = swaggers.get(locale);<a name="line.178"></a> +<span class="sourceLineNo">179</span> if (s == null) {<a name="line.179"></a> +<span class="sourceLineNo">180</span> try {<a name="line.180"></a> +<span class="sourceLineNo">181</span> s = context.getResource(Swagger.class, MediaType.JSON, getClass().getSimpleName() + ".json", locale);<a name="line.181"></a> +<span class="sourceLineNo">182</span> swaggers.putIfAbsent(locale, s == null ? Swagger.NULL : s);<a name="line.182"></a> +<span class="sourceLineNo">183</span> } catch (Exception e) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span> }<a name="line.186"></a> +<span class="sourceLineNo">187</span> return s == Swagger.NULL ? null : s;<a name="line.187"></a> +<span class="sourceLineNo">188</span> }<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> /**<a name="line.190"></a> +<span class="sourceLineNo">191</span> * Returns the localized summary of the specified java method on this servlet.<a name="line.191"></a> +<span class="sourceLineNo">192</span> *<a name="line.192"></a> +<span class="sourceLineNo">193</span> * <p><a name="line.193"></a> +<span class="sourceLineNo">194</span> * Subclasses can override this method to provide their own summary.<a name="line.194"></a> +<span class="sourceLineNo">195</span> *<a name="line.195"></a> +<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> +<span class="sourceLineNo">197</span> * The default implementation returns the summary from the following locations (whichever matches first):<a name="line.197"></a> +<span class="sourceLineNo">198</span> * <ol><a name="line.198"></a> +<span class="sourceLineNo">199</span> * <li>{@link RestMethod#summary() @RestMethod.summary()} annotation on the method.<a name="line.199"></a> +<span class="sourceLineNo">200</span> * <li><ck>[ClassName].[javaMethodName].summary</ck> property in resource bundle identified by<a name="line.200"></a> +<span class="sourceLineNo">201</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <li><ck>[javaMethodName].summary</ck> property in resource bundle identified by<a name="line.202"></a> +<span class="sourceLineNo">203</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.203"></a> +<span class="sourceLineNo">204</span> * </ol><a name="line.204"></a> +<span class="sourceLineNo">205</span> *<a name="line.205"></a> +<span class="sourceLineNo">206</span> * @param javaMethodName The name of the Java method whose description we're retrieving.<a name="line.206"></a> +<span class="sourceLineNo">207</span> * @param req The current request.<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @return The localized summary of the method, or a blank string if no summary was found.<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> public String getMethodSummary(String javaMethodName, RestRequest req) {<a name="line.210"></a> +<span class="sourceLineNo">211</span> CallMethod m = context.getCallMethods().get(javaMethodName);<a name="line.211"></a> +<span class="sourceLineNo">212</span> if (m != null)<a name="line.212"></a> +<span class="sourceLineNo">213</span> return m.getSummary(req);<a name="line.213"></a> +<span class="sourceLineNo">214</span> return "";<a name="line.214"></a> +<span class="sourceLineNo">215</span> }<a name="line.215"></a> +<span class="sourceLineNo">216</span><a name="line.216"></a> +<span class="sourceLineNo">217</span> /**<a name="line.217"></a> +<span class="sourceLineNo">218</span> * Returns the localized description of the specified java method on this servlet.<a name="line.218"></a> +<span class="sourceLineNo">219</span> *<a name="line.219"></a> +<span class="sourceLineNo">220</span> * <p><a name="line.220"></a> +<span class="sourceLineNo">221</span> * Subclasses can override this method to provide their own description.<a name="line.221"></a> +<span class="sourceLineNo">222</span> *<a name="line.222"></a> +<span class="sourceLineNo">223</span> * <p><a name="line.223"></a> +<span class="sourceLineNo">224</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.224"></a> +<span class="sourceLineNo">225</span> * <ol><a name="line.225"></a> +<span class="sourceLineNo">226</span> * <li>{@link RestMethod#description() @RestMethod.description()} annotation on the method.<a name="line.226"></a> +<span class="sourceLineNo">227</span> * <li><ck>[ClassName].[javaMethodName].description</ck> property in resource bundle identified by<a name="line.227"></a> +<span class="sourceLineNo">228</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * <li><ck>[javaMethodName].description</ck> property in resource bundle identified by<a name="line.229"></a> +<span class="sourceLineNo">230</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * </ol><a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param javaMethodName The name of the Java method whose description we're retrieving.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @param req The current request.<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @return The localized description of the method, or a blank string if no description was found.<a name="line.235"></a> +<span class="sourceLineNo">236</span> */<a name="line.236"></a> +<span class="sourceLineNo">237</span> protected String getMethodDescription(String javaMethodName, RestRequest req) {<a name="line.237"></a> +<span class="sourceLineNo">238</span> CallMethod m = context.getCallMethods().get(javaMethodName);<a name="line.238"></a> +<span class="sourceLineNo">239</span> if (m != null)<a name="line.239"></a> +<span class="sourceLineNo">240</span> return m.getDescription(req);<a name="line.240"></a> +<span class="sourceLineNo">241</span> return "";<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> /**<a name="line.244"></a> +<span class="sourceLineNo">245</span> * Returns the localized site name of this REST resource.<a name="line.245"></a> +<span class="sourceLineNo">246</span> *<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <p><a name="line.247"></a> +<span class="sourceLineNo">248</span> * Subclasses can override this method to provide their own site name.<a name="line.248"></a> +<span class="sourceLineNo">249</span> *<a name="line.249"></a> +<span class="sourceLineNo">250</span> * <p><a name="line.250"></a> +<span class="sourceLineNo">251</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.251"></a> +<span class="sourceLineNo">252</span> * <ol><a name="line.252"></a> +<span class="sourceLineNo">253</span> * <li>{@link RestResource#siteName() @RestResource.siteName()} annotation on this class, and then any parent classes.<a name="line.253"></a> +<span class="sourceLineNo">254</span> * <li><ck>[ClassName].siteName</ck> property in resource bundle identified by<a name="line.254"></a> +<span class="sourceLineNo">255</span> * {@link RestResource#messages() @ResourceBundle.messages()} annotation for this class, then any parent<a name="line.255"></a> +<span class="sourceLineNo">256</span> * classes.<a name="line.256"></a> +<span class="sourceLineNo">257</span> * <li><ck>siteName</ck> in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}<a name="line.257"></a> +<span class="sourceLineNo">258</span> * annotation for this class, then any parent classes.<a name="line.258"></a> +<span class="sourceLineNo">259</span> * </ol><a name="line.259"></a> +<span class="sourceLineNo">260</span> *<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @param req The current request.<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.<a name="line.262"></a> +<span class="sourceLineNo">263</span> */<a name="line.263"></a> +<span class="sourceLineNo">264</span> public String getSiteName(RestRequest req) {<a name="line.264"></a> +<span class="sourceLineNo">265</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.265"></a> +<span class="sourceLineNo">266</span> if (this.siteName != null)<a name="line.266"></a> +<span class="sourceLineNo">267</span> return vr.resolve(this.siteName);<a name="line.267"></a> +<span class="sourceLineNo">268</span> String siteName = context.getMessages().findFirstString(req.getLocale(), "siteName");<a name="line.268"></a> +<span class="sourceLineNo">269</span> if (siteName != null)<a name="line.269"></a> +<span class="sourceLineNo">270</span> return vr.resolve(siteName);<a name="line.270"></a> +<span class="sourceLineNo">271</span> return null;<a name="line.271"></a> +<span class="sourceLineNo">272</span> }<a name="line.272"></a> +<span class="sourceLineNo">273</span><a name="line.273"></a> +<span class="sourceLineNo">274</span> /**<a name="line.274"></a> +<span class="sourceLineNo">275</span> * Returns the localized title of this REST resource.<a name="line.275"></a> +<span class="sourceLineNo">276</span> *<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <p><a name="line.277"></a> +<span class="sourceLineNo">278</span> * Subclasses can override this method to provide their own title.<a name="line.278"></a> +<span class="sourceLineNo">279</span> *<a name="line.279"></a> +<span class="sourceLineNo">280</span> * <p><a name="line.280"></a> +<span class="sourceLineNo">281</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.281"></a> +<span class="sourceLineNo">282</span> * <ol><a name="line.282"></a> +<span class="sourceLineNo">283</span> * <li>{@link RestResource#title() @RestResource.title()} annotation on this class, and then any parent classes.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * <li><ck>[ClassName].title</ck> property in resource bundle identified by<a name="line.284"></a> +<span class="sourceLineNo">285</span> * {@link RestResource#messages() @ResourceBundle.messages()} annotation for this class, then any parent<a name="line.285"></a> +<span class="sourceLineNo">286</span> * classes.<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <li><ck>title</ck> in resource bundle identified by {@link RestResource#messages() @RestResource.messages()}<a name="line.287"></a> +<span class="sourceLineNo">288</span> * annotation for this class, then any parent classes.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * <li><ck>/info/title</ck> entry in swagger file.<a name="line.289"></a> +<span class="sourceLineNo">290</span> * </ol><a name="line.290"></a> +<span class="sourceLineNo">291</span> *<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @param req The current request.<a name="line.292"></a> +<span class="sourceLineNo">293</span> * @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.<a name="line.293"></a> +<span class="sourceLineNo">294</span> */<a name="line.294"></a> +<span class="sourceLineNo">295</span> public String getTitle(RestRequest req) {<a name="line.295"></a> +<span class="sourceLineNo">296</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.296"></a> +<span class="sourceLineNo">297</span> if (this.title != null)<a name="line.297"></a> +<span class="sourceLineNo">298</span> return vr.resolve(this.title);<a name="line.298"></a> +<span class="sourceLineNo">299</span> String title = context.getMessages().findFirstString(req.getLocale(), "title");<a name="line.299"></a> +<span class="sourceLineNo">300</span> if (title != null)<a name="line.300"></a> +<span class="sourceLineNo">301</span> return vr.resolve(title);<a name="line.301"></a> +<span class="sourceLineNo">302</span> Swagger s = req.getSwaggerFromFile();<a name="line.302"></a> +<span class="sourceLineNo">303</span> if (s != null && s.getInfo() != null)<a name="line.303"></a> +<span class="sourceLineNo">304</span> return s.getInfo().getTitle();<a name="line.304"></a> +<span class="sourceLineNo">305</span> return null;<a name="line.305"></a> +<span class="sourceLineNo">306</span> }<a name="line.306"></a> +<span class="sourceLineNo">307</span><a name="line.307"></a> +<span class="sourceLineNo">308</span> /**<a name="line.308"></a> +<span class="sourceLineNo">309</span> * Returns the localized description of this REST resource.<a name="line.309"></a> +<span class="sourceLineNo">310</span> *<a name="line.310"></a> +<span class="sourceLineNo">311</span> * <p><a name="line.311"></a> +<span class="sourceLineNo">312</span> * Subclasses can override this method to provide their own description.<a name="line.312"></a> +<span class="sourceLineNo">313</span> *<a name="line.313"></a> +<span class="sourceLineNo">314</span> * <p><a name="line.314"></a> +<span class="sourceLineNo">315</span> * The default implementation returns the description from the following locations (whichever matches first):<a name="line.315"></a> +<span class="sourceLineNo">316</span> * <ol><a name="line.316"></a> +<span class="sourceLineNo">317</span> * <li>{@link RestResource#description() @RestResource.description()} annotation on this class, and then any<a name="line.317"></a> +<span class="sourceLineNo">318</span> * parent classes.<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <li><ck>[ClassName].description</ck> property in resource bundle identified by<a name="line.319"></a> +<span class="sourceLineNo">320</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.320"></a> +<span class="sourceLineNo">321</span> * <li><ck>description</ck> property in resource bundle identified by<a name="line.321"></a> +<span class="sourceLineNo">322</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.322"></a> +<span class="sourceLineNo">323</span> * <li><ck>/info/description</ck> entry in swagger file.<a name="line.323"></a> +<span class="sourceLineNo">324</span> * </ol><a name="line.324"></a> +<span class="sourceLineNo">325</span> *<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @param req The current request.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * @return The localized description of this REST resource, or <jk>null</jk> if no resource description was found.<a name="line.327"></a> <span class="sourceLineNo">328</span> */<a name="line.328"></a> -<span class="sourceLineNo">329</span> public Contact getContact(RestRequest req) {<a name="line.329"></a> +<span class="sourceLineNo">329</span> public String getDescription(RestRequest req) {<a name="line.329"></a> <span class="sourceLineNo">330</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.330"></a> -<span class="sourceLineNo">331</span> JsonParser jp = JsonParser.DEFAULT;<a name="line.331"></a> -<span class="sourceLineNo">332</span> try {<a name="line.332"></a> -<span class="sourceLineNo">333</span> if (this.contact != null)<a name="line.333"></a> -<span class="sourceLineNo">334</span> return jp.parse(vr.resolve(this.contact), Contact.class);<a name="line.334"></a> -<span class="sourceLineNo">335</span> String contact = context.getMessages().findFirstString(req.getLocale(), "contact");<a name="line.335"></a> -<span class="sourceLineNo">336</span> if (contact != null)<a name="line.336"></a> -<span class="sourceLineNo">337</span> return jp.parse(vr.resolve(contact), Contact.class);<a name="line.337"></a> -<span class="sourceLineNo">338</span> Swagger s = req.getSwaggerFromFile();<a name="line.338"></a> -<span class="sourceLineNo">339</span> if (s != null && s.getInfo() != null)<a name="line.339"></a> -<span class="sourceLineNo">340</span> return s.getInfo().getContact();<a name="line.340"></a> -<span class="sourceLineNo">341</span> return null;<a name="line.341"></a> -<span class="sourceLineNo">342</span> } catch (ParseException e) {<a name="line.342"></a> -<span class="sourceLineNo">343</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.343"></a> -<span class="sourceLineNo">344</span> }<a name="line.344"></a> -<span class="sourceLineNo">345</span> }<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * Returns the localized license information of this REST resource.<a name="line.348"></a> -<span class="sourceLineNo">349</span> *<a name="line.349"></a> -<span class="sourceLineNo">350</span> * <p><a name="line.350"></a> -<span class="sourceLineNo">351</span> * Subclasses can override this method to provide their own license information.<a name="line.351"></a> -<span class="sourceLineNo">352</span> *<a name="line.352"></a> -<span class="sourceLineNo">353</span> * <p><a name="line.353"></a> -<span class="sourceLineNo">354</span> * The default implementation returns the license information from the following locations (whichever matches first):<a name="line.354"></a> -<span class="sourceLineNo">355</span> * <ol><a name="line.355"></a> -<span class="sourceLineNo">356</span> * <li>{@link ResourceSwagger#license() @ResourceSwagger.license()} annotation on this class, and then any parent<a name="line.356"></a> -<span class="sourceLineNo">357</span> * classes.<a name="line.357"></a> -<span class="sourceLineNo">358</span> * <li><ck>[ClassName].license</ck> property in resource bundle identified by<a name="line.358"></a> -<span class="sourceLineNo">359</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.359"></a> -<span class="sourceLineNo">360</span> * <li><ck>license</ck> property in resource bundle identified by<a name="line.360"></a> -<span class="sourceLineNo">361</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.361"></a> -<span class="sourceLineNo">362</span> * <li><ck>/info/license</ck> entry in swagger file.<a name="line.362"></a> -<span class="sourceLineNo">363</span> * </ol><a name="line.363"></a> -<span class="sourceLineNo">364</span> *<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @param req The current request.<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @return<a name="line.366"></a> -<span class="sourceLineNo">367</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.367"></a> -<span class="sourceLineNo">368</span> */<a name="line.368"></a> -<span class="sourceLineNo">369</span> public License getLicense(RestRequest req) {<a name="line.369"></a> -<span class="sourceLineNo">370</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.370"></a> -<span class="sourceLineNo">371</span> JsonParser jp = JsonParser.DEFAULT;<a name="line.371"></a> -<span class="sourceLineNo">372</span> try {<a name="line.372"></a> -<span class="sourceLineNo">373</span> if (this.license != null)<a name="line.373"></a> -<span class="sourceLineNo">374</span> return jp.parse(vr.resolve(this.license), License.class);<a name="line.374"></a> -<span class="sourceLineNo">375</span> String license = context.getMessages().findFirstString(req.getLocale(), "license");<a name="line.375"></a> -<span class="sourceLineNo">376</span> if (license != null)<a name="line.376"></a> -<span class="sourceLineNo">377</span> return jp.parse(vr.resolve(license), License.class);<a name="line.377"></a> -<span class="sourceLineNo">378</span> Swagger s = req.getSwaggerFromFile();<a name="line.378"></a> -<span class="sourceLineNo">379</span> if (s != null && s.getInfo() != null)<a name="line.379"></a> -<span class="sourceLineNo">380</span> return s.getInfo().getLicense();<a name="line.380"></a> -<span class="sourceLineNo">381</span> return null;<a name="line.381"></a> -<span class="sourceLineNo">382</span> } catch (ParseException e) {<a name="line.382"></a> -<span class="sourceLineNo">383</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.383"></a> -<span class="sourceLineNo">384</span> }<a name="line.384"></a> -<span class="sourceLineNo">385</span> }<a name="line.385"></a> -<span class="sourceLineNo">386</span><a name="line.386"></a> -<span class="sourceLineNo">387</span> /**<a name="line.387"></a> -<span class="sourceLineNo">388</span> * Returns the terms-of-service information of this REST resource.<a name="line.388"></a> -<span class="sourceLineNo">389</span> *<a name="line.389"></a> -<span class="sourceLineNo">390</span> * <p><a name="line.390"></a> -<span class="sourceLineNo">391</span> * Subclasses can override this method to provide their own terms-of-service information.<a name="line.391"></a> -<span class="sourceLineNo">392</span> *<a name="line.392"></a> -<span class="sourceLineNo">393</span> * <p><a name="line.393"></a> -<span class="sourceLineNo">394</span> * The default implementation returns the terms-of-service information from the following locations (whichever<a name="line.394"></a> -<span class="sourceLineNo">395</span> * matches first):<a name="line.395"></a> -<span class="sourceLineNo">396</span> * <ol><a name="line.396"></a> -<span class="sourceLineNo">397</span> * <li>{@link ResourceSwagger#termsOfService() @ResourceSwagger.termsOfService()} annotation on this class, and<a name="line.397"></a> -<span class="sourceLineNo">398</span> * then any parent classes.<a name="line.398"></a> -<span class="sourceLineNo">399</span> * <li><ck>[ClassName].termsOfService</ck> property in resource bundle identified by<a name="line.399"></a> -<span class="sourceLineNo">400</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.400"></a> -<span class="sourceLineNo">401</span> * <li><ck>termsOfService</ck> property in resource bundle identified by<a name="line.401"></a> -<span class="sourceLineNo">402</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.402"></a> -<span class="sourceLineNo">403</span> * <li><ck>/info/termsOfService</ck> entry in swagger file.<a name="line.403"></a> -<span class="sourceLineNo">404</span> * </ol><a name="line.404"></a> -<span class="sourceLineNo">405</span> *<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @param req The current request.<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @return<a name="line.407"></a> -<span class="sourceLineNo">408</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.408"></a> -<span class="sourceLineNo">409</span> */<a name="line.409"></a> -<span class="sourceLineNo">410</span> public String getTermsOfService(RestRequest req) {<a name="line.410"></a> -<span class="sourceLineNo">411</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.411"></a> -<span class="sourceLineNo">412</span> if (this.termsOfService != null)<a name="line.412"></a> -<span class="sourceLineNo">413</span> return vr.resolve(this.termsOfService);<a name="line.413"></a> -<span class="sourceLineNo">414</span> String termsOfService = context.getMessages().findFirstString(req.getLocale(), "termsOfService");<a name="line.414"></a> -<span class="sourceLineNo">415</span> if (termsOfService != null)<a name="line.415"></a> -<span class="sourceLineNo">416</span> return vr.resolve(termsOfService);<a name="line.416"></a> -<span class="sourceLineNo">417</span> Swagger s = req.getSwaggerFromFile();<a name="line.417"></a> -<span class="sourceLineNo">418</span> if (s != null && s.getInfo() != null)<a name="line.418"></a> -<span class="sourceLineNo">419</span> return s.getInfo().getTermsOfService();<a name="line.419"></a> -<span class="sourceLineNo">420</span> return null;<a name="line.420"></a> -<span class="sourceLineNo">421</span> }<a name="line.421"></a> -<span class="sourceLineNo">422</span><a name="line.422"></a> -<span class="sourceLineNo">423</span> /**<a name="line.423"></a> -<span class="sourceLineNo">424</span> * Returns the version information of this REST resource.<a name="line.424"></a> -<span class="sourceLineNo">425</span> *<a name="line.425"></a> -<span class="sourceLineNo">426</span> * <p><a name="line.426"></a> -<span class="sourceLineNo">427</span> * Subclasses can override this method to provide their own version information.<a name="line.427"></a> -<span class="sourceLineNo">428</span> *<a name="line.428"></a> -<span class="sourceLineNo">429</span> * <p><a name="line.429"></a> -<span class="sourceLineNo">430</span> * The default implementation returns the version information from the following locations (whichever matches first):<a name="line.430"></a> +<span class="sourceLineNo">331</span> if (this.description != null)<a name="line.331"></a> +<span class="sourceLineNo">332</span> return vr.resolve(this.description);<a name="line.332"></a> +<span class="sourceLineNo">333</span> String description = context.getMessages().findFirstString(req.getLocale(), "description");<a name="line.333"></a> +<span class="sourceLineNo">334</span> if (description != null)<a name="line.334"></a> +<span class="sourceLineNo">335</span> return vr.resolve(description);<a name="line.335"></a> +<span class="sourceLineNo">336</span> Swagger s = req.getSwaggerFromFile();<a name="line.336"></a> +<span class="sourceLineNo">337</span> if (s != null && s.getInfo() != null)<a name="line.337"></a> +<span class="sourceLineNo">338</span> return s.getInfo().getDescription();<a name="line.338"></a> +<span class="sourceLineNo">339</span> return null;<a name="line.339"></a> +<span class="sourceLineNo">340</span> }<a name="line.340"></a> +<span class="sourceLineNo">341</span><a name="line.341"></a> +<span class="sourceLineNo">342</span> /**<a name="line.342"></a> +<span class="sourceLineNo">343</span> * Returns the localized contact information of this REST resource.<a name="line.343"></a> +<span class="sourceLineNo">344</span> *<a name="line.344"></a> +<span class="sourceLineNo">345</span> * <p><a name="line.345"></a> +<span class="sourceLineNo">346</span> * Subclasses can override this method to provide their own contact information.<a name="line.346"></a> +<span class="sourceLineNo">347</span> *<a name="line.347"></a> +<span class="sourceLineNo">348</span> * <p><a name="line.348"></a> +<span class="sourceLineNo">349</span> * The default implementation returns the contact information from the following locations (whichever matches first):<a name="line.349"></a> +<span class="sourceLineNo">350</span> * <ol><a name="line.350"></a> +<span class="sourceLineNo">351</span> * <li>{@link ResourceSwagger#contact() @ResourceSwagger.contact()} annotation on this class, and then any parent<a name="line.351"></a> +<span class="sourceLineNo">352</span> * classes.<a name="line.352"></a> +<span class="sourceLineNo">353</span> * <li><ck>[ClassName].contact</ck> property in resource bundle identified by<a name="line.353"></a> +<span class="sourceLineNo">354</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * <li><ck>contact</ck> property in resource bundle identified by<a name="line.355"></a> +<span class="sourceLineNo">356</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.356"></a> +<span class="sourceLineNo">357</span> * <li><ck>/info/contact</ck> entry in swagger file.<a name="line.357"></a> +<span class="sourceLineNo">358</span> * </ol><a name="line.358"></a> +<span class="sourceLineNo">359</span> *<a name="line.359"></a> +<span class="sourceLineNo">360</span> * @param req The current request.<a name="line.360"></a> +<span class="sourceLineNo">361</span> * @return<a name="line.361"></a> +<span class="sourceLineNo">362</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.362"></a> +<span class="sourceLineNo">363</span> */<a name="line.363"></a> +<span class="sourceLineNo">364</span> public Contact getContact(RestRequest req) {<a name="line.364"></a> +<span class="sourceLineNo">365</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.365"></a> +<span class="sourceLineNo">366</span> JsonParser jp = JsonParser.DEFAULT;<a name="line.366"></a> +<span class="sourceLineNo">367</span> try {<a name="line.367"></a> +<span class="sourceLineNo">368</span> if (this.contact != null)<a name="line.368"></a> +<span class="sourceLineNo">369</span> return jp.parse(vr.resolve(this.contact), Contact.class);<a name="line.369"></a> +<span class="sourceLineNo">370</span> String contact = context.getMessages().findFirstString(req.getLocale(), "contact");<a name="line.370"></a> +<span class="sourceLineNo">371</span> if (contact != null)<a name="line.371"></a> +<span class="sourceLineNo">372</span> return jp.parse(vr.resolve(contact), Contact.class);<a name="line.372"></a> +<span class="sourceLineNo">373</span> Swagger s = req.getSwaggerFromFile();<a name="line.373"></a> +<span class="sourceLineNo">374</span> if (s != null && s.getInfo() != null)<a name="line.374"></a> +<span class="sourceLineNo">375</span> return s.getInfo().getContact();<a name="line.375"></a> +<span class="sourceLineNo">376</span> return null;<a name="line.376"></a> +<span class="sourceLineNo">377</span> } catch (ParseException e) {<a name="line.377"></a> +<span class="sourceLineNo">378</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.378"></a> +<span class="sourceLineNo">379</span> }<a name="line.379"></a> +<span class="sourceLineNo">380</span> }<a name="line.380"></a> +<span class="sourceLineNo">381</span><a name="line.381"></a> +<span class="sourceLineNo">382</span> /**<a name="line.382"></a> +<span class="sourceLineNo">383</span> * Returns the localized license information of this REST resource.<a name="line.383"></a> +<span class="sourceLineNo">384</span> *<a name="line.384"></a> +<span class="sourceLineNo">385</span> * <p><a name="line.385"></a> +<span class="sourceLineNo">386</span> * Subclasses can override this method to provide their own license information.<a name="line.386"></a> +<span class="sourceLineNo">387</span> *<a name="line.387"></a> +<span class="sourceLineNo">388</span> * <p><a name="line.388"></a> +<span class="sourceLineNo">389</span> * The default implementation returns the license information from the following locations (whichever matches first):<a name="line.389"></a> +<span class="sourceLineNo">390</span> * <ol><a name="line.390"></a> +<span class="sourceLineNo">391</span> * <li>{@link ResourceSwagger#license() @ResourceSwagger.license()} annotation on this class, and then any parent<a name="line.391"></a> +<span class="sourceLineNo">392</span> * classes.<a name="line.392"></a> +<span class="sourceLineNo">393</span> * <li><ck>[ClassName].license</ck> property in resource bundle identified by<a name="line.393"></a> +<span class="sourceLineNo">394</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.394"></a> +<span class="sourceLineNo">395</span> * <li><ck>license</ck> property in resource bundle identified by<a name="line.395"></a> +<span class="sourceLineNo">396</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.396"></a> +<span class="sourceLineNo">397</span> * <li><ck>/info/license</ck> entry in swagger file.<a name="line.397"></a> +<span class="sourceLineNo">398</span> * </ol><a name="line.398"></a> +<span class="sourceLineNo">399</span> *<a name="line.399"></a> +<span class="sourceLineNo">400</span> * @param req The current request.<a name="line.400"></a> +<span class="sourceLineNo">401</span> * @return<a name="line.401"></a> +<span class="sourceLineNo">402</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.402"></a> +<span class="sourceLineNo">403</span> */<a name="line.403"></a> +<span class="sourceLineNo">404</span> public License getLicense(RestRequest req) {<a name="line.404"></a> +<span class="sourceLineNo">405</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.405"></a> +<span class="sourceLineNo">406</span> JsonParser jp = JsonParser.DEFAULT;<a name="line.406"></a> +<span class="sourceLineNo">407</span> try {<a name="line.407"></a> +<span class="sourceLineNo">408</span> if (this.license != null)<a name="line.408"></a> +<span class="sourceLineNo">409</span> return jp.parse(vr.resolve(this.license), License.class);<a name="line.409"></a> +<span class="sourceLineNo">410</span> String license = context.getMessages().findFirstString(req.getLocale(), "license");<a name="line.410"></a> +<span class="sourceLineNo">411</span> if (license != null)<a name="line.411"></a> +<span class="sourceLineNo">412</span> return jp.parse(vr.resolve(license), License.class);<a name="line.412"></a> +<span class="sourceLineNo">413</span> Swagger s = req.getSwaggerFromFile();<a name="line.413"></a> +<span class="sourceLineNo">414</span> if (s != null && s.getInfo() != null)<a name="line.414"></a> +<span class="sourceLineNo">415</span> return s.getInfo().getLicense();<a name="line.415"></a> +<span class="sourceLineNo">416</span> return null;<a name="line.416"></a> +<span class="sourceLineNo">417</span> } catch (ParseException e) {<a name="line.417"></a> +<span class="sourceLineNo">418</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.418"></a> +<span class="sourceLineNo">419</span> }<a name="line.419"></a> +<span class="sourceLineNo">420</span> }<a name="line.420"></a> +<span class="sourceLineNo">421</span><a name="line.421"></a> +<span class="sourceLineNo">422</span> /**<a name="line.422"></a> +<span class="sourceLineNo">423</span> * Returns the terms-of-service information of this REST resource.<a name="line.423"></a> +<span class="sourceLineNo">424</span> *<a name="line.424"></a> +<span class="sourceLineNo">425</span> * <p><a name="line.425"></a> +<span class="sourceLineNo">426</span> * Subclasses can override this method to provide their own terms-of-service information.<a name="line.426"></a> +<span class="sourceLineNo">427</span> *<a name="line.427"></a> +<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> +<span class="sourceLineNo">429</span> * The default implementation returns the terms-of-service information from the following locations (whichever<a name="line.429"></a> +<span class="sourceLineNo">430</span> * matches first):<a name="line.430"></a> <span class="sourceLineNo">431</span> * <ol><a name="line.431"></a> -<span class="sourceLineNo">432</span> * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent<a name="line.432"></a> -<span class="sourceLineNo">433</span> * classes.<a name="line.433"></a> -<span class="sourceLineNo">434</span> * <li><ck>[ClassName].version</ck> property in resource bundle identified by<a name="line.434"></a> +<span class="sourceLineNo">432</span> * <li>{@link ResourceSwagger#termsOfService() @ResourceSwagger.termsOfService()} annotation on this class, and<a name="line.432"></a> +<span class="sourceLineNo">433</span> * then any parent classes.<a name="line.433"></a> +<span class="sourceLineNo">434</span> * <li><ck>[ClassName].termsOfService</ck> property in resource bundle identified by<a name="line.434"></a> <span class="sourceLineNo">435</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.435"></a> -<span class="sourceLineNo">436</span> * <li><ck>version</ck> property in resource bundle identified by<a name="line.436"></a> +<span class="sourceLineNo">436</span> * <li><ck>termsOfService</ck> property in resource bundle identified by<a name="line.436"></a> <span class="sourceLineNo">437</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * <li><ck>/info/version</ck> entry in swagger file.<a name="line.438"></a> +<span class="sourceLineNo">438</span> * <li><ck>/info/termsOfService</ck> entry in swagger file.<a name="line.438"></a> <span class="sourceLineNo">439</span> * </ol><a name="line.439"></a> <span class="sourceLineNo">440</span> *<a name="line.440"></a> <span class="sourceLineNo">441</span> * @param req The current request.<a name="line.441"></a> <span class="sourceLineNo">442</span> * @return<a name="line.442"></a> <span class="sourceLineNo">443</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.443"></a> <span class="sourceLineNo">444</span> */<a name="line.444"></a> -<span class="sourceLineNo">445</span> public String getVersion(RestRequest req) {<a name="line.445"></a> +<span class="sourceLineNo">445</span> public String getTermsOfService(RestRequest req) {<a name="line.445"></a> <span class="sourceLineNo">446</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.446"></a> -<span class="sourceLineNo">447</span> if (this.version != null)<a name="line.447"></a> -<span class="sourceLineNo">448</span> return vr.resolve(this.version);<a name="line.448"></a> -<span class="sourceLineNo">449</span> String version = context.getMessages().findFirstString(req.getLocale(), "version");<a name="line.449"></a> -<span class="sourceLineNo">450</span> if (version != null)<a name="line.450"></a> -<span class="sourceLineNo">451</span> return vr.resolve(version);<a name="line.451"></a> +<span class="sourceLineNo">447</span> if (this.termsOfService != null)<a name="line.447"></a> +<span class="sourceLineNo">448</span> return vr.resolve(this.termsOfService);<a name="line.448"></a> +<span class="sourceLineNo">449</span> String termsOfService = context.getMessages().findFirstString(req.getLocale(), "termsOfService");<a name="line.449"></a> +<span class="sourceLineNo">450</span> if (termsOfService != null)<a name="line.450"></a> +<span class="sourceLineNo">451</span> return vr.resolve(termsOfService);<a name="line.451"></a> <span class="sourceLineNo">452</span> Swagger s = req.getSwaggerFromFile();<a name="line.452"></a> <span class="sourceLineNo">453</span> if (s != null && s.getInfo() != null)<a name="line.453"></a> -<span class="sourceLineNo">454</span> return s.getInfo().getVersion();<a name="line.454"></a> +<span class="sourceLineNo">454</span> return s.getInfo().getTermsOfService();<a name="line.454"></a> <span class="sourceLineNo">455</span> return null;<a name="line.455"></a> <span class="sourceLineNo">456</span> }<a name="line.456"></a> <span class="sourceLineNo">457</span><a name="line.457"></a> @@ -485,64 +485,99 @@ <span class="sourceLineNo">477</span> * @return<a name="line.477"></a> <span class="sourceLineNo">478</span> * The localized contact information of this REST resource, or <jk>null</jk> if no contact information was found.<a name="line.478"></a> <span class="sourceLineNo">479</span> */<a name="line.479"></a> -<span class="sourceLineNo">480</span> public List<Tag> getTags(RestRequest req) {<a name="line.480"></a> +<span class="sourceLineNo">480</span> public String getVersion(RestRequest req) {<a name="line.480"></a> <span class="sourceLineNo">481</span> VarResolverSession vr = req.getVarResolverSession();<a name="line.481"></a> -<span class="sourceLineNo">482</span> JsonParser jp = JsonParser.DEFAULT;<a name="line.482"></a> -<span class="sourceLineNo">483</span> try {<a name="line.483"></a> -<span class="sourceLineNo">484</span> if (this.tags != null)<a name="line.484"></a> -<span class="sourceLineNo">485</span> return jp.parse(vr.resolve(this.tags), ArrayList.class, Tag.class);<a name="line.485"></a> -<span class="sourceLineNo">486</span> String tags = context.getMessages().findFirstString(req.getLocale(), "tags");<a name="line.486"></a> -<span class="sourceLineNo">487</span> if (tags != null)<a name="line.487"></a> -<span class="sourceLineNo">488</span> return jp.parse(vr.resolve(tags), ArrayList.class, Tag.class);<a name="line.488"></a> -<span class="sourceLineNo">489</span> Swagger s = req.getSwaggerFromFile();<a name="line.489"></a> -<span class="sourceLineNo">490</span> if (s != null)<a name="line.490"></a> -<span class="sourceLineNo">491</span> return s.getTags();<a name="line.491"></a> -<span class="sourceLineNo">492</span> return null;<a name="line.492"></a> -<span class="sourceLineNo">493</span> } catch (Exception e) {<a name="line.493"></a> -<span class="sourceLineNo">494</span> throw new RestException(SC_INTERNAL_SERVER_ERROR, e);<a name="line.494"></a> -<span class="sourceLineNo">495</span> }<a name="line.495"></a> -<span class="sourceLineNo">496</span> }<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> * Returns the version information of this REST resource.<a name="line.499"></a> -<span class="sourceLineNo">500</span> *<a name="line.500"></a> -<span class="sourceLineNo">501</span> * <p><a name="line.501"></a> -<span class="sourceLineNo">502</span> * Subclasses can override this method to provide their own version information.<a name="line.502"></a> -<span class="sourceLineNo">503</span> *<a name="line.503"></a> -<span class="sourceLineNo">504</span> * <p><a name="line.504"></a> -<span class="sourceLineNo">505</span> * The default implementation returns the version information from the following locations (whichever matches first):<a name="line.505"></a> -<span class="sourceLineNo">506</span> * <ol><a name="line.506"></a> -<span class="sourceLineNo">507</span> * <li>{@link ResourceSwagger#version() @ResourceSwagger.version()} annotation on this class, and then any parent<a name="line.507"></a> -<span class="sourceLineNo">508</span> * classes.<a name="line.508"></a> -<span class="sourceLineNo">509</span> * <li><ck>[ClassName].version</ck> property in resource bundle identified by<a name="line.509"></a> -<span class="sourceLineNo">510</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.510"></a> -<span class="sourceLineNo">511</span> * <li><ck>version</ck> property in resource bundle identified by<a name="line.511"></a> -<span class="sourceLineNo">512</span> * {@link RestResource#messages() @RestResource.messages()} annotation for this class, then any parent classes.<a name="line.512"></a> -<span class="sourceLineNo">513</span> * <li><ck>/info/version</ck> entry in swagger file.<a name="line.513"></a> -<span class="sourceLineNo">514</span> * </ol><a name="line.514"></a> -<span class="sourceLineNo">515</span> *<a name="line.515"></a> -<span class="sourceLineNo">516</span> * @param req The current request.<a name="line.516"></a> -<span class="sourceLineNo">517</span> * @return<a name="line.517"></a> -<spa
<TRUNCATED>
