You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/04/01 23:57:50 UTC
[02/51] [partial] incubator-juneau-website git commit: Javadoc
updates.
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5aed2f48/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html
index ad3974d..8804856 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestResource.html
@@ -29,684 +29,781 @@
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.juneau.encoders.Encoder;<a name="line.23"></a>
-<span class="sourceLineNo">024</span>import org.apache.juneau.ini.*;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.juneau.jena.*;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.juneau.json.*;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.juneau.parser.*;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.juneau.rest.*;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.juneau.serializer.*;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.juneau.transform.*;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.juneau.utils.*;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.juneau.xml.*;<a name="line.32"></a>
-<span class="sourceLineNo">033</span><a name="line.33"></a>
-<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * Used to denote that a class is a REST resource and to associate metadata on it.<a name="line.35"></a>
-<span class="sourceLineNo">036</span> * <p><a name="line.36"></a>
-<span class="sourceLineNo">037</span> * Usually used on a subclass of {@link RestServlet}, but can be used to annotate any class that you want to expose as a REST resource.<a name="line.37"></a>
-<span class="sourceLineNo">038</span> *<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.<a name="line.39"></a>
-<span class="sourceLineNo">040</span> */<a name="line.40"></a>
-<span class="sourceLineNo">041</span>@Documented<a name="line.41"></a>
-<span class="sourceLineNo">042</span>@Target(TYPE)<a name="line.42"></a>
-<span class="sourceLineNo">043</span>@Retention(RUNTIME)<a name="line.43"></a>
-<span class="sourceLineNo">044</span>@Inherited<a name="line.44"></a>
-<span class="sourceLineNo">045</span>public @interface RestResource {<a name="line.45"></a>
-<span class="sourceLineNo">046</span><a name="line.46"></a>
-<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * Identifies the location of the resource bundle for this class.<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * <p><a name="line.49"></a>
-<span class="sourceLineNo">050</span> * This annotation is used to provide localized messages for the following methods:<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * <ul><a name="line.51"></a>
-<span class="sourceLineNo">052</span> * <li>{@link RestRequest#getMessage(String, Object...)}<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * <li>{@link RestContext#getMessages()}<a name="line.53"></a>
-<span class="sourceLineNo">054</span> * </ul><a name="line.54"></a>
-<span class="sourceLineNo">055</span> * <p><a name="line.55"></a>
-<span class="sourceLineNo">056</span> * Refer to the {@link MessageBundle} class for a description of the message key formats<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * used in the properties file.<a name="line.57"></a>
-<span class="sourceLineNo">058</span> * <p><a name="line.58"></a>
-<span class="sourceLineNo">059</span> * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the<a name="line.59"></a>
-<span class="sourceLineNo">060</span> * resource bundle <js>"com.foo.sample.nls.Messages"</js> if the resource class<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * is in <js>"com.foo.sample"</js>, or it can be an absolute path, like <js>"com.foo.sample.nls.Messages"</js><a name="line.61"></a>
-<span class="sourceLineNo">062</span> */<a name="line.62"></a>
-<span class="sourceLineNo">063</span> String messages() default "";<a name="line.63"></a>
-<span class="sourceLineNo">064</span><a name="line.64"></a>
-<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
-<span class="sourceLineNo">066</span> * Class-level guards.<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * <p><a name="line.67"></a>
-<span class="sourceLineNo">068</span> * Associates one or more {@link RestGuard RestGuards} with all REST methods defined<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * in this class.<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * These guards get called immediately before execution of any REST method in this class.<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * <p><a name="line.71"></a>
-<span class="sourceLineNo">072</span> * Typically, guards will be used for permissions checking on the user making the request,<a name="line.72"></a>
-<span class="sourceLineNo">073</span> * but it can also be used for other purposes like pre-call validation of a request.<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * <p><a name="line.74"></a>
-<span class="sourceLineNo">075</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addGuards(Class...)}/{@link RestConfig#addGuards(RestGuard...)} methods.<a name="line.75"></a>
-<span class="sourceLineNo">076</span> */<a name="line.76"></a>
-<span class="sourceLineNo">077</span> Class<? extends RestGuard>[] guards() default {};<a name="line.77"></a>
-<span class="sourceLineNo">078</span><a name="line.78"></a>
-<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
-<span class="sourceLineNo">080</span> * Class-level converters.<a name="line.80"></a>
-<span class="sourceLineNo">081</span> * <p><a name="line.81"></a>
-<span class="sourceLineNo">082</span> * Associates one or more {@link RestConverter converters} with a resource class.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> * These converters get called immediately after execution of the REST method in the same<a name="line.83"></a>
-<span class="sourceLineNo">084</span> * order specified in the annotation.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * <p><a name="line.85"></a>
-<span class="sourceLineNo">086</span> * Can be used for performing post-processing on the response object before serialization.<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * <p><a name="line.87"></a>
-<span class="sourceLineNo">088</span> * Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.<a name="line.88"></a>
-<span class="sourceLineNo">089</span> * <p><a name="line.89"></a>
-<span class="sourceLineNo">090</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addConverters(Class...)}/{@link RestConfig#addConverters(RestConverter...)} methods.<a name="line.90"></a>
-<span class="sourceLineNo">091</span> */<a name="line.91"></a>
-<span class="sourceLineNo">092</span> Class<? extends RestConverter>[] converters() default {};<a name="line.92"></a>
-<span class="sourceLineNo">093</span><a name="line.93"></a>
-<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * Class-level bean filters.<a name="line.95"></a>
-<span class="sourceLineNo">096</span> * <p><a name="line.96"></a>
-<span class="sourceLineNo">097</span> * Shortcut to add bean filters to the bean contexts of the objects returned by the following methods:<a name="line.97"></a>
-<span class="sourceLineNo">098</span> * <ul><a name="line.98"></a>
-<span class="sourceLineNo">099</span> * <li>{@link RestContext#getBeanContext()}<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * <li>{@link RestContext#getSerializers()}<a name="line.100"></a>
-<span class="sourceLineNo">101</span> * <li>{@link RestContext#getParsers()}<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * </ul><a name="line.102"></a>
-<span class="sourceLineNo">103</span> * <p><a name="line.103"></a>
-<span class="sourceLineNo">104</span> * If the specified class is an instance of {@link BeanFilterBuilder}, then a filter built from that builder is added.<a name="line.104"></a>
-<span class="sourceLineNo">105</span> * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should<a name="line.105"></a>
-<span class="sourceLineNo">106</span> * be treated as the specified class type.<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * <p><a name="line.107"></a>
-<span class="sourceLineNo">108</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addBeanFilters(Class...)} method.<a name="line.108"></a>
-<span class="sourceLineNo">109</span> */<a name="line.109"></a>
-<span class="sourceLineNo">110</span> Class<?>[] beanFilters() default {};<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> * Class-level POJO swaps.<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * <p><a name="line.114"></a>
-<span class="sourceLineNo">115</span> * Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods:<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * <ul><a name="line.116"></a>
-<span class="sourceLineNo">117</span> * <li>{@link RestContext#getBeanContext()}<a name="line.117"></a>
-<span class="sourceLineNo">118</span> * <li>{@link RestContext#getSerializers()}<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * <li>{@link RestContext#getParsers()}<a name="line.119"></a>
-<span class="sourceLineNo">120</span> * </ul><a name="line.120"></a>
-<span class="sourceLineNo">121</span> * <p><a name="line.121"></a>
-<span class="sourceLineNo">122</span> * If the specified class is an instance of {@link PojoSwap}, then that swap is added.<a name="line.122"></a>
-<span class="sourceLineNo">123</span> * Any other classes are wrapped in a {@link SurrogateSwap}.<a name="line.123"></a>
-<span class="sourceLineNo">124</span> * <p><a name="line.124"></a>
-<span class="sourceLineNo">125</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addPojoSwaps(Class...)} method.<a name="line.125"></a>
-<span class="sourceLineNo">126</span> */<a name="line.126"></a>
-<span class="sourceLineNo">127</span> Class<?>[] pojoSwaps() default {};<a name="line.127"></a>
-<span class="sourceLineNo">128</span><a name="line.128"></a>
-<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
-<span class="sourceLineNo">130</span> * Class-level properties.<a name="line.130"></a>
-<span class="sourceLineNo">131</span> * <p><a name="line.131"></a>
-<span class="sourceLineNo">132</span> * Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods:<a name="line.132"></a>
-<span class="sourceLineNo">133</span> * <ul><a name="line.133"></a>
-<span class="sourceLineNo">134</span> * <li>{@link RestContext#getBeanContext()}<a name="line.134"></a>
-<span class="sourceLineNo">135</span> * <li>{@link RestContext#getSerializers()}<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * <li>{@link RestContext#getParsers()}<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * </ul><a name="line.137"></a>
-<span class="sourceLineNo">138</span> * <p><a name="line.138"></a>
-<span class="sourceLineNo">139</span> * Any of the following property names can be specified:<a name="line.139"></a>
-<span class="sourceLineNo">140</span> * <ul><a name="line.140"></a>
-<span class="sourceLineNo">141</span> * <li>{@link RestContext}<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * <li>{@link BeanContext}<a name="line.142"></a>
-<span class="sourceLineNo">143</span> * <li>{@link SerializerContext}<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * <li>{@link ParserContext}<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * <li>{@link JsonSerializerContext}<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * <li>{@link RdfSerializerContext}<a name="line.146"></a>
-<span class="sourceLineNo">147</span> * <li>{@link RdfParserContext}<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * <li>{@link RdfCommonContext}<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * <li>{@link XmlSerializerContext}<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * <li>{@link XmlParserContext}<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * </ul><a name="line.151"></a>
-<span class="sourceLineNo">152</span> * <p><a name="line.152"></a>
-<span class="sourceLineNo">153</span> * Property values will be converted to the appropriate type.<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * <p><a name="line.154"></a>
-<span class="sourceLineNo">155</span> * In some cases, properties can be overridden at runtime through the {@link RestResponse#setProperty(String, Object)} method<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * or through a {@link Properties @Properties} annotated method parameter.<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * <p><a name="line.157"></a>
-<span class="sourceLineNo">158</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setProperty(String, Object)}/{@link RestConfig#setProperties(java.util.Map)} methods.<a name="line.158"></a>
-<span class="sourceLineNo">159</span> */<a name="line.159"></a>
-<span class="sourceLineNo">160</span> Property[] properties() default {};<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> * Specifies a list of {@link Serializer} classes to add to the list of serializers available for this servlet.<a name="line.163"></a>
-<span class="sourceLineNo">164</span> * <p><a name="line.164"></a>
-<span class="sourceLineNo">165</span> * This annotation can only be used on {@link Serializer} classes that have no-arg constructors.<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * <p><a name="line.166"></a>
-<span class="sourceLineNo">167</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addSerializers(Class...)}/{@link RestConfig#addSerializers(Serializer...)} methods.<a name="line.167"></a>
-<span class="sourceLineNo">168</span> */<a name="line.168"></a>
-<span class="sourceLineNo">169</span> Class<? extends Serializer>[] serializers() default {};<a name="line.169"></a>
-<span class="sourceLineNo">170</span><a name="line.170"></a>
-<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * Specifies a list of {@link Parser} classes to add to the list of parsers available for this servlet.<a name="line.172"></a>
-<span class="sourceLineNo">173</span> * <p><a name="line.173"></a>
-<span class="sourceLineNo">174</span> * This annotation can only be used on {@link Parser} classes that have no-arg constructors.<a name="line.174"></a>
-<span class="sourceLineNo">175</span> * <p><a name="line.175"></a>
-<span class="sourceLineNo">176</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addParsers(Class...)}/{@link RestConfig#addParsers(Parser...)} methods.<a name="line.176"></a>
-<span class="sourceLineNo">177</span> */<a name="line.177"></a>
-<span class="sourceLineNo">178</span> Class<? extends Parser>[] parsers() default {};<a name="line.178"></a>
-<span class="sourceLineNo">179</span><a name="line.179"></a>
-<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * Specifies a list of {@link ResponseHandler} classes that know how to convert POJOs returned<a name="line.181"></a>
-<span class="sourceLineNo">182</span> * by REST methods or set via {@link RestResponse#setOutput(Object)} into appropriate<a name="line.182"></a>
-<span class="sourceLineNo">183</span> * HTTP responses.<a name="line.183"></a>
-<span class="sourceLineNo">184</span> * <p><a name="line.184"></a>
-<span class="sourceLineNo">185</span> * See {@link ResponseHandler} for details.<a name="line.185"></a>
-<span class="sourceLineNo">186</span> * <p><a name="line.186"></a>
-<span class="sourceLineNo">187</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addResponseHandlers(Class...)}/{@link RestConfig#addResponseHandlers(ResponseHandler...)} methods.<a name="line.187"></a>
-<span class="sourceLineNo">188</span> */<a name="line.188"></a>
-<span class="sourceLineNo">189</span> Class<? extends ResponseHandler>[] responseHandlers() default {};<a name="line.189"></a>
-<span class="sourceLineNo">190</span><a name="line.190"></a>
-<span class="sourceLineNo">191</span> /**<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * Specifies a list of {@link Encoder} to associate with this servlet.<a name="line.192"></a>
-<span class="sourceLineNo">193</span> * <p><a name="line.193"></a>
-<span class="sourceLineNo">194</span> * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.<a name="line.194"></a>
-<span class="sourceLineNo">195</span> * <p><a name="line.195"></a>
-<span class="sourceLineNo">196</span> * This annotation can only be used on {@link Encoder} classes that have no-arg constructors.<a name="line.196"></a>
-<span class="sourceLineNo">197</span> *<a name="line.197"></a>
-<span class="sourceLineNo">198</span> * <h5 class='section'>Example:</h5><a name="line.198"></a>
-<span class="sourceLineNo">199</span> * <p class='bcode'><a name="line.199"></a>
-<span class="sourceLineNo">200</span> * <jc>// Servlet with automated support for GZIP compression</jc><a name="line.200"></a>
-<span class="sourceLineNo">201</span> * <ja>@RestResource</ja>(encoders={GzipEncoder.<jk>class</jk>})<a name="line.201"></a>
-<span class="sourceLineNo">202</span> * <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet {<a name="line.202"></a>
-<span class="sourceLineNo">203</span> * ...<a name="line.203"></a>
-<span class="sourceLineNo">204</span> * }<a name="line.204"></a>
-<span class="sourceLineNo">205</span> * </p><a name="line.205"></a>
-<span class="sourceLineNo">206</span> * <p><a name="line.206"></a>
-<span class="sourceLineNo">207</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addEncoders(Class...)}/{@link RestConfig#addEncoders(Encoder...)} methods.<a name="line.207"></a>
-<span class="sourceLineNo">208</span> */<a name="line.208"></a>
-<span class="sourceLineNo">209</span> Class<? extends Encoder>[] encoders() default {};<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> * Specifies default values for request headers.<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * <p><a name="line.213"></a>
-<span class="sourceLineNo">214</span> * Strings are of the format <js>"Header-Name: header-value"</js>.<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * <p><a name="line.215"></a>
-<span class="sourceLineNo">216</span> * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.<a name="line.216"></a>
-<span class="sourceLineNo">217</span> * <p><a name="line.217"></a>
-<span class="sourceLineNo">218</span> * The most useful reason for this annotation is to provide a default <code>Accept</code> header when one is not specified<a name="line.218"></a>
-<span class="sourceLineNo">219</span> * so that a particular default {@link Serializer} is picked.<a name="line.219"></a>
-<span class="sourceLineNo">220</span> * <p><a name="line.220"></a>
-<span class="sourceLineNo">221</span> * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).<a name="line.221"></a>
-<span class="sourceLineNo">222</span> *<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * <h5 class='section'>Example:</h5><a name="line.223"></a>
-<span class="sourceLineNo">224</span> * <p class='bcode'><a name="line.224"></a>
-<span class="sourceLineNo">225</span> * <jc>// Assume "text/json" Accept value when Accept not specified</jc><a name="line.225"></a>
-<span class="sourceLineNo">226</span> * <ja>@RestResource</ja>(defaultRequestHeaders={<js>"Accept: text/json"</js>})<a name="line.226"></a>
-<span class="sourceLineNo">227</span> * <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet {<a name="line.227"></a>
-<span class="sourceLineNo">228</span> * ...<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * }<a name="line.229"></a>
-<span class="sourceLineNo">230</span> * </p><a name="line.230"></a>
-<span class="sourceLineNo">231</span> * <p><a name="line.231"></a>
-<span class="sourceLineNo">232</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultRequestHeader(String, Object)}/{@link RestConfig#addDefaultRequestHeaders(String...)} methods.<a name="line.232"></a>
-<span class="sourceLineNo">233</span> */<a name="line.233"></a>
-<span class="sourceLineNo">234</span> String[] defaultRequestHeaders() default {};<a name="line.234"></a>
-<span class="sourceLineNo">235</span><a name="line.235"></a>
-<span class="sourceLineNo">236</span> /**<a name="line.236"></a>
-<span class="sourceLineNo">237</span> * Specifies default values for response headers.<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * <p><a name="line.238"></a>
-<span class="sourceLineNo">239</span> * Strings are of the format <js>"Header-Name: header-value"</js>.<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * <p><a name="line.240"></a>
-<span class="sourceLineNo">241</span> * This is equivalent to calling {@link RestResponse#setHeader(String, String)} programmatically in each of the Java methods.<a name="line.241"></a>
-<span class="sourceLineNo">242</span> * <p><a name="line.242"></a>
-<span class="sourceLineNo">243</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.243"></a>
-<span class="sourceLineNo">244</span> * <p><a name="line.244"></a>
-<span class="sourceLineNo">245</span> * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).<a name="line.245"></a>
-<span class="sourceLineNo">246</span> *<a name="line.246"></a>
-<span class="sourceLineNo">247</span> * <h5 class='section'>Example:</h5><a name="line.247"></a>
-<span class="sourceLineNo">248</span> * <p class='bcode'><a name="line.248"></a>
-<span class="sourceLineNo">249</span> * <jc>// Add a version header attribute to all responses</jc><a name="line.249"></a>
-<span class="sourceLineNo">250</span> * <ja>@RestResource</ja>(defaultResponseHeaders={<js>"X-Version: 1.0"</js>})<a name="line.250"></a>
-<span class="sourceLineNo">251</span> * <jk>public</jk> MyRestServlet <jk>extends</jk> RestServlet {<a name="line.251"></a>
-<span class="sourceLineNo">252</span> * ...<a name="line.252"></a>
-<span class="sourceLineNo">253</span> * }<a name="line.253"></a>
-<span class="sourceLineNo">254</span> * </p><a name="line.254"></a>
-<span class="sourceLineNo">255</span> * <p><a name="line.255"></a>
-<span class="sourceLineNo">256</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addDefaultResponseHeader(String, Object)}/{@link RestConfig#addDefaultResponseHeaders(String...)} methods.<a name="line.256"></a>
-<span class="sourceLineNo">257</span> */<a name="line.257"></a>
-<span class="sourceLineNo">258</span> String[] defaultResponseHeaders() default {};<a name="line.258"></a>
-<span class="sourceLineNo">259</span><a name="line.259"></a>
-<span class="sourceLineNo">260</span> /**<a name="line.260"></a>
-<span class="sourceLineNo">261</span> * Defines children of this resource.<a name="line.261"></a>
-<span class="sourceLineNo">262</span> * <p><a name="line.262"></a>
-<span class="sourceLineNo">263</span> * A REST child resource is simply another servlet that is initialized as part of the parent<a name="line.263"></a>
-<span class="sourceLineNo">264</span> * resource and has a servlet path directly under the parent servlet path.<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * The main advantage to defining servlets as REST children is that you do not need<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * to define them in the <code>web.xml</code> file of the web application.<a name="line.266"></a>
-<span class="sourceLineNo">267</span> * This can cut down on the number of entries that show up in the <code>web.xml</code> file<a name="line.267"></a>
-<span class="sourceLineNo">268</span> * if you are defining large numbers of servlets.<a name="line.268"></a>
-<span class="sourceLineNo">269</span> * <p><a name="line.269"></a>
-<span class="sourceLineNo">270</span> * Child resources must specify a value for {@link #path()} that identifies the subpath of the<a name="line.270"></a>
-<span class="sourceLineNo">271</span> * child resource relative to the parent path.<a name="line.271"></a>
-<span class="sourceLineNo">272</span> * <p><a name="line.272"></a>
-<span class="sourceLineNo">273</span> * It should be noted that servlets can be nested arbitrarily deep using this technique (i.e. children can also have children).<a name="line.273"></a>
-<span class="sourceLineNo">274</span> *<a name="line.274"></a>
-<span class="sourceLineNo">275</span> * <dl><a name="line.275"></a>
-<span class="sourceLineNo">276</span> * <dt>Servlet initialization:</dt><a name="line.276"></a>
-<span class="sourceLineNo">277</span> * <dd><a name="line.277"></a>
-<span class="sourceLineNo">278</span> * <p><a name="line.278"></a>
-<span class="sourceLineNo">279</span> * A child resource will be initialized immediately after the parent servlet is initialized. The child resource<a name="line.279"></a>
-<span class="sourceLineNo">280</span> * receives the same servlet config as the parent resource. This allows configuration information such as<a name="line.280"></a>
-<span class="sourceLineNo">281</span> * servlet initialization parameters to filter to child resources.<a name="line.281"></a>
-<span class="sourceLineNo">282</span> * </p><a name="line.282"></a>
-<span class="sourceLineNo">283</span> * </dd><a name="line.283"></a>
-<span class="sourceLineNo">284</span> * <dt>Runtime behavior:</dt><a name="line.284"></a>
-<span class="sourceLineNo">285</span> * <dd><a name="line.285"></a>
-<span class="sourceLineNo">286</span> * <p><a name="line.286"></a>
-<span class="sourceLineNo">287</span> * As a rule, methods defined on the <code>HttpServletRequest</code> object will behave as if<a name="line.287"></a>
-<span class="sourceLineNo">288</span> * the child servlet were deployed as a top-level resource under the child's servlet path.<a name="line.288"></a>
-<span class="sourceLineNo">289</span> * For example, the <code>getServletPath()</code> and <code>getPathInfo()</code> methods on the<a name="line.289"></a>
-<span class="sourceLineNo">290</span> * <code>HttpServletRequest</code> object will behave as if the child resource were deployed<a name="line.290"></a>
-<span class="sourceLineNo">291</span> * using the child's servlet path.<a name="line.291"></a>
-<span class="sourceLineNo">292</span> * Therefore, the runtime behavior should be equivalent to deploying the child servlet in<a name="line.292"></a>
-<span class="sourceLineNo">293</span> * the <code>web.xml</code> file of the web application.<a name="line.293"></a>
-<span class="sourceLineNo">294</span> * </p><a name="line.294"></a>
-<span class="sourceLineNo">295</span> * </dd><a name="line.295"></a>
-<span class="sourceLineNo">296</span> * </dl><a name="line.296"></a>
-<span class="sourceLineNo">297</span> * <p><a name="line.297"></a>
-<span class="sourceLineNo">298</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addChildResource(String, Object)}/{@link RestConfig#addChildResources(Class...)}/{@link RestConfig#addChildResources(Object...)} methods.<a name="line.298"></a>
-<span class="sourceLineNo">299</span> */<a name="line.299"></a>
-<span class="sourceLineNo">300</span> Class<?>[] children() default {};<a name="line.300"></a>
-<span class="sourceLineNo">301</span><a name="line.301"></a>
-<span class="sourceLineNo">302</span> /**<a name="line.302"></a>
-<span class="sourceLineNo">303</span> * Identifies the URL subpath relative to the parent resource.<a name="line.303"></a>
-<span class="sourceLineNo">304</span> * <p><a name="line.304"></a>
-<span class="sourceLineNo">305</span> * Typically, this annotation is only applicable to resources defined as children through the {@link #children()}<a name="line.305"></a>
-<span class="sourceLineNo">306</span> * annotation. However, it may be used in other ways (e.g. defining paths for top-level resources in microservices).<a name="line.306"></a>
-<span class="sourceLineNo">307</span> * <p><a name="line.307"></a>
-<span class="sourceLineNo">308</span> * This annotation is ignored on top-level servlets (i.e. servlets defined in <code>web.xml</code> files).<a name="line.308"></a>
-<span class="sourceLineNo">309</span> * Therefore, implementers can optionally specify a path value for documentation purposes.<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * <p><a name="line.310"></a>
-<span class="sourceLineNo">311</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setPath(String)} method.<a name="line.311"></a>
-<span class="sourceLineNo">312</span> */<a name="line.312"></a>
-<span class="sourceLineNo">313</span> String path() default "";<a name="line.313"></a>
-<span class="sourceLineNo">314</span><a name="line.314"></a>
-<span class="sourceLineNo">315</span> /**<a name="line.315"></a>
-<span class="sourceLineNo">316</span> * Optional servlet title.<a name="line.316"></a>
-<span class="sourceLineNo">317</span> * <p><a name="line.317"></a>
-<span class="sourceLineNo">318</span> * It is used to populate the Swagger title field and to display on HTML pages.<a name="line.318"></a>
-<span class="sourceLineNo">319</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletTitle()} method.<a name="line.319"></a>
-<span class="sourceLineNo">320</span> * <p><a name="line.320"></a>
-<span class="sourceLineNo">321</span> * The default value pulls the label from the <code>label</code> entry in the servlet resource bundle.<a name="line.321"></a>
-<span class="sourceLineNo">322</span> * (e.g. <js>"title = foo"</js> or <js>"MyServlet.title = foo"</js>).<a name="line.322"></a>
-<span class="sourceLineNo">323</span> * <p><a name="line.323"></a>
-<span class="sourceLineNo">324</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.324"></a>
-<span class="sourceLineNo">325</span> * <p><a name="line.325"></a>
-<span class="sourceLineNo">326</span> * Corresponds to the swagger field <code>/info/title</code>.<a name="line.326"></a>
-<span class="sourceLineNo">327</span> * <p><a name="line.327"></a>
-<span class="sourceLineNo">328</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTitle(RestRequest)} method.<a name="line.328"></a>
-<span class="sourceLineNo">329</span> */<a name="line.329"></a>
-<span class="sourceLineNo">330</span> String title() default "";<a name="line.330"></a>
-<span class="sourceLineNo">331</span><a name="line.331"></a>
-<span class="sourceLineNo">332</span> /**<a name="line.332"></a>
-<span class="sourceLineNo">333</span> * Optional servlet description.<a name="line.333"></a>
-<span class="sourceLineNo">334</span> * <p><a name="line.334"></a>
-<span class="sourceLineNo">335</span> * It is used to populate the Swagger description field and to display on HTML pages.<a name="line.335"></a>
-<span class="sourceLineNo">336</span> * This value can be retrieved programmatically through the {@link RestRequest#getServletDescription()} method.<a name="line.336"></a>
-<span class="sourceLineNo">337</span> * <p><a name="line.337"></a>
-<span class="sourceLineNo">338</span> * The default value pulls the description from the <code>description</code> entry in the servlet resource bundle.<a name="line.338"></a>
-<span class="sourceLineNo">339</span> * (e.g. <js>"description = foo"</js> or <js>"MyServlet.description = foo"</js>).<a name="line.339"></a>
-<span class="sourceLineNo">340</span> * <p><a name="line.340"></a>
-<span class="sourceLineNo">341</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.341"></a>
-<span class="sourceLineNo">342</span> * <p><a name="line.342"></a>
-<span class="sourceLineNo">343</span> * Corresponds to the swagger field <code>/info/description</code>.<a name="line.343"></a>
-<span class="sourceLineNo">344</span> * <p><a name="line.344"></a>
-<span class="sourceLineNo">345</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getDescription(RestRequest)} method.<a name="line.345"></a>
-<span class="sourceLineNo">346</span> */<a name="line.346"></a>
-<span class="sourceLineNo">347</span> String description() default "";<a name="line.347"></a>
-<span class="sourceLineNo">348</span><a name="line.348"></a>
-<span class="sourceLineNo">349</span> /**<a name="line.349"></a>
-<span class="sourceLineNo">350</span> * Optional servlet terms-of-service for this API.<a name="line.350"></a>
-<span class="sourceLineNo">351</span> * <p><a name="line.351"></a>
-<span class="sourceLineNo">352</span> * It is used to populate the Swagger terms-of-service field.<a name="line.352"></a>
-<span class="sourceLineNo">353</span> * <p><a name="line.353"></a>
-<span class="sourceLineNo">354</span> * The default value pulls the description from the <code>termsOfService</code> entry in the servlet resource bundle.<a name="line.354"></a>
-<span class="sourceLineNo">355</span> * (e.g. <js>"termsOfService = foo"</js> or <js>"MyServlet.termsOfService = foo"</js>).<a name="line.355"></a>
-<span class="sourceLineNo">356</span> * <p><a name="line.356"></a>
-<span class="sourceLineNo">357</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * <p><a name="line.358"></a>
-<span class="sourceLineNo">359</span> * Corresponds to the swagger field <code>/info/termsOfService</code>.<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * <p><a name="line.360"></a>
-<span class="sourceLineNo">361</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTermsOfService(RestRequest)} method.<a name="line.361"></a>
-<span class="sourceLineNo">362</span> */<a name="line.362"></a>
-<span class="sourceLineNo">363</span> String termsOfService() default "";<a name="line.363"></a>
-<span class="sourceLineNo">364</span><a name="line.364"></a>
-<span class="sourceLineNo">365</span> /**<a name="line.365"></a>
-<span class="sourceLineNo">366</span> * Optional contact information for the exposed API.<a name="line.366"></a>
-<span class="sourceLineNo">367</span> * <p><a name="line.367"></a>
-<span class="sourceLineNo">368</span> * It is used to populate the Swagger contact field and to display on HTML pages.<a name="line.368"></a>
-<span class="sourceLineNo">369</span> * <p><a name="line.369"></a>
-<span class="sourceLineNo">370</span> * A simplified JSON string with the following fields:<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * <p class='bcode'><a name="line.371"></a>
-<span class="sourceLineNo">372</span> * {<a name="line.372"></a>
-<span class="sourceLineNo">373</span> * name: string,<a name="line.373"></a>
-<span class="sourceLineNo">374</span> * url: string,<a name="line.374"></a>
-<span class="sourceLineNo">375</span> * email: string<a name="line.375"></a>
-<span class="sourceLineNo">376</span> * }<a name="line.376"></a>
-<span class="sourceLineNo">377</span> * </p><a name="line.377"></a>
-<span class="sourceLineNo">378</span> * <p><a name="line.378"></a>
-<span class="sourceLineNo">379</span> * The default value pulls the description from the <code>contact</code> entry in the servlet resource bundle.<a name="line.379"></a>
-<span class="sourceLineNo">380</span> * (e.g. <js>"contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js> or <js>"MyServlet.contact = {name:'John Smith',email:'john.smith@foo.bar'}"</js>).<a name="line.380"></a>
-<span class="sourceLineNo">381</span> *<a name="line.381"></a>
-<span class="sourceLineNo">382</span> * <h5 class='section'>Example:</h5><a name="line.382"></a>
-<span class="sourceLineNo">383</span> * <p class='bcode'><a name="line.383"></a>
-<span class="sourceLineNo">384</span> * <ja>@RestResource</ja>(contact=<js>"{name:'John Smith',email:'john.smith@foo.bar'}"</js>)<a name="line.384"></a>
-<span class="sourceLineNo">385</span> * </p><a name="line.385"></a>
-<span class="sourceLineNo">386</span> * <p><a name="line.386"></a>
-<span class="sourceLineNo">387</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.387"></a>
-<span class="sourceLineNo">388</span> * <p><a name="line.388"></a>
-<span class="sourceLineNo">389</span> * Corresponds to the swagger field <code>/info/contact</code>.<a name="line.389"></a>
-<span class="sourceLineNo">390</span> * <p><a name="line.390"></a>
-<span class="sourceLineNo">391</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getContact(RestRequest)} method.<a name="line.391"></a>
-<span class="sourceLineNo">392</span> */<a name="line.392"></a>
-<span class="sourceLineNo">393</span> String contact() default "";<a name="line.393"></a>
-<span class="sourceLineNo">394</span><a name="line.394"></a>
-<span class="sourceLineNo">395</span> /**<a name="line.395"></a>
-<span class="sourceLineNo">396</span> * Optional license information for the exposed API.<a name="line.396"></a>
-<span class="sourceLineNo">397</span> * <p><a name="line.397"></a>
-<span class="sourceLineNo">398</span> * It is used to populate the Swagger license field and to display on HTML pages.<a name="line.398"></a>
-<span class="sourceLineNo">399</span> * <p><a name="line.399"></a>
-<span class="sourceLineNo">400</span> * A simplified JSON string with the following fields:<a name="line.400"></a>
-<span class="sourceLineNo">401</span> * <p class='bcode'><a name="line.401"></a>
-<span class="sourceLineNo">402</span> * {<a name="line.402"></a>
-<span class="sourceLineNo">403</span> * name: string,<a name="line.403"></a>
-<span class="sourceLineNo">404</span> * url: string<a name="line.404"></a>
-<span class="sourceLineNo">405</span> * }<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * </p><a name="line.406"></a>
-<span class="sourceLineNo">407</span> * <p><a name="line.407"></a>
-<span class="sourceLineNo">408</span> * The default value pulls the description from the <code>license</code> entry in the servlet resource bundle.<a name="line.408"></a>
-<span class="sourceLineNo">409</span> * (e.g. <js>"license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js> or <js>"MyServlet.license = {name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>).<a name="line.409"></a>
-<span class="sourceLineNo">410</span> *<a name="line.410"></a>
-<span class="sourceLineNo">411</span> * <h5 class='section'>Example:</h5><a name="line.411"></a>
-<span class="sourceLineNo">412</span> * <p class='bcode'><a name="line.412"></a>
-<span class="sourceLineNo">413</span> * <ja>@RestResource</ja>(license=<js>"{name:'Apache 2.0',url:'http://www.apache.org/licenses/LICENSE-2.0.html'}"</js>)<a name="line.413"></a>
-<span class="sourceLineNo">414</span> * </p><a name="line.414"></a>
-<span class="sourceLineNo">415</span> * <p><a name="line.415"></a>
-<span class="sourceLineNo">416</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.416"></a>
-<span class="sourceLineNo">417</span> * <p><a name="line.417"></a>
-<span class="sourceLineNo">418</span> * Corresponds to the swagger field <code>/info/license</code>.<a name="line.418"></a>
-<span class="sourceLineNo">419</span> * <p><a name="line.419"></a>
-<span class="sourceLineNo">420</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getLicense(RestRequest)} method.<a name="line.420"></a>
-<span class="sourceLineNo">421</span> */<a name="line.421"></a>
-<span class="sourceLineNo">422</span> String license() default "";<a name="line.422"></a>
-<span class="sourceLineNo">423</span><a name="line.423"></a>
-<span class="sourceLineNo">424</span> /**<a name="line.424"></a>
-<span class="sourceLineNo">425</span> * Provides the version of the application API (not to be confused with the specification version).<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * <p><a name="line.426"></a>
-<span class="sourceLineNo">427</span> * It is used to populate the Swagger version field and to display on HTML pages.<a name="line.427"></a>
-<span class="sourceLineNo">428</span> * <p><a name="line.428"></a>
-<span class="sourceLineNo">429</span> * The default value pulls the description from the <code>version</code> entry in the servlet resource bundle.<a name="line.429"></a>
-<span class="sourceLineNo">430</span> * (e.g. <js>"version = 2.0"</js> or <js>"MyServlet.version = 2.0"</js>).<a name="line.430"></a>
-<span class="sourceLineNo">431</span> * <p><a name="line.431"></a>
-<span class="sourceLineNo">432</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.432"></a>
-<span class="sourceLineNo">433</span> * <p><a name="line.433"></a>
-<span class="sourceLineNo">434</span> * Corresponds to the swagger field <code>/info/version</code>.<a name="line.434"></a>
-<span class="sourceLineNo">435</span> * <p><a name="line.435"></a>
-<span class="sourceLineNo">436</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getVersion(RestRequest)} method.<a name="line.436"></a>
-<span class="sourceLineNo">437</span> */<a name="line.437"></a>
-<span class="sourceLineNo">438</span> String version() default "";<a name="line.438"></a>
-<span class="sourceLineNo">439</span><a name="line.439"></a>
-<span class="sourceLineNo">440</span> /**<a name="line.440"></a>
-<span class="sourceLineNo">441</span> * Optional tagging information for the exposed API.<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * <p><a name="line.442"></a>
-<span class="sourceLineNo">443</span> * It is used to populate the Swagger tags field and to display on HTML pages.<a name="line.443"></a>
-<span class="sourceLineNo">444</span> * <p><a name="line.444"></a>
-<span class="sourceLineNo">445</span> * A simplified JSON string with the following fields:<a name="line.445"></a>
-<span class="sourceLineNo">446</span> * <p class='bcode'><a name="line.446"></a>
-<span class="sourceLineNo">447</span> * [<a name="line.447"></a>
-<span class="sourceLineNo">448</span> * {<a name="line.448"></a>
-<span class="sourceLineNo">449</span> * name: string,<a name="line.449"></a>
-<span class="sourceLineNo">450</span> * description: string,<a name="line.450"></a>
-<span class="sourceLineNo">451</span> * externalDocs: {<a name="line.451"></a>
-<span class="sourceLineNo">452</span> * description: string,<a name="line.452"></a>
-<span class="sourceLineNo">453</span> * url: string<a name="line.453"></a>
-<span class="sourceLineNo">454</span> * }<a name="line.454"></a>
-<span class="sourceLineNo">455</span> * }<a name="line.455"></a>
-<span class="sourceLineNo">456</span> * ]<a name="line.456"></a>
-<span class="sourceLineNo">457</span> * </p><a name="line.457"></a>
-<span class="sourceLineNo">458</span> * <p><a name="line.458"></a>
-<span class="sourceLineNo">459</span> * The default value pulls the description from the <code>tags</code> entry in the servlet resource bundle.<a name="line.459"></a>
-<span class="sourceLineNo">460</span> * (e.g. <js>"tags = [{name:'Foo',description:'Foobar'}]"</js> or <js>"MyServlet.tags = [{name:'Foo',description:'Foobar'}]"</js>).<a name="line.460"></a>
-<span class="sourceLineNo">461</span> *<a name="line.461"></a>
-<span class="sourceLineNo">462</span> * <h5 class='section'>Example:</h5><a name="line.462"></a>
-<span class="sourceLineNo">463</span> * <p class='bcode'><a name="line.463"></a>
-<span class="sourceLineNo">464</span> * <ja>@RestResource</ja>(tags=<js>"[{name:'Foo',description:'Foobar'}]"</js>)<a name="line.464"></a>
-<span class="sourceLineNo">465</span> * </p><a name="line.465"></a>
-<span class="sourceLineNo">466</span> * <p><a name="line.466"></a>
-<span class="sourceLineNo">467</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.467"></a>
-<span class="sourceLineNo">468</span> * <p><a name="line.468"></a>
-<span class="sourceLineNo">469</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.469"></a>
-<span class="sourceLineNo">470</span> * <p><a name="line.470"></a>
-<span class="sourceLineNo">471</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getTags(RestRequest)} method.<a name="line.471"></a>
-<span class="sourceLineNo">472</span> */<a name="line.472"></a>
-<span class="sourceLineNo">473</span> String tags() default "";<a name="line.473"></a>
-<span class="sourceLineNo">474</span><a name="line.474"></a>
-<span class="sourceLineNo">475</span> /**<a name="line.475"></a>
-<span class="sourceLineNo">476</span> * Optional external documentation information for the exposed API.<a name="line.476"></a>
-<span class="sourceLineNo">477</span> * <p><a name="line.477"></a>
-<span class="sourceLineNo">478</span> * It is used to populate the Swagger external documentation field and to display on HTML pages.<a name="line.478"></a>
-<span class="sourceLineNo">479</span> * <p><a name="line.479"></a>
-<span class="sourceLineNo">480</span> * A simplified JSON string with the following fields:<a name="line.480"></a>
-<span class="sourceLineNo">481</span> * <p class='bcode'><a name="line.481"></a>
-<span class="sourceLineNo">482</span> * {<a name="line.482"></a>
-<span class="sourceLineNo">483</span> * description: string,<a name="line.483"></a>
-<span class="sourceLineNo">484</span> * url: string<a name="line.484"></a>
-<span class="sourceLineNo">485</span> * }<a name="line.485"></a>
-<span class="sourceLineNo">486</span> * </p><a name="line.486"></a>
-<span class="sourceLineNo">487</span> * <p><a name="line.487"></a>
-<span class="sourceLineNo">488</span> * The default value pulls the description from the <code>externalDocs</code> entry in the servlet resource bundle.<a name="line.488"></a>
-<span class="sourceLineNo">489</span> * (e.g. <js>"externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"MyServlet.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.489"></a>
-<span class="sourceLineNo">490</span> *<a name="line.490"></a>
-<span class="sourceLineNo">491</span> * <h5 class='section'>Example:</h5><a name="line.491"></a>
-<span class="sourceLineNo">492</span> * <p class='bcode'><a name="line.492"></a>
-<span class="sourceLineNo">493</span> * <ja>@RestResource</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>)<a name="line.493"></a>
-<span class="sourceLineNo">494</span> * </p><a name="line.494"></a>
-<span class="sourceLineNo">495</span> * <p><a name="line.495"></a>
-<span class="sourceLineNo">496</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.496"></a>
-<span class="sourceLineNo">497</span> * <p><a name="line.497"></a>
-<span class="sourceLineNo">498</span> * Corresponds to the swagger field <code>/tags</code>.<a name="line.498"></a>
-<span class="sourceLineNo">499</span> * <p><a name="line.499"></a>
-<span class="sourceLineNo">500</span> * The programmatic equivalent to this annotation is the {@link RestInfoProvider#getExternalDocs(RestRequest)} method.<a name="line.500"></a>
-<span class="sourceLineNo">501</span> */<a name="line.501"></a>
-<span class="sourceLineNo">502</span> String externalDocs() default "";<a name="line.502"></a>
-<span class="sourceLineNo">503</span><a name="line.503"></a>
-<span class="sourceLineNo">504</span> /**<a name="line.504"></a>
-<span class="sourceLineNo">505</span> * Optional location of configuration file for this servlet.<a name="line.505"></a>
-<span class="sourceLineNo">506</span> * <p><a name="line.506"></a>
-<span class="sourceLineNo">507</span> * The configuration file .<a name="line.507"></a>
-<span class="sourceLineNo">508</span> * <p><a name="line.508"></a>
-<span class="sourceLineNo">509</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.509"></a>
-<span class="sourceLineNo">510</span> * <p><a name="line.510"></a>
-<span class="sourceLineNo">511</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setConfigFile(ConfigFile)} method.<a name="line.511"></a>
-<span class="sourceLineNo">512</span> */<a name="line.512"></a>
-<span class="sourceLineNo">513</span> String config() default "";<a name="line.513"></a>
-<span class="sourceLineNo">514</span><a name="line.514"></a>
-<span class="sourceLineNo">515</span> /**<a name="line.515"></a>
-<span class="sourceLineNo">516</span> * The stylesheet to use for HTML views.<a name="line.516"></a>
-<span class="sourceLineNo">517</span> * <p><a name="line.517"></a>
-<span class="sourceLineNo">518</span> * The name is a path to a stylesheet located in either the classpath or working directory.<a name="line.518"></a>
-<span class="sourceLineNo">519</span> * The resulting stylesheet becomes available through the servlet via the URL <js>"[servletpath]/style.css"</js>.<a name="line.519"></a>
-<span class="sourceLineNo">520</span> * <p><a name="line.520"></a>
-<span class="sourceLineNo">521</span> * The default set of styles located in the <code>org.apache.juneau.rest.styles</code> package are:<a name="line.521"></a>
-<span class="sourceLineNo">522</span> * <ul class='spaced-list'><a name="line.522"></a>
-<span class="sourceLineNo">523</span> * <li><js>"styles/juneau.css"</js> - Theme based on Jazz look-and-feel.<a name="line.523"></a>
-<span class="sourceLineNo">524</span> * <li><js>"styles/devops.css"</js> - Theme based on IBM DevOps look-and-feel.<a name="line.524"></a>
-<span class="sourceLineNo">525</span> * </ul><a name="line.525"></a>
-<span class="sourceLineNo">526</span> * <p><a name="line.526"></a>
-<span class="sourceLineNo">527</span> * The classpath search starts with the child servlet class and proceeds up the class hierarchy<a name="line.527"></a>
-<span class="sourceLineNo">528</span> * chain. Since the {@link RestServlet} class is in the <code>org.apache.juneau.rest</code> package<a name="line.528"></a>
-<span class="sourceLineNo">529</span> * and the predefined styles are in the <code>org.apache.juneau.rest.styles</code> package, the paths to<a name="line.529"></a>
-<span class="sourceLineNo">530</span> * the predefined styles are prefixed with <js>"styles/"</js>.<a name="line.530"></a>
-<span class="sourceLineNo">531</span> * <p><a name="line.531"></a>
-<span class="sourceLineNo">532</span> * If the stylesheet cannot be found on the classpath, an attempt to look in the working directory<a name="line.532"></a>
-<span class="sourceLineNo">533</span> * for it will be made. This allows for stylesheets to be placed on the file system in the working<a name="line.533"></a>
-<span class="sourceLineNo">534</span> * directory.<a name="line.534"></a>
-<span class="sourceLineNo">535</span> * <p><a name="line.535"></a>
-<span class="sourceLineNo">536</span> * If the file cannot be located, the request to <js>"[servletpath]/style.css"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.536"></a>
-<span class="sourceLineNo">537</span> *<a name="line.537"></a>
-<span class="sourceLineNo">538</span> * <h5 class='section'>Example:</h5><a name="line.538"></a>
-<span class="sourceLineNo">539</span> * <p class='bcode'><a name="line.539"></a>
-<span class="sourceLineNo">540</span> * <jk>package</jk> com.foo.mypackage;<a name="line.540"></a>
-<span class="sourceLineNo">541</span> *<a name="line.541"></a>
-<span class="sourceLineNo">542</span> * <ja>@RestResource</ja>(<a name="line.542"></a>
-<span class="sourceLineNo">543</span> * stylesheet=<js>"mystyles/mycss.css"</js><a name="line.543"></a>
-<span class="sourceLineNo">544</span> * )<a name="line.544"></a>
-<span class="sourceLineNo">545</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.545"></a>
-<span class="sourceLineNo">546</span> * }<a name="line.546"></a>
-<span class="sourceLineNo">547</span> * </p><a name="line.547"></a>
-<span class="sourceLineNo">548</span> * <p><a name="line.548"></a>
-<span class="sourceLineNo">549</span> * In this example, the servlet will attempt to find the <code>mycss.css</code> file in the following ordered locations:<a name="line.549"></a>
-<span class="sourceLineNo">550</span> * </p><a name="line.550"></a>
-<span class="sourceLineNo">551</span> * <ol><a name="line.551"></a>
-<span class="sourceLineNo">552</span> * <li><code>com.foo.mypackage.mystyles</code> package.<a name="line.552"></a>
-<span class="sourceLineNo">553</span> * <li><code>org.apache.juneau.rest.mystyles</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).<a name="line.553"></a>
-<span class="sourceLineNo">554</span> * <li><code>[working-dir]/mystyles</code> directory.<a name="line.554"></a>
-<span class="sourceLineNo">555</span> * </ol><a name="line.555"></a>
-<span class="sourceLineNo">556</span> * <p><a name="line.556"></a>
-<span class="sourceLineNo">557</span> * Multiple stylesheets can be specified as a comma-delimited list.<a name="line.557"></a>
-<span class="sourceLineNo">558</span> * When multiple stylesheets are specified, their contents will be concatenated and return in the order specified<a name="line.558"></a>
-<span class="sourceLineNo">559</span> * in the list.<a name="line.559"></a>
-<span class="sourceLineNo">560</span> * <p><a name="line.560"></a>
-<span class="sourceLineNo">561</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addStyleSheet(Object...)}/{@link RestConfig#addStyleSheet(Class, String)} methods.<a name="line.561"></a>
-<span class="sourceLineNo">562</span> */<a name="line.562"></a>
-<span class="sourceLineNo">563</span> String stylesheet() default "";<a name="line.563"></a>
-<span class="sourceLineNo">564</span><a name="line.564"></a>
-<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
-<span class="sourceLineNo">566</span> * The favicon to use for HTML views.<a name="line.566"></a>
-<span class="sourceLineNo">567</span> * <p><a name="line.567"></a>
-<span class="sourceLineNo">568</span> * The name is a path to an icon file located in either the classpath or working directory in a similar way<a name="line.568"></a>
-<span class="sourceLineNo">569</span> * to how the {@link #stylesheet()} stylesheet is resolved.<a name="line.569"></a>
-<span class="sourceLineNo">570</span> * The resulting favicon becomes available in the servlet via the URL <js>"[servletpath]/favicon.ico"</js>.<a name="line.570"></a>
-<span class="sourceLineNo">571</span> * <p><a name="line.571"></a>
-<span class="sourceLineNo">572</span> * If the file cannot be located, the request to <js>"[servletpath]/favicon.ico"</js> will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.572"></a>
-<span class="sourceLineNo">573</span> *<a name="line.573"></a>
-<span class="sourceLineNo">574</span> * <h5 class='section'>Example:</h5><a name="line.574"></a>
-<span class="sourceLineNo">575</span> * <p class='bcode'><a name="line.575"></a>
-<span class="sourceLineNo">576</span> * <jk>package</jk> com.foo.mypackage;<a name="line.576"></a>
-<span class="sourceLineNo">577</span> *<a name="line.577"></a>
-<span class="sourceLineNo">578</span> * <ja>@RestResource</ja>(<a name="line.578"></a>
-<span class="sourceLineNo">579</span> * favicon=<js>"mydocs/myicon.ico"</js><a name="line.579"></a>
-<span class="sourceLineNo">580</span> * )<a name="line.580"></a>
-<span class="sourceLineNo">581</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.581"></a>
-<span class="sourceLineNo">582</span> * }<a name="line.582"></a>
-<span class="sourceLineNo">583</span> * </p><a name="line.583"></a>
-<span class="sourceLineNo">584</span> * <p><a name="line.584"></a>
-<span class="sourceLineNo">585</span> * In this example, the servlet will attempt to find the <code>myicon.ico</code> file in the following ordered locations:<a name="line.585"></a>
-<span class="sourceLineNo">586</span> * </p><a name="line.586"></a>
-<span class="sourceLineNo">587</span> * <ol><a name="line.587"></a>
-<span class="sourceLineNo">588</span> * <li><code>com.foo.mypackage.mydocs</code> package.<a name="line.588"></a>
-<span class="sourceLineNo">589</span> * <li><code>org.apache.juneau.rest.mydocs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).<a name="line.589"></a>
-<span class="sourceLineNo">590</span> * <li><code>[working-dir]/mydocs</code> directory.<a name="line.590"></a>
-<span class="sourceLineNo">591</span> * </ol><a name="line.591"></a>
-<span class="sourceLineNo">592</span> * <p><a name="line.592"></a>
-<span class="sourceLineNo">593</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setFavIcon(Object)}/{@link RestConfig#setFavIcon(Class, String)} methods.<a name="line.593"></a>
-<span class="sourceLineNo">594</span> */<a name="line.594"></a>
-<span class="sourceLineNo">595</span> String favicon() default "";<a name="line.595"></a>
-<span class="sourceLineNo">596</span><a name="line.596"></a>
-<span class="sourceLineNo">597</span> /**<a name="line.597"></a>
-<span class="sourceLineNo">598</span> * Defines paths and locations of statically served files.<a name="line.598"></a>
-<span class="sourceLineNo">599</span> * <p><a name="line.599"></a>
-<span class="sourceLineNo">600</span> * This is a JSON map of paths to packages/directories located on either the classpath or working directory.<a name="line.600"></a>
-<span class="sourceLineNo">601</span> * <p><a name="line.601"></a>
-<span class="sourceLineNo">602</span> * Mappings are cumulative from parent to child. Child resources can override mappings made on parent resources.<a name="line.602"></a>
-<span class="sourceLineNo">603</span> * <p><a name="line.603"></a>
-<span class="sourceLineNo">604</span> * If the file cannot be located, the request will return {@link HttpServletResponse#SC_NOT_FOUND}.<a name="line.604"></a>
-<span class="sourceLineNo">605</span> *<a name="line.605"></a>
-<span class="sourceLineNo">606</span> * <h5 class='section'>Example:</h5><a name="line.606"></a>
-<span class="sourceLineNo">607</span> * <p class='bcode'><a name="line.607"></a>
-<span class="sourceLineNo">608</span> * <jk>package</jk> com.foo.mypackage;<a name="line.608"></a>
-<span class="sourceLineNo">609</span> *<a name="line.609"></a>
-<span class="sourceLineNo">610</span> * <ja>@RestResource</ja>(<a name="line.610"></a>
-<span class="sourceLineNo">611</span> * path=<js>"/myresource"</js>,<a name="line.611"></a>
-<span class="sourceLineNo">612</span> * staticFiles=<js>"{htdocs:'docs'}"</js><a name="line.612"></a>
-<span class="sourceLineNo">613</span> * )<a name="line.613"></a>
-<span class="sourceLineNo">614</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServletDefault {<a name="line.614"></a>
-<span class="sourceLineNo">615</span> * }<a name="line.615"></a>
-<span class="sourceLineNo">616</span> * </p><a name="line.616"></a>
-<span class="sourceLineNo">617</span> * <p><a name="line.617"></a>
-<span class="sourceLineNo">618</span> * In this example, given a GET request to <code>/myresource/htdocs/foobar.html</code>, the servlet will attempt to find the <code>foobar.html</code> file<a name="line.618"></a>
-<span class="sourceLineNo">619</span> * in the following ordered locations:<a name="line.619"></a>
-<span class="sourceLineNo">620</span> * </p><a name="line.620"></a>
-<span class="sourceLineNo">621</span> * <ol><a name="line.621"></a>
-<span class="sourceLineNo">622</span> * <li><code>com.foo.mypackage.docs</code> package.<a name="line.622"></a>
-<span class="sourceLineNo">623</span> * <li><code>org.apache.juneau.rest.docs</code> package (since <code>RestServletDefault</code> is in <code>org.apache.juneau.rest</code>).<a name="line.623"></a>
-<span class="sourceLineNo">624</span> * <li><code>[working-dir]/docs</code> directory.<a name="line.624"></a>
-<span class="sourceLineNo">625</span> * </ol><a name="line.625"></a>
-<span class="sourceLineNo">626</span> * <p><a name="line.626"></a>
-<span class="sourceLineNo">627</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.627"></a>
-<span class="sourceLineNo">628</span> */<a name="line.628"></a>
-<span class="sourceLineNo">629</span> String staticFiles() default "";<a name="line.629"></a>
-<span class="sourceLineNo">630</span><a name="line.630"></a>
-<span class="sourceLineNo">631</span> /**<a name="line.631"></a>
-<span class="sourceLineNo">632</span> * Specifies the HTTP header name used to identify the client version.<a name="line.632"></a>
-<span class="sourceLineNo">633</span> * <p><a name="line.633"></a>
-<span class="sourceLineNo">634</span> * The client version is used to support backwards compatibility for breaking REST interface<a name="line.634"></a>
-<span class="sourceLineNo">635</span> * changes. Used in conjunction with {@link RestMethod#clientVersion()} annotation.<a name="line.635"></a>
-<span class="sourceLineNo">636</span> * <p><a name="line.636"></a>
-<span class="sourceLineNo">637</span> * If not specified, uses <js>"X-Client-Version"</js>.<a name="line.637"></a>
-<span class="sourceLineNo">638</span> * <p><a name="line.638"></a>
-<span class="sourceLineNo">639</span> * The programmatic equivalent to this annotation is the {@link RestConfig#setClientVersionHeader(String)} method.<a name="line.639"></a>
-<span class="sourceLineNo">640</span> */<a name="line.640"></a>
-<span class="sourceLineNo">641</span> String clientVersionHeader() default "";<a name="line.641"></a>
-<span class="sourceLineNo">642</span><a name="line.642"></a>
-<span class="sourceLineNo">643</span> /**<a name="line.643"></a>
-<span class="sourceLineNo">644</span> * Specifies the resolver class to use for resolving child resources by class name.<a name="line.644"></a>
-<span class="sourceLineNo">645</span> * <p><a name="line.645"></a>
-<span class="sourceLineNo">646</span> * The default implementation simply instantiates the class using one of the following constructors:<a name="line.646"></a>
-<span class="sourceLineNo">647</span> * <ul><a name="line.647"></a>
-<span class="sourceLineNo">648</span> * <li><code><jk>public</jk> T(RestConfig)</code><a name="line.648"></a>
-<span class="sourceLineNo">649</span> * <li><code><jk>public</jk> T()</code><a name="line.649"></a>
-<span class="sourceLineNo">650</span> * </ul><a name="line.650"></a>
-<span class="sourceLineNo">651</span> * The former constructor can be used to get access to the {@link RestConfig} object to get access to the<a name="line.651"></a>
-<span class="sourceLineNo">652</span> * config file and initialization information or make programmatic modifications to the resource before<a name="line.652"></a>
-<span class="sourceLineNo">653</span> * full initialization.<a name="line.653"></a>
-<span class="sourceLineNo">654</span> * <p><a name="line.654"></a>
-<span class="sourceLineNo">655</span> * Non-<code>RestServlet</code> classes can also add the following two methods to get access to the<a name="line.655"></a>
-<span class="sourceLineNo">656</span> * {@link RestConfig} and {@link RestContext} objects:<a name="line.656"></a>
-<span class="sourceLineNo">657</span> * <ul><a name="line.657"></a>
-<span class="sourceLineNo">658</span> * <li><jk>public void</jk> init(RestConfig);</code><a name="line.658"></a>
-<span class="sourceLineNo">659</span> * <li><jk>public void</jk> init(RestContext);</code><a name="line.659"></a>
-<span class="sourceLineNo">660</span> * </ul><a name="line.660"></a>
-<span class="sourceLineNo">661</span> * <p><a name="line.661"></a>
-<span class="sourceLineNo">662</span> * Subclasses can be used to provide customized resolution of REST resource class instances.<a name="line.662"></a>
-<span class="sourceLineNo">663</span> * <p><a name="line.663"></a>
-<span class="sourceLineNo">664</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setResourceResolver(Class)}/{@link RestConfig#setResourceResolver(RestResourceResolver)} methods.<a name="line.664"></a>
-<span class="sourceLineNo">665</span> */<a name="line.665"></a>
-<span class="sourceLineNo">666</span> Class<? extends RestResourceResolver> resourceResolver() default RestResourceResolver.class;<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> * Specifies the logger class to use for logging.<a name="line.669"></a>
-<span class="sourceLineNo">670</span> * <p><a name="line.670"></a>
-<span class="sourceLineNo">671</span> * The default logger performs basic error logging to the Java logger.<a name="line.671"></a>
-<span class="sourceLineNo">672</span> * Subclasses can be used to customize logging behavior on the resource.<a name="line.672"></a>
-<span class="sourceLineNo">673</span> * <p><a name="line.673"></a>
-<span class="sourceLineNo">674</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.674"></a>
-<span class="sourceLineNo">675</span> */<a name="line.675"></a>
-<span class="sourceLineNo">676</span> Class<? extends RestLogger> logger() default RestLogger.Normal.class;<a name="line.676"></a>
-<span class="sourceLineNo">677</span><a name="line.677"></a>
-<span class="sourceLineNo">678</span> /**<a name="line.678"></a>
-<span class="sourceLineNo">679</span> * Specifies the REST call handler class.<a name="line.679"></a>
-<span class="sourceLineNo">680</span> * <p><a name="line.680"></a>
-<span class="sourceLineNo">681</span> * This class handles the basic lifecycle of an HTTP REST call.<a name="line.681"></a>
-<span class="sourceLineNo">682</span> * Subclasses can be used to customize how these HTTP calls are handled.<a name="line.682"></a>
-<span class="sourceLineNo">683</span> * <p><a name="line.683"></a>
-<span class="sourceLineNo">684</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.684"></a>
-<span class="sourceLineNo">685</span> */<a name="line.685"></a>
-<span class="sourceLineNo">686</span> Class<? extends RestCallHandler> callHandler() default RestCallHandler.class;<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> * Specifies the class used to retrieve title/description/swagger information about a resource.<a name="line.689"></a>
-<span class="sourceLineNo">690</span> * <p><a name="line.690"></a>
-<span class="sourceLineNo">691</span> * Subclasses can be used to customize the documentation on a resource.<a name="line.691"></a>
-<span class="sourceLineNo">692</span> * <p><a name="line.692"></a>
-<span class="sourceLineNo">693</span> * The programmatic equivalent to this annotation are the {@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.693"></a>
-<span class="sourceLineNo">694</span> */<a name="line.694"></a>
-<span class="sourceLineNo">695</span> Class<? extends RestInfoProvider> infoProvider() default RestInfoProvider.class;<a name="line.695"></a>
-<span class="sourceLineNo">696</span><a name="line.696"></a>
-<span class="sourceLineNo">697</span> /**<a name="line.697"></a>
-<span class="sourceLineNo">698</span> * TODO<a name="line.698"></a>
-<span class="sourceLineNo">699</span> */<a name="line.699"></a>
-<span class="sourceLineNo">700</span> String[] links() default "";<a name="line.700"></a>
-<span class="sourceLineNo">701</span>}<a name="line.701"></a>
+<span class="sourceLineNo">024</span>import org.apache.juneau.html.*;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.juneau.ini.*;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.juneau.jena.*;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.juneau.json.*;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.juneau.parser.*;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.juneau.rest.*;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.juneau.serializer.*;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.juneau.transform.*;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.juneau.utils.*;<a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.juneau.xml.*;<a name="line.33"></a>
+<span class="sourceLineNo">034</span><a name="line.34"></a>
+<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * Used to denote that a class is a REST resource and to associate metadata on it.<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * <p><a name="line.37"></a>
+<span class="sourceLineNo">038</span> * Usually used on a subclass of {@link RestServlet}, but can be used to annotate any class that you want to expose as a REST resource.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> *<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * Refer to <a class='doclink' href='../package-summary.html#TOC'>org.apache.juneau.rest</a> doc for information on using this class.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> */<a name="line.41"></a>
+<span class="sourceLineNo">042</span>@Documented<a name="line.42"></a>
+<span class="sourceLineNo">043</span>@Target(TYPE)<a name="line.43"></a>
+<span class="sourceLineNo">044</span>@Retention(RUNTIME)<a name="line.44"></a>
+<span class="sourceLineNo">045</span>@Inherited<a name="line.45"></a>
+<span class="sourceLineNo">046</span>public @interface RestResource {<a name="line.46"></a>
+<span class="sourceLineNo">047</span><a name="line.47"></a>
+<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * Identifies the location of the resource bundle for this class.<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * <p><a name="line.50"></a>
+<span class="sourceLineNo">051</span> * This annotation is used to provide localized messages for the following methods:<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * <ul><a name="line.52"></a>
+<span class="sourceLineNo">053</span> * <li>{@link RestRequest#getMessage(String, Object...)}<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * <li>{@link RestContext#getMessages()}<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * </ul><a name="line.55"></a>
+<span class="sourceLineNo">056</span> * <p><a name="line.56"></a>
+<span class="sourceLineNo">057</span> * Refer to the {@link MessageBundle} class for a description of the message key formats<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * used in the properties file.<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * <p><a name="line.59"></a>
+<span class="sourceLineNo">060</span> * The value can be a relative path like <js>"nls/Messages"</js>, indicating to look for the<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * resource bundle <js>"com.foo.sample.nls.Messages"</js> if the resource class<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * is in <js>"com.foo.sample"</js>, or it can be an absolute path, like <js>"com.foo.sample.nls.Messages"</js><a name="line.62"></a>
+<span class="sourceLineNo">063</span> */<a name="line.63"></a>
+<span class="sourceLineNo">064</span> String messages() default "";<a name="line.64"></a>
+<span class="sourceLineNo">065</span><a name="line.65"></a>
+<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * Class-level guards.<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * <p><a name="line.68"></a>
+<span class="sourceLineNo">069</span> * Associates one or more {@link RestGuard RestGuards} with all REST methods defined<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * in this class.<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * These guards get called immediately before execution of any REST method in this class.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * <p><a name="line.72"></a>
+<span class="sourceLineNo">073</span> * Typically, guards will be used for permissions checking on the user making the request,<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * but it can also be used for other purposes like pre-call validation of a request.<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * <p><a name="line.75"></a>
+<span class="sourceLineNo">076</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addGuards(Class...)}/{@link RestConfig#addGuards(RestGuard...)} methods.<a name="line.76"></a>
+<span class="sourceLineNo">077</span> */<a name="line.77"></a>
+<span class="sourceLineNo">078</span> Class<? extends RestGuard>[] guards() default {};<a name="line.78"></a>
+<span class="sourceLineNo">079</span><a name="line.79"></a>
+<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * Class-level converters.<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * <p><a name="line.82"></a>
+<span class="sourceLineNo">083</span> * Associates one or more {@link RestConverter converters} with a resource class.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * These converters get called immediately after execution of the REST method in the same<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * order specified in the annotation.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * <p><a name="line.86"></a>
+<span class="sourceLineNo">087</span> * Can be used for performing post-processing on the response object before serialization.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * <p><a name="line.88"></a>
+<span class="sourceLineNo">089</span> * Default converter implementations are provided in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * <p><a name="line.90"></a>
+<span class="sourceLineNo">091</span> * The programmatic equivalent to this annotation are the {@link RestConfig#addConverters(Class...)}/{@link RestConfig#addConverters(RestConverter...)} methods.<a name="line.91"></a>
+<span class="sourceLineNo">092</span> */<a name="line.92"></a>
+<span class="sourceLineNo">093</span> Class<? extends RestConverter>[] converters() default {};<a name="line.93"></a>
+<span class="sourceLineNo">094</span><a name="line.94"></a>
+<span class="sourceLineNo">095</span> /**<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * Class-level bean filters.<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * <p><a name="line.97"></a>
+<span class="sourceLineNo">098</span> * Shortcut to add bean filters to the bean contexts of the objects returned by the following methods:<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * <ul><a name="line.99"></a>
+<span class="sourceLineNo">100</span> * <li>{@link RestContext#getBeanContext()}<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * <li>{@link RestContext#getSerializers()}<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * <li>{@link RestContext#getParsers()}<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * </ul><a name="line.103"></a>
+<span class="sourceLineNo">104</span> * <p><a name="line.104"></a>
+<span class="sourceLineNo">105</span> * If the specified class is an instance of {@link BeanFilterBuilder}, then a filter built from that builder is added.<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * Any other classes are wrapped in a {@link InterfaceBeanFilterBuilder} to indicate that subclasses should<a name="line.106"></a>
+<span class="sourceLineNo">107</span> * be treated as the specified class type.<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * <p><a name="line.108"></a>
+<span class="sourceLineNo">109</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addBeanFilters(Class...)} method.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> */<a name="line.110"></a>
+<span class="sourceLineNo">111</span> Class<?>[] beanFilters() default {};<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> * Class-level POJO swaps.<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * <p><a name="line.115"></a>
+<span class="sourceLineNo">116</span> * Shortcut to add POJO swaps to the bean contexts of the objects returned by the following methods:<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * <ul><a name="line.117"></a>
+<span class="sourceLineNo">118</span> * <li>{@link RestContext#getBeanContext()}<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * <li>{@link RestContext#getSerializers()}<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * <li>{@link RestContext#getParsers()}<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * </ul><a name="line.121"></a>
+<span class="sourceLineNo">122</span> * <p><a name="line.122"></a>
+<span class="sourceLineNo">123</span> * If the specified class is an instance of {@link PojoSwap}, then that swap is added.<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * Any other classes are wrapped in a {@link SurrogateSwap}.<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * <p><a name="line.125"></a>
+<span class="sourceLineNo">126</span> * The programmatic equivalent to this annotation is the {@link RestConfig#addPojoSwaps(Class...)} method.<a name="line.126"></a>
+<span class="sourceLineNo">127</span> */<a name="line.127"></a>
+<span class="sourceLineNo">128</span> Class<?>[] pojoSwaps() default {};<a name="line.128"></a>
+<span class="sourceLineNo">129</span><a name="line.129"></a>
+<span class="sourceLineNo">130</span> /**<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * Class-level properties.<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * <p><a name="line.132"></a>
+<span class="sourceLineNo">133</span> * Shortcut for specifying class-level properties on this servlet to the objects returned by the following methods:<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * <ul><a name="line.134"></a>
+<span class="sourceLineNo">135</span> * <li>{@link RestContext#getBeanContext()}<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * <li>{@link RestContext#getSerializers()}<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * <li>{@link RestContext#getParsers()}<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * </ul><a name="line.138"></a>
+<span class="sourceLineNo">139</span> * <p><a name="line.139"></a>
+<span class="sourceLineNo">140</span> * Any of the following property names can be specified:<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * <ul><a name="line.141"></a>
+<span class="sourceLineNo">142</span> * <li>{@link RestContext}<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * <li>{@link BeanContext}<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * <li>{@link SerializerContext}<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * <li>{@link ParserContext}<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * <li>{@link JsonSerializerContext}<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * <li>{@link RdfSerializerContext}<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * <li>{@link RdfParserContext}<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * <li>{@link RdfCommonContext}<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * <li>{@link XmlSerializerContext}<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * <li>{@link XmlParserContext}<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * </ul><a name="line.152"></a>
+<span class="sourceLineNo">153</span> * <p><a name="line.153"></a>
+<span class="sourceLineNo">154</span> * Property values will be converted to the appropriate type.<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * <p><a name="line.155"></a>
+<span class="sourceLineNo">156</span> * In some cases, properties can be overridden at runtime through the {@link RestResponse#setProperty(String, Object)} method<a
<TRUNCATED>