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/03/27 01:21:21 UTC
[11/37] incubator-juneau-website git commit: Update javadocs
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/236aea45/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html
index 712580c..614eedb 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/rest/annotation/RestMethod.html
@@ -25,497 +25,511 @@
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.juneau.encoders.*;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.juneau.parser.*;<a name="line.21"></a>
-<span class="sourceLineNo">022</span>import org.apache.juneau.rest.*;<a name="line.22"></a>
-<span class="sourceLineNo">023</span>import org.apache.juneau.serializer.*;<a name="line.23"></a>
-<span class="sourceLineNo">024</span><a name="line.24"></a>
-<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
-<span class="sourceLineNo">026</span> * Identifies a REST Java method on a {@link RestServlet} implementation class.<a name="line.26"></a>
-<span class="sourceLineNo">027</span> * <p><a name="line.27"></a>
-<span class="sourceLineNo">028</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.28"></a>
-<span class="sourceLineNo">029</span> */<a name="line.29"></a>
-<span class="sourceLineNo">030</span>@Documented<a name="line.30"></a>
-<span class="sourceLineNo">031</span>@Target(METHOD)<a name="line.31"></a>
-<span class="sourceLineNo">032</span>@Retention(RUNTIME)<a name="line.32"></a>
-<span class="sourceLineNo">033</span>@Inherited<a name="line.33"></a>
-<span class="sourceLineNo">034</span>public @interface RestMethod {<a name="line.34"></a>
-<span class="sourceLineNo">035</span><a name="line.35"></a>
-<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
-<span class="sourceLineNo">037</span> * REST method name.<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * <p><a name="line.38"></a>
-<span class="sourceLineNo">039</span> * Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>.<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * <p><a name="line.40"></a>
-<span class="sourceLineNo">041</span> * Can also be a non-HTTP-standard name that is passed in through a <code>&amp;method=methodName</code> URL parameter.<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * <p><a name="line.42"></a>
-<span class="sourceLineNo">043</span> * Method names are case-insensitive (always folded to upper-case).<a name="line.43"></a>
-<span class="sourceLineNo">044</span> * <p><a name="line.44"></a>
-<span class="sourceLineNo">045</span> * If a method name is not specified, then the method name is determined based on the Java method name.<br><a name="line.45"></a>
-<span class="sourceLineNo">046</span> * For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>.<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> String name() default "";<a name="line.49"></a>
-<span class="sourceLineNo">050</span><a name="line.50"></a>
-<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
-<span class="sourceLineNo">052</span> * Optional path pattern for the specified method.<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * <p><a name="line.53"></a>
-<span class="sourceLineNo">054</span> * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br><a name="line.54"></a>
-<span class="sourceLineNo">055</span> * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur<a name="line.55"></a>
-<span class="sourceLineNo">056</span> * if the exact pattern is not found.<a name="line.56"></a>
-<span class="sourceLineNo">057</span> */<a name="line.57"></a>
-<span class="sourceLineNo">058</span> String path() default "/*";<a name="line.58"></a>
-<span class="sourceLineNo">059</span><a name="line.59"></a>
-<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * URL path pattern priority.<a name="line.61"></a>
-<span class="sourceLineNo">062</span> * <p><a name="line.62"></a>
-<span class="sourceLineNo">063</span> * To force path patterns to be checked before other path patterns, use a higher priority number.<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * <p><a name="line.64"></a>
-<span class="sourceLineNo">065</span> * By default, it's <code>0</code>, which means it will use an internal heuristic to<a name="line.65"></a>
-<span class="sourceLineNo">066</span> * determine a best match.<a name="line.66"></a>
-<span class="sourceLineNo">067</span> */<a name="line.67"></a>
-<span class="sourceLineNo">068</span> int priority() default 0;<a name="line.68"></a>
-<span class="sourceLineNo">069</span><a name="line.69"></a>
-<span class="sourceLineNo">070</span> /**<a name="line.70"></a>
-<span class="sourceLineNo">071</span> * Method guards.<a name="line.71"></a>
-<span class="sourceLineNo">072</span> * <p><a name="line.72"></a>
-<span class="sourceLineNo">073</span> * Associates one or more {@link RestGuard RestGuards} with a method call.<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * These guards get called immediately before execution of the REST method.<a name="line.74"></a>
-<span class="sourceLineNo">075</span> * <p><a name="line.75"></a>
-<span class="sourceLineNo">076</span> * Typically, guards will be used for permissions checking on the user making the request,<a name="line.76"></a>
-<span class="sourceLineNo">077</span> * but it can also be used for other purposes like pre-call validation of a request.<a name="line.77"></a>
-<span class="sourceLineNo">078</span> */<a name="line.78"></a>
-<span class="sourceLineNo">079</span> Class<? extends RestGuard>[] guards() default {};<a name="line.79"></a>
-<span class="sourceLineNo">080</span><a name="line.80"></a>
-<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * Method response converters.<a name="line.82"></a>
-<span class="sourceLineNo">083</span> * <p><a name="line.83"></a>
-<span class="sourceLineNo">084</span> * Associates one or more {@link RestConverter RestConverters} with a method call.<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * These converters get called immediately after execution of the REST method in the same<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * order specified in the annotation.<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * <p><a name="line.87"></a>
-<span class="sourceLineNo">088</span> * Can be used for performing post-processing on the response object before serialization.<a name="line.88"></a>
+<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.juneau.encoders.*;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.juneau.parser.*;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.juneau.rest.*;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.juneau.serializer.*;<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * Identifies a REST Java method on a {@link RestServlet} implementation class.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * <p><a name="line.28"></a>
+<span class="sourceLineNo">029</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.29"></a>
+<span class="sourceLineNo">030</span> */<a name="line.30"></a>
+<span class="sourceLineNo">031</span>@Documented<a name="line.31"></a>
+<span class="sourceLineNo">032</span>@Target(METHOD)<a name="line.32"></a>
+<span class="sourceLineNo">033</span>@Retention(RUNTIME)<a name="line.33"></a>
+<span class="sourceLineNo">034</span>@Inherited<a name="line.34"></a>
+<span class="sourceLineNo">035</span>public @interface RestMethod {<a name="line.35"></a>
+<span class="sourceLineNo">036</span><a name="line.36"></a>
+<span class="sourceLineNo">037</span> /**<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * REST method name.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * <p><a name="line.39"></a>
+<span class="sourceLineNo">040</span> * Typically <js>"GET"</js>, <js>"PUT"</js>, <js>"POST"</js>, <js>"DELETE"</js>, or <js>"OPTIONS"</js>.<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <p><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * Method names are case-insensitive (always folded to upper-case).<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <p><a name="line.43"></a>
+<span class="sourceLineNo">044</span> * Besides the standard HTTP method names, the following can also be specified:<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * <ul><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <li><js>"*"</js> - Denotes any method.<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * <br>Use this if you want to capture any HTTP methods in a single Java method.<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * <br>The {@link Method @Method} annotation and/or {@link RestRequest#getMethod()} method can be used<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * to distinguish the actual HTTP method name.<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * <li><js>""</js> - Auto-detect.<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * <br>The method name is determined based on the Java method name.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * <br>For example, if the method is <code>doPost(...)</code>, then the method name is automatically detected as <js>"POST"</js>.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * <li><js>"PROXY"</js> - Remote-proxy interface.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * <br>This denotes a Java method that returns an object (usually an interface, often annotated with the {@link Remoteable @Remoteable} annotation)<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * to be used as a remote proxy using <code>RestClient.getRemoteableProxy(Class<T> interfaceClass, String url)</code>.<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * <br>This allows you to construct client-side interface proxies using REST as a transport medium.<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * <br>Conceptually, this is simply a fancy <code>POST</code> against the url <js>"/{path}/{javaMethodName}"</js> where the arguments<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * are marshalled from the client to the server as an HTTP body containing an array of objects,<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * passed to the method as arguments, and then the resulting object is marshalled back to the client.<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * <li>Anything else - Overloaded non-HTTP-standard names that are passed in through a <code>&amp;method=methodName</code> URL parameter.<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * </ul><a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> String name() 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> * Optional path pattern for the specified method.<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * <p><a name="line.67"></a>
+<span class="sourceLineNo">068</span> * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<br><a name="line.68"></a>
+<span class="sourceLineNo">069</span> * Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * if the exact pattern is not found.<a name="line.70"></a>
+<span class="sourceLineNo">071</span> */<a name="line.71"></a>
+<span class="sourceLineNo">072</span> String path() default "/*";<a name="line.72"></a>
+<span class="sourceLineNo">073</span><a name="line.73"></a>
+<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * URL path pattern priority.<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * <p><a name="line.76"></a>
+<span class="sourceLineNo">077</span> * To force path patterns to be checked before other path patterns, use a higher priority number.<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * <p><a name="line.78"></a>
+<span class="sourceLineNo">079</span> * By default, it's <code>0</code>, which means it will use an internal heuristic to<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * determine a best match.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> */<a name="line.81"></a>
+<span class="sourceLineNo">082</span> int priority() default 0;<a name="line.82"></a>
+<span class="sourceLineNo">083</span><a name="line.83"></a>
+<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * Method guards.<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * <p><a name="line.86"></a>
+<span class="sourceLineNo">087</span> * Associates one or more {@link RestGuard RestGuards} with a method call.<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * These guards get called immediately before execution of the REST method.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * <p><a name="line.89"></a>
-<span class="sourceLineNo">090</span> * Default converters are available in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.<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> * Method matchers.<a name="line.95"></a>
-<span class="sourceLineNo">096</span> * <p><a name="line.96"></a>
-<span class="sourceLineNo">097</span> * Associates one more more {@link RestMatcher RestMatchers} with this method.<a name="line.97"></a>
-<span class="sourceLineNo">098</span> * <p><a name="line.98"></a>
-<span class="sourceLineNo">099</span> * Matchers are used to allow multiple Java methods to handle requests assigned to the same<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * URL path pattern, but differing based on some request attribute, such as a specific header value.<a name="line.100"></a>
+<span class="sourceLineNo">090</span> * Typically, guards will be used for permissions checking on the user making the request,<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * but it can also be used for other purposes like pre-call validation of a request.<a name="line.91"></a>
+<span class="sourceLineNo">092</span> */<a name="line.92"></a>
+<span class="sourceLineNo">093</span> Class<? extends RestGuard>[] guards() 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> * Method response converters.<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * <p><a name="line.97"></a>
+<span class="sourceLineNo">098</span> * Associates one or more {@link RestConverter RestConverters} with a method call.<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * These converters get called immediately after execution of the REST method in the same<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * order specified in the annotation.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * <p><a name="line.101"></a>
-<span class="sourceLineNo">102</span> * See {@link RestMatcher} for details.<a name="line.102"></a>
-<span class="sourceLineNo">103</span> */<a name="line.103"></a>
-<span class="sourceLineNo">104</span> Class<? extends RestMatcher>[] matchers() default {};<a name="line.104"></a>
-<span class="sourceLineNo">105</span><a name="line.105"></a>
-<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * Overrides the list of serializers assigned at the method level.<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * <p><a name="line.108"></a>
-<span class="sourceLineNo">109</span> * Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level.<a name="line.109"></a>
+<span class="sourceLineNo">102</span> * Can be used for performing post-processing on the response object before serialization.<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * <p><a name="line.103"></a>
+<span class="sourceLineNo">104</span> * Default converters are available in the <a class='doclink' href='../converters/package-summary.html#TOC'>org.apache.juneau.rest.converters</a> package.<a name="line.104"></a>
+<span class="sourceLineNo">105</span> */<a name="line.105"></a>
+<span class="sourceLineNo">106</span> Class<? extends RestConverter>[] converters() default {};<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span> /**<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * Method matchers.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * <p><a name="line.110"></a>
-<span class="sourceLineNo">111</span> * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.<a name="line.111"></a>
-<span class="sourceLineNo">112</span> *<a name="line.112"></a>
-<span class="sourceLineNo">113</span> * <p class='bcode'><a name="line.113"></a>
-<span class="sourceLineNo">114</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.114"></a>
-<span class="sourceLineNo">115</span> *<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * <ja>@RestMethod</ja>(<a name="line.116"></a>
-<span class="sourceLineNo">117</span> * name=<js>"GET"</js>,<a name="line.117"></a>
-<span class="sourceLineNo">118</span> * path=<js>"/foo"</js>,<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * serializers=MySpecialSerializer.<jk>class</jk>,<a name="line.119"></a>
-<span class="sourceLineNo">120</span> * serializersInherit=<jsf>SERIALIZERS</jsf><a name="line.120"></a>
-<span class="sourceLineNo">121</span> * )<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * <jk>public</jk> Object doGetWithSpecialAcceptType() {<a name="line.122"></a>
-<span class="sourceLineNo">123</span> * <jc>// Handle request for special Accept type</jc><a name="line.123"></a>
-<span class="sourceLineNo">124</span> * }<a name="line.124"></a>
-<span class="sourceLineNo">125</span> * }<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * </p><a name="line.126"></a>
-<span class="sourceLineNo">127</span> */<a name="line.127"></a>
-<span class="sourceLineNo">128</span> Class<? extends Serializer>[] serializers() 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> * Used in conjunction with {@link #serializers()} to identify what class-level settings are inherited by the method serializer group.<a name="line.131"></a>
-<span class="sourceLineNo">132</span> * <p><a name="line.132"></a>
-<span class="sourceLineNo">133</span> * Possible values:<a name="line.133"></a>
-<span class="sourceLineNo">134</span> * <ul><a name="line.134"></a>
-<span class="sourceLineNo">135</span> * <li>{@link Inherit#SERIALIZERS} - Inherit class-level serializers.<a name="line.135"></a>
-<span class="sourceLineNo">136</span> * <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.<a name="line.136"></a>
-<span class="sourceLineNo">137</span> * <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.<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> * For example, to inherit all serializers, properties, and transforms from the servlet class:<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * </p><a name="line.141"></a>
-<span class="sourceLineNo">142</span> * <p class='bcode'><a name="line.142"></a>
-<span class="sourceLineNo">143</span> * <ja>@RestMethod</ja>(<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * path=<js>"/foo"</js>,<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * serializers=MySpecialSerializer.<jk>class</jk>,<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * serializersInherit={<jsf>SERIALIZERS</jsf>,<jsf>PROPERTIES</jsf>,<jsf>TRANSFORMS</jsf>}<a name="line.146"></a>
-<span class="sourceLineNo">147</span> * )<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * </p><a name="line.148"></a>
-<span class="sourceLineNo">149</span> */<a name="line.149"></a>
-<span class="sourceLineNo">150</span> Inherit[] serializersInherit() default {};<a name="line.150"></a>
-<span class="sourceLineNo">151</span><a name="line.151"></a>
-<span class="sourceLineNo">152</span> /**<a name="line.152"></a>
-<span class="sourceLineNo">153</span> * Overrides the list of parsers assigned at the method level.<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * <p><a name="line.154"></a>
-<span class="sourceLineNo">155</span> * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level.<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * <p><a name="line.156"></a>
-<span class="sourceLineNo">157</span> * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.<a name="line.157"></a>
-<span class="sourceLineNo">158</span> *<a name="line.158"></a>
-<span class="sourceLineNo">159</span> * <p class='bcode'><a name="line.159"></a>
-<span class="sourceLineNo">160</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.160"></a>
-<span class="sourceLineNo">161</span> *<a name="line.161"></a>
-<span class="sourceLineNo">162</span> * <ja>@RestMethod</ja>(<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * name=<js>"PUT"</js>,<a name="line.163"></a>
-<span class="sourceLineNo">164</span> * path=<js>"/foo"</js>,<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * parsers=MySpecialParser.<jk>class</jk>,<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * parsersInherit=<jsf>PARSERS</jsf><a name="line.166"></a>
-<span class="sourceLineNo">167</span> * )<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * <jk>public</jk> Object doGetWithSpecialAcceptType() {<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * <jc>// Handle request for special Accept type</jc><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> * </p><a name="line.172"></a>
-<span class="sourceLineNo">173</span> */<a name="line.173"></a>
-<span class="sourceLineNo">174</span> Class<? extends Parser>[] parsers() default {};<a name="line.174"></a>
-<span class="sourceLineNo">175</span><a name="line.175"></a>
-<span class="sourceLineNo">176</span> /**<a name="line.176"></a>
-<span class="sourceLineNo">177</span> * Used in conjunction with {@link #parsers()} to identify what class-level settings are inherited by the method parser group.<a name="line.177"></a>
-<span class="sourceLineNo">178</span> * <p><a name="line.178"></a>
-<span class="sourceLineNo">179</span> * Possible values:<a name="line.179"></a>
-<span class="sourceLineNo">180</span> * <ul><a name="line.180"></a>
-<span class="sourceLineNo">181</span> * <li>{@link Inherit#PARSERS} - Inherit class-level parsers.<a name="line.181"></a>
-<span class="sourceLineNo">182</span> * <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.<a name="line.182"></a>
-<span class="sourceLineNo">183</span> * <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.<a name="line.183"></a>
-<span class="sourceLineNo">184</span> * </ul><a name="line.184"></a>
-<span class="sourceLineNo">185</span> * <p><a name="line.185"></a>
-<span class="sourceLineNo">186</span> * For example, to inherit all parsers, properties, and transforms from the servlet class:<a name="line.186"></a>
-<span class="sourceLineNo">187</span> * <p class='bcode'><a name="line.187"></a>
-<span class="sourceLineNo">188</span> * <ja>@RestMethod</ja>(<a name="line.188"></a>
-<span class="sourceLineNo">189</span> * path=<js>"/foo"</js>,<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * parsers=MySpecialParser.<jk>class</jk>,<a name="line.190"></a>
-<span class="sourceLineNo">191</span> * parsersInherit={<jsf>PARSERS</jsf>,<jsf>PROPERTIES</jsf>,<jsf>TRANSFORMS</jsf>}<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> */<a name="line.194"></a>
-<span class="sourceLineNo">195</span> Inherit[] parsersInherit() default {};<a name="line.195"></a>
-<span class="sourceLineNo">196</span><a name="line.196"></a>
-<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
-<span class="sourceLineNo">198</span> * Appends to the list of {@link Encoder encoders} specified on the servlet.<a name="line.198"></a>
+<span class="sourceLineNo">111</span> * Associates one more more {@link RestMatcher RestMatchers} with this method.<a name="line.111"></a>
+<span class="sourceLineNo">112</span> * <p><a name="line.112"></a>
+<span class="sourceLineNo">113</span> * Matchers are used to allow multiple Java methods to handle requests assigned to the same<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * URL path pattern, but differing based on some request attribute, such as a specific header value.<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * <p><a name="line.115"></a>
+<span class="sourceLineNo">116</span> * See {@link RestMatcher} for details.<a name="line.116"></a>
+<span class="sourceLineNo">117</span> */<a name="line.117"></a>
+<span class="sourceLineNo">118</span> Class<? extends RestMatcher>[] matchers() default {};<a name="line.118"></a>
+<span class="sourceLineNo">119</span><a name="line.119"></a>
+<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * Overrides the list of serializers assigned at the method level.<a name="line.121"></a>
+<span class="sourceLineNo">122</span> * <p><a name="line.122"></a>
+<span class="sourceLineNo">123</span> * Use this annotation when the list of serializers assigned to a method differs from the list of serializers assigned at the servlet level.<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * <p><a name="line.124"></a>
+<span class="sourceLineNo">125</span> * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> *<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * <p class='bcode'><a name="line.127"></a>
+<span class="sourceLineNo">128</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.128"></a>
+<span class="sourceLineNo">129</span> *<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * <ja>@RestMethod</ja>(<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * name=<js>"GET"</js>,<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * path=<js>"/foo"</js>,<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * serializers=MySpecialSerializer.<jk>class</jk>,<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * serializersInherit=<jsf>SERIALIZERS</jsf><a name="line.134"></a>
+<span class="sourceLineNo">135</span> * )<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * <jk>public</jk> Object doGetWithSpecialAcceptType() {<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * <jc>// Handle request for special Accept type</jc><a name="line.137"></a>
+<span class="sourceLineNo">138</span> * }<a name="line.138"></a>
+<span class="sourceLineNo">139</span> * }<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * </p><a name="line.140"></a>
+<span class="sourceLineNo">141</span> */<a name="line.141"></a>
+<span class="sourceLineNo">142</span> Class<? extends Serializer>[] serializers() default {};<a name="line.142"></a>
+<span class="sourceLineNo">143</span><a name="line.143"></a>
+<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * Used in conjunction with {@link #serializers()} to identify what class-level settings are inherited by the method serializer group.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * <p><a name="line.146"></a>
+<span class="sourceLineNo">147</span> * Possible values:<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * <ul><a name="line.148"></a>
+<span class="sourceLineNo">149</span> * <li>{@link Inherit#SERIALIZERS} - Inherit class-level serializers.<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.<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> * For example, to inherit all serializers, properties, and transforms from the servlet class:<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * </p><a name="line.155"></a>
+<span class="sourceLineNo">156</span> * <p class='bcode'><a name="line.156"></a>
+<span class="sourceLineNo">157</span> * <ja>@RestMethod</ja>(<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * path=<js>"/foo"</js>,<a name="line.158"></a>
+<span class="sourceLineNo">159</span> * serializers=MySpecialSerializer.<jk>class</jk>,<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * serializersInherit={<jsf>SERIALIZERS</jsf>,<jsf>PROPERTIES</jsf>,<jsf>TRANSFORMS</jsf>}<a name="line.160"></a>
+<span class="sourceLineNo">161</span> * )<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * </p><a name="line.162"></a>
+<span class="sourceLineNo">163</span> */<a name="line.163"></a>
+<span class="sourceLineNo">164</span> Inherit[] serializersInherit() default {};<a name="line.164"></a>
+<span class="sourceLineNo">165</span><a name="line.165"></a>
+<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * Overrides the list of parsers assigned at the method level.<a name="line.167"></a>
+<span class="sourceLineNo">168</span> * <p><a name="line.168"></a>
+<span class="sourceLineNo">169</span> * Use this annotation when the list of parsers assigned to a method differs from the list of parsers assigned at the servlet level.<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * <p><a name="line.170"></a>
+<span class="sourceLineNo">171</span> * To append to the list of serializers assigned at the servlet level, use <code>serializersInherit=<jsf>SERIALIZERS</jsf></code>.<a name="line.171"></a>
+<span class="sourceLineNo">172</span> *<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * <p class='bcode'><a name="line.173"></a>
+<span class="sourceLineNo">174</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.174"></a>
+<span class="sourceLineNo">175</span> *<a name="line.175"></a>
+<span class="sourceLineNo">176</span> * <ja>@RestMethod</ja>(<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * name=<js>"PUT"</js>,<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * path=<js>"/foo"</js>,<a name="line.178"></a>
+<span class="sourceLineNo">179</span> * parsers=MySpecialParser.<jk>class</jk>,<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * parsersInherit=<jsf>PARSERS</jsf><a name="line.180"></a>
+<span class="sourceLineNo">181</span> * )<a name="line.181"></a>
+<span class="sourceLineNo">182</span> * <jk>public</jk> Object doGetWithSpecialAcceptType() {<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * <jc>// Handle request for special Accept type</jc><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> * </p><a name="line.186"></a>
+<span class="sourceLineNo">187</span> */<a name="line.187"></a>
+<span class="sourceLineNo">188</span> Class<? extends Parser>[] parsers() default {};<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> * Used in conjunction with {@link #parsers()} to identify what class-level settings are inherited by the method parser group.<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * <p><a name="line.192"></a>
+<span class="sourceLineNo">193</span> * Possible values:<a name="line.193"></a>
+<span class="sourceLineNo">194</span> * <ul><a name="line.194"></a>
+<span class="sourceLineNo">195</span> * <li>{@link Inherit#PARSERS} - Inherit class-level parsers.<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * <li>{@link Inherit#PROPERTIES} - Inherit class-level properties.<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * <li>{@link Inherit#TRANSFORMS} - Inherit class-level transforms.<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * </ul><a name="line.198"></a>
<span class="sourceLineNo">199</span> * <p><a name="line.199"></a>
-<span class="sourceLineNo">200</span> * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level.<a name="line.200"></a>
-<span class="sourceLineNo">201</span> * <p><a name="line.201"></a>
-<span class="sourceLineNo">202</span> * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.<a name="line.202"></a>
-<span class="sourceLineNo">203</span> *<a name="line.203"></a>
-<span class="sourceLineNo">204</span> * <p class='bcode'><a name="line.204"></a>
-<span class="sourceLineNo">205</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.205"></a>
-<span class="sourceLineNo">206</span> *<a name="line.206"></a>
-<span class="sourceLineNo">207</span> * <ja>@RestMethod</ja>(<a name="line.207"></a>
-<span class="sourceLineNo">208</span> * name=<js>"PUT"</js>,<a name="line.208"></a>
-<span class="sourceLineNo">209</span> * path=<js>"/foo"</js>,<a name="line.209"></a>
-<span class="sourceLineNo">210</span> * encoders={GzipEncoder.<jk>class</jk>}<a name="line.210"></a>
-<span class="sourceLineNo">211</span> * )<a name="line.211"></a>
-<span class="sourceLineNo">212</span> * <jk>public</jk> Object doGetWithSpecialEncoding() {<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * <jc>// Handle request with special encoding</jc><a name="line.213"></a>
-<span class="sourceLineNo">214</span> * }<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * }<a name="line.215"></a>
-<span class="sourceLineNo">216</span> * </p><a name="line.216"></a>
-<span class="sourceLineNo">217</span> * <p><a name="line.217"></a>
-<span class="sourceLineNo">218</span> * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.<a name="line.218"></a>
-<span class="sourceLineNo">219</span> */<a name="line.219"></a>
-<span class="sourceLineNo">220</span> Class<? extends Encoder>[] encoders() default {};<a name="line.220"></a>
-<span class="sourceLineNo">221</span><a name="line.221"></a>
-<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * Specifies whether the method should inherit encoders from the servlet.<a name="line.223"></a>
-<span class="sourceLineNo">224</span> */<a name="line.224"></a>
-<span class="sourceLineNo">225</span> boolean inheritEncoders() default true;<a name="line.225"></a>
-<span class="sourceLineNo">226</span><a name="line.226"></a>
-<span class="sourceLineNo">227</span> /**<a name="line.227"></a>
-<span class="sourceLineNo">228</span> * Same as {@link RestResource#properties()}, except defines property values by default when this method is called.<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * <p><a name="line.229"></a>
-<span class="sourceLineNo">230</span> * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.<a name="line.230"></a>
-<span class="sourceLineNo">231</span> */<a name="line.231"></a>
-<span class="sourceLineNo">232</span> Property[] properties() default {};<a name="line.232"></a>
-<span class="sourceLineNo">233</span><a name="line.233"></a>
-<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
-<span class="sourceLineNo">235</span> * Appends the specified bean filters to all serializers and parsers used by this method.<a name="line.235"></a>
-<span class="sourceLineNo">236</span> */<a name="line.236"></a>
-<span class="sourceLineNo">237</span> Class<?>[] beanFilters() default {};<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> * Appends the specified POJO swaps to all serializers and parsers used by this method.<a name="line.240"></a>
-<span class="sourceLineNo">241</span> */<a name="line.241"></a>
-<span class="sourceLineNo">242</span> Class<?>[] pojoSwaps() default {};<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> * Specifies default values for request headers.<a name="line.245"></a>
-<span class="sourceLineNo">246</span> * <p><a name="line.246"></a>
-<span class="sourceLineNo">247</span> * Strings are of the format <js>"Header-Name: header-value"</js>.<a name="line.247"></a>
-<span class="sourceLineNo">248</span> * <p><a name="line.248"></a>
-<span class="sourceLineNo">249</span> * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.<a name="line.249"></a>
-<span class="sourceLineNo">250</span> * <p><a name="line.250"></a>
-<span class="sourceLineNo">251</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.251"></a>
-<span class="sourceLineNo">252</span> * so that a particular default {@link Serializer} is picked.<a name="line.252"></a>
-<span class="sourceLineNo">253</span> * <p><a name="line.253"></a>
-<span class="sourceLineNo">254</span> * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).<a name="line.254"></a>
-<span class="sourceLineNo">255</span> * <p><a name="line.255"></a>
-<span class="sourceLineNo">256</span> * Header values specified at the method level override header values specified at the servlet level.<a name="line.256"></a>
-<span class="sourceLineNo">257</span> *<a name="line.257"></a>
-<span class="sourceLineNo">258</span> * <h5 class='section'>Example:</h5><a name="line.258"></a>
-<span class="sourceLineNo">259</span> * <p class='bcode'><a name="line.259"></a>
-<span class="sourceLineNo">260</span> * <jc>// Assume "text/json" Accept value when Accept not specified</jc><a name="line.260"></a>
-<span class="sourceLineNo">261</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/*"</js>, defaultRequestHeaders={<js>"Accept: text/json"</js>})<a name="line.261"></a>
-<span class="sourceLineNo">262</span> * <jk>public</jk> String doGet() {<a name="line.262"></a>
-<span class="sourceLineNo">263</span> * ...<a name="line.263"></a>
-<span class="sourceLineNo">264</span> * }<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * </p><a name="line.265"></a>
-<span class="sourceLineNo">266</span> */<a name="line.266"></a>
-<span class="sourceLineNo">267</span> String[] defaultRequestHeaders() default {};<a name="line.267"></a>
-<span class="sourceLineNo">268</span><a name="line.268"></a>
-<span class="sourceLineNo">269</span> /**<a name="line.269"></a>
-<span class="sourceLineNo">270</span> * Optional summary for the exposed API.<a name="line.270"></a>
-<span class="sourceLineNo">271</span> * <p><a name="line.271"></a>
-<span class="sourceLineNo">272</span> * This summary is used in the following locations:<a name="line.272"></a>
-<span class="sourceLineNo">273</span> * <ul class='spaced-list'><a name="line.273"></a>
-<span class="sourceLineNo">274</span> * <li>The value returned by {@link RestRequest#getMethodSummary()}.<a name="line.274"></a>
-<span class="sourceLineNo">275</span> * <li>The <js>"$R{methodSummary}"</js> variable.<a name="line.275"></a>
-<span class="sourceLineNo">276</span> * <li>The summary of the method in the Swagger page.<a name="line.276"></a>
-<span class="sourceLineNo">277</span> * </ul><a name="line.277"></a>
-<span class="sourceLineNo">278</span> * <p><a name="line.278"></a>
-<span class="sourceLineNo">279</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the servlet resource bundle.<a name="line.279"></a>
-<span class="sourceLineNo">280</span> * (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>).<a name="line.280"></a>
-<span class="sourceLineNo">281</span> * <p><a name="line.281"></a>
-<span class="sourceLineNo">282</span> * This field value can contain variables (e.g. "$L{my.localized.variable}").<a name="line.282"></a>
-<span class="sourceLineNo">283</span> * <p><a name="line.283"></a>
-<span class="sourceLineNo">284</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.<a name="line.284"></a>
-<span class="sourceLineNo">285</span> */<a name="line.285"></a>
-<span class="sourceLineNo">286</span> String summary() default "";<a name="line.286"></a>
-<span class="sourceLineNo">287</span><a name="line.287"></a>
-<span class="sourceLineNo">288</span> /**<a name="line.288"></a>
-<span class="sourceLineNo">289</span> * Optional description for the exposed API.<a name="line.289"></a>
-<span class="sourceLineNo">290</span> * <p><a name="line.290"></a>
-<span class="sourceLineNo">291</span> * This description is used in the following locations:<a name="line.291"></a>
-<span class="sourceLineNo">292</span> * <ul class='spaced-list'><a name="line.292"></a>
-<span class="sourceLineNo">293</span> * <li>The value returned by {@link RestRequest#getMethodDescription()}.<a name="line.293"></a>
-<span class="sourceLineNo">294</span> * <li>The <js>"$R{methodDescription}"</js> variable.<a name="line.294"></a>
-<span class="sourceLineNo">295</span> * <li>The description of the method in the Swagger page.<a name="line.295"></a>
-<span class="sourceLineNo">296</span> * </ul><a name="line.296"></a>
+<span class="sourceLineNo">200</span> * For example, to inherit all parsers, properties, and transforms from the servlet class:<a name="line.200"></a>
+<span class="sourceLineNo">201</span> * <p class='bcode'><a name="line.201"></a>
+<span class="sourceLineNo">202</span> * <ja>@RestMethod</ja>(<a name="line.202"></a>
+<span class="sourceLineNo">203</span> * path=<js>"/foo"</js>,<a name="line.203"></a>
+<span class="sourceLineNo">204</span> * parsers=MySpecialParser.<jk>class</jk>,<a name="line.204"></a>
+<span class="sourceLineNo">205</span> * parsersInherit={<jsf>PARSERS</jsf>,<jsf>PROPERTIES</jsf>,<jsf>TRANSFORMS</jsf>}<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * )<a name="line.206"></a>
+<span class="sourceLineNo">207</span> * </p><a name="line.207"></a>
+<span class="sourceLineNo">208</span> */<a name="line.208"></a>
+<span class="sourceLineNo">209</span> Inherit[] parsersInherit() 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> * Appends to the list of {@link Encoder encoders} specified on the servlet.<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * <p><a name="line.213"></a>
+<span class="sourceLineNo">214</span> * Use this annotation when the list of encoders assigned to a method differs from the list of encoders assigned at the servlet level.<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * <p><a name="line.215"></a>
+<span class="sourceLineNo">216</span> * These can be used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.<a name="line.216"></a>
+<span class="sourceLineNo">217</span> *<a name="line.217"></a>
+<span class="sourceLineNo">218</span> * <p class='bcode'><a name="line.218"></a>
+<span class="sourceLineNo">219</span> * <jk>public class</jk> MyResource <jk>extends</jk> RestServlet {<a name="line.219"></a>
+<span class="sourceLineNo">220</span> *<a name="line.220"></a>
+<span class="sourceLineNo">221</span> * <ja>@RestMethod</ja>(<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * name=<js>"PUT"</js>,<a name="line.222"></a>
+<span class="sourceLineNo">223</span> * path=<js>"/foo"</js>,<a name="line.223"></a>
+<span class="sourceLineNo">224</span> * encoders={GzipEncoder.<jk>class</jk>}<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * )<a name="line.225"></a>
+<span class="sourceLineNo">226</span> * <jk>public</jk> Object doGetWithSpecialEncoding() {<a name="line.226"></a>
+<span class="sourceLineNo">227</span> * <jc>// Handle request with special encoding</jc><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> * If you want to OVERRIDE the set of encoders specified by the servlet, combine this annotation with <code><ja>@RestMethod</ja>(inheritEncoders=<jk>false</jk>)</code>.<a name="line.232"></a>
+<span class="sourceLineNo">233</span> */<a name="line.233"></a>
+<span class="sourceLineNo">234</span> Class<? extends Encoder>[] encoders() 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 whether the method should inherit encoders from the servlet.<a name="line.237"></a>
+<span class="sourceLineNo">238</span> */<a name="line.238"></a>
+<span class="sourceLineNo">239</span> boolean inheritEncoders() default true;<a name="line.239"></a>
+<span class="sourceLineNo">240</span><a name="line.240"></a>
+<span class="sourceLineNo">241</span> /**<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * Same as {@link RestResource#properties()}, except defines property values by default when this method is called.<a name="line.242"></a>
+<span class="sourceLineNo">243</span> * <p><a name="line.243"></a>
+<span class="sourceLineNo">244</span> * This is equivalent to simply calling <code>res.addProperties()</code> in the Java method, but is provided for convenience.<a name="line.244"></a>
+<span class="sourceLineNo">245</span> */<a name="line.245"></a>
+<span class="sourceLineNo">246</span> Property[] properties() default {};<a name="line.246"></a>
+<span class="sourceLineNo">247</span><a name="line.247"></a>
+<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
+<span class="sourceLineNo">249</span> * Appends the specified bean filters to all serializers and parsers used by this method.<a name="line.249"></a>
+<span class="sourceLineNo">250</span> */<a name="line.250"></a>
+<span class="sourceLineNo">251</span> Class<?>[] beanFilters() default {};<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> * Appends the specified POJO swaps to all serializers and parsers used by this method.<a name="line.254"></a>
+<span class="sourceLineNo">255</span> */<a name="line.255"></a>
+<span class="sourceLineNo">256</span> Class<?>[] pojoSwaps() default {};<a name="line.256"></a>
+<span class="sourceLineNo">257</span><a name="line.257"></a>
+<span class="sourceLineNo">258</span> /**<a name="line.258"></a>
+<span class="sourceLineNo">259</span> * Specifies default values for request headers.<a name="line.259"></a>
+<span class="sourceLineNo">260</span> * <p><a name="line.260"></a>
+<span class="sourceLineNo">261</span> * Strings are of the format <js>"Header-Name: header-value"</js>.<a name="line.261"></a>
+<span class="sourceLineNo">262</span> * <p><a name="line.262"></a>
+<span class="sourceLineNo">263</span> * Affects values returned by {@link RestRequest#getHeader(String)} when the header is not present on the request.<a name="line.263"></a>
+<span class="sourceLineNo">264</span> * <p><a name="line.264"></a>
+<span class="sourceLineNo">265</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.265"></a>
+<span class="sourceLineNo">266</span> * so that a particular default {@link Serializer} is picked.<a name="line.266"></a>
+<span class="sourceLineNo">267</span> * <p><a name="line.267"></a>
+<span class="sourceLineNo">268</span> * Only one header value can be specified per entry (i.e. it's not a delimited list of header entries).<a name="line.268"></a>
+<span class="sourceLineNo">269</span> * <p><a name="line.269"></a>
+<span class="sourceLineNo">270</span> * Header values specified at the method level override header values specified at the servlet level.<a name="line.270"></a>
+<span class="sourceLineNo">271</span> *<a name="line.271"></a>
+<span class="sourceLineNo">272</span> * <h5 class='section'>Example:</h5><a name="line.272"></a>
+<span class="sourceLineNo">273</span> * <p class='bcode'><a name="line.273"></a>
+<span class="sourceLineNo">274</span> * <jc>// Assume "text/json" Accept value when Accept not specified</jc><a name="line.274"></a>
+<span class="sourceLineNo">275</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/*"</js>, defaultRequestHeaders={<js>"Accept: text/json"</js>})<a name="line.275"></a>
+<span class="sourceLineNo">276</span> * <jk>public</jk> String doGet() {<a name="line.276"></a>
+<span class="sourceLineNo">277</span> * ...<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> */<a name="line.280"></a>
+<span class="sourceLineNo">281</span> String[] defaultRequestHeaders() default {};<a name="line.281"></a>
+<span class="sourceLineNo">282</span><a name="line.282"></a>
+<span class="sourceLineNo">283</span> /**<a name="line.283"></a>
+<span class="sourceLineNo">284</span> * Optional summary for the exposed API.<a name="line.284"></a>
+<span class="sourceLineNo">285</span> * <p><a name="line.285"></a>
+<span class="sourceLineNo">286</span> * This summary is used in the following locations:<a name="line.286"></a>
+<span class="sourceLineNo">287</span> * <ul class='spaced-list'><a name="line.287"></a>
+<span class="sourceLineNo">288</span> * <li>The value returned by {@link RestRequest#getMethodSummary()}.<a name="line.288"></a>
+<span class="sourceLineNo">289</span> * <li>The <js>"$R{methodSummary}"</js> variable.<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * <li>The summary of the method in the Swagger page.<a name="line.290"></a>
+<span class="sourceLineNo">291</span> * </ul><a name="line.291"></a>
+<span class="sourceLineNo">292</span> * <p><a name="line.292"></a>
+<span class="sourceLineNo">293</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].summary</code> entry in the servlet resource bundle.<a name="line.293"></a>
+<span class="sourceLineNo">294</span> * (e.g. <js>"MyClass.myMethod.summary = foo"</js> or <js>"myMethod.summary = foo"</js>).<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * <p><a name="line.295"></a>
+<span class="sourceLineNo">296</span> * This field value can contain variables (e.g. "$L{my.localized.variable}").<a name="line.296"></a>
<span class="sourceLineNo">297</span> * <p><a name="line.297"></a>
-<span class="sourceLineNo">298</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in the servlet resource bundle.<a name="line.298"></a>
-<span class="sourceLineNo">299</span> * (e.g. <js>"MyClass.myMethod.description = foo"</js> or <js>"myMethod.description = foo"</js>).<a name="line.299"></a>
-<span class="sourceLineNo">300</span> * <p><a name="line.300"></a>
-<span class="sourceLineNo">301</span> * This field value can contain variables (e.g. "$L{my.localized.variable}").<a name="line.301"></a>
-<span class="sourceLineNo">302</span> * <p><a name="line.302"></a>
-<span class="sourceLineNo">303</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/description</code>.<a name="line.303"></a>
-<span class="sourceLineNo">304</span> */<a name="line.304"></a>
-<span class="sourceLineNo">305</span> String description() default "";<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> * Optional external documentation information for the exposed API.<a name="line.308"></a>
-<span class="sourceLineNo">309</span> * <p><a name="line.309"></a>
-<span class="sourceLineNo">310</span> * Used to populate the Swagger external documentation field.<a name="line.310"></a>
+<span class="sourceLineNo">298</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/summary</code>.<a name="line.298"></a>
+<span class="sourceLineNo">299</span> */<a name="line.299"></a>
+<span class="sourceLineNo">300</span> String summary() 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> * Optional description for the exposed API.<a name="line.303"></a>
+<span class="sourceLineNo">304</span> * <p><a name="line.304"></a>
+<span class="sourceLineNo">305</span> * This description is used in the following locations:<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * <ul class='spaced-list'><a name="line.306"></a>
+<span class="sourceLineNo">307</span> * <li>The value returned by {@link RestRequest#getMethodDescription()}.<a name="line.307"></a>
+<span class="sourceLineNo">308</span> * <li>The <js>"$R{methodDescription}"</js> variable.<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * <li>The description of the method in the Swagger page.<a name="line.309"></a>
+<span class="sourceLineNo">310</span> * </ul><a name="line.310"></a>
<span class="sourceLineNo">311</span> * <p><a name="line.311"></a>
-<span class="sourceLineNo">312</span> * A simplified JSON string with the following fields:<a name="line.312"></a>
-<span class="sourceLineNo">313</span> * <p class='bcode'><a name="line.313"></a>
-<span class="sourceLineNo">314</span> * {<a name="line.314"></a>
-<span class="sourceLineNo">315</span> * description: string,<a name="line.315"></a>
-<span class="sourceLineNo">316</span> * url: string<a name="line.316"></a>
-<span class="sourceLineNo">317</span> * }<a name="line.317"></a>
-<span class="sourceLineNo">318</span> * </p><a name="line.318"></a>
-<span class="sourceLineNo">319</span> * <p><a name="line.319"></a>
-<span class="sourceLineNo">320</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle.<a name="line.320"></a>
-<span class="sourceLineNo">321</span> * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.321"></a>
-<span class="sourceLineNo">322</span> *<a name="line.322"></a>
-<span class="sourceLineNo">323</span> * <h5 class='section'>Example:</h5><a name="line.323"></a>
-<span class="sourceLineNo">324</span> * <p class='bcode'><a name="line.324"></a>
-<span class="sourceLineNo">325</span> * <ja>@RestMethod</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>)<a name="line.325"></a>
-<span class="sourceLineNo">326</span> * </p><a name="line.326"></a>
-<span class="sourceLineNo">327</span> * <p><a name="line.327"></a>
-<span class="sourceLineNo">328</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * <p><a name="line.329"></a>
-<span class="sourceLineNo">330</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.<a name="line.330"></a>
-<span class="sourceLineNo">331</span> */<a name="line.331"></a>
-<span class="sourceLineNo">332</span> String externalDocs() default "";<a name="line.332"></a>
-<span class="sourceLineNo">333</span><a name="line.333"></a>
-<span class="sourceLineNo">334</span> /**<a name="line.334"></a>
-<span class="sourceLineNo">335</span> * Optional tagging information for the exposed API.<a name="line.335"></a>
-<span class="sourceLineNo">336</span> * <p><a name="line.336"></a>
-<span class="sourceLineNo">337</span> * Used to populate the Swagger tags field.<a name="line.337"></a>
-<span class="sourceLineNo">338</span> * <p><a name="line.338"></a>
-<span class="sourceLineNo">339</span> * A comma-delimited list of tags for API documentation control.<a name="line.339"></a>
-<span class="sourceLineNo">340</span> * Tags can be used for logical grouping of operations by resources or any other qualifier.<a name="line.340"></a>
+<span class="sourceLineNo">312</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].description</code> entry in the servlet resource bundle.<a name="line.312"></a>
+<span class="sourceLineNo">313</span> * (e.g. <js>"MyClass.myMethod.description = foo"</js> or <js>"myMethod.description = foo"</js>).<a name="line.313"></a>
+<span class="sourceLineNo">314</span> * <p><a name="line.314"></a>
+<span class="sourceLineNo">315</span> * This field value can contain variables (e.g. "$L{my.localized.variable}").<a name="line.315"></a>
+<span class="sourceLineNo">316</span> * <p><a name="line.316"></a>
+<span class="sourceLineNo">317</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/description</code>.<a name="line.317"></a>
+<span class="sourceLineNo">318</span> */<a name="line.318"></a>
+<span class="sourceLineNo">319</span> String description() default "";<a name="line.319"></a>
+<span class="sourceLineNo">320</span><a name="line.320"></a>
+<span class="sourceLineNo">321</span> /**<a name="line.321"></a>
+<span class="sourceLineNo">322</span> * Optional external documentation information for the exposed API.<a name="line.322"></a>
+<span class="sourceLineNo">323</span> * <p><a name="line.323"></a>
+<span class="sourceLineNo">324</span> * Used to populate the Swagger external documentation field.<a name="line.324"></a>
+<span class="sourceLineNo">325</span> * <p><a name="line.325"></a>
+<span class="sourceLineNo">326</span> * A simplified JSON string with the following fields:<a name="line.326"></a>
+<span class="sourceLineNo">327</span> * <p class='bcode'><a name="line.327"></a>
+<span class="sourceLineNo">328</span> * {<a name="line.328"></a>
+<span class="sourceLineNo">329</span> * description: string,<a name="line.329"></a>
+<span class="sourceLineNo">330</span> * url: string<a name="line.330"></a>
+<span class="sourceLineNo">331</span> * }<a name="line.331"></a>
+<span class="sourceLineNo">332</span> * </p><a name="line.332"></a>
+<span class="sourceLineNo">333</span> * <p><a name="line.333"></a>
+<span class="sourceLineNo">334</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].externalDocs</code> entry in the servlet resource bundle.<a name="line.334"></a>
+<span class="sourceLineNo">335</span> * (e.g. <js>"MyClass.myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js> or <js>"myMethod.externalDocs = {url:'http://juneau.apache.org'}"</js>).<a name="line.335"></a>
+<span class="sourceLineNo">336</span> *<a name="line.336"></a>
+<span class="sourceLineNo">337</span> * <h5 class='section'>Example:</h5><a name="line.337"></a>
+<span class="sourceLineNo">338</span> * <p class='bcode'><a name="line.338"></a>
+<span class="sourceLineNo">339</span> * <ja>@RestMethod</ja>(externalDocs=<js>"{url:'http://juneau.apache.org'}"</js>)<a name="line.339"></a>
+<span class="sourceLineNo">340</span> * </p><a name="line.340"></a>
<span class="sourceLineNo">341</span> * <p><a name="line.341"></a>
-<span class="sourceLineNo">342</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle.<a name="line.342"></a>
-<span class="sourceLineNo">343</span> * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).<a name="line.343"></a>
-<span class="sourceLineNo">344</span> *<a name="line.344"></a>
-<span class="sourceLineNo">345</span> * <h5 class='section'>Example:</h5><a name="line.345"></a>
-<span class="sourceLineNo">346</span> * <p class='bcode'><a name="line.346"></a>
-<span class="sourceLineNo">347</span> * <ja>@RestMethod</ja>(tags=<js>"foo,bar"</js>)<a name="line.347"></a>
-<span class="sourceLineNo">348</span> * </p><a name="line.348"></a>
-<span class="sourceLineNo">349</span> * <p><a name="line.349"></a>
-<span class="sourceLineNo">350</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.350"></a>
-<span class="sourceLineNo">351</span> * <p><a name="line.351"></a>
-<span class="sourceLineNo">352</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.<a name="line.352"></a>
-<span class="sourceLineNo">353</span> */<a name="line.353"></a>
-<span class="sourceLineNo">354</span> String tags() default "";<a name="line.354"></a>
-<span class="sourceLineNo">355</span><a name="line.355"></a>
-<span class="sourceLineNo">356</span> /**<a name="line.356"></a>
-<span class="sourceLineNo">357</span> * Optional deprecated flag for the exposed API.<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * <p><a name="line.358"></a>
-<span class="sourceLineNo">359</span> * Used to populate the Swagger deprecated field.<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * <p><a name="line.360"></a>
-<span class="sourceLineNo">361</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle.<a name="line.361"></a>
-<span class="sourceLineNo">362</span> * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).<a name="line.362"></a>
-<span class="sourceLineNo">363</span> *<a name="line.363"></a>
-<span class="sourceLineNo">364</span> * <h5 class='section'>Example:</h5><a name="line.364"></a>
-<span class="sourceLineNo">365</span> * <p class='bcode'><a name="line.365"></a>
-<span class="sourceLineNo">366</span> * <ja>@RestMethod</ja>(deprecated=<jk>true</jk>)<a name="line.366"></a>
-<span class="sourceLineNo">367</span> * </p><a name="line.367"></a>
-<span class="sourceLineNo">368</span> * <p><a name="line.368"></a>
-<span class="sourceLineNo">369</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.369"></a>
-<span class="sourceLineNo">370</span> * <p><a name="line.370"></a>
-<span class="sourceLineNo">371</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.<a name="line.371"></a>
-<span class="sourceLineNo">372</span> */<a name="line.372"></a>
-<span class="sourceLineNo">373</span> boolean deprecated() default false;<a name="line.373"></a>
-<span class="sourceLineNo">374</span><a name="line.374"></a>
-<span class="sourceLineNo">375</span> /**<a name="line.375"></a>
-<span class="sourceLineNo">376</span> * Optional parameter descriptions.<a name="line.376"></a>
-<span class="sourceLineNo">377</span> * <p><a name="line.377"></a>
-<span class="sourceLineNo">378</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column<a name="line.378"></a>
-<span class="sourceLineNo">379</span> * on the Swagger page.<a name="line.379"></a>
-<span class="sourceLineNo">380</span> *<a name="line.380"></a>
-<span class="sourceLineNo">381</span> * <h5 class='section'>Example:</h5><a name="line.381"></a>
-<span class="sourceLineNo">382</span> * <p class='bcode'><a name="line.382"></a>
-<span class="sourceLineNo">383</span> * <ja>@RestMethod</ja>(<a name="line.383"></a>
-<span class="sourceLineNo">384</span> * name=<js>"POST"</js>, path=<js>"/{a}"</js>,<a name="line.384"></a>
-<span class="sourceLineNo">385</span> * description=<js>"This is my method."</js>,<a name="line.385"></a>
-<span class="sourceLineNo">386</span> * parameters={<a name="line.386"></a>
-<span class="sourceLineNo">387</span> * <ja>@Parameter</ja>(in=<js>"path"</js>, name=<js>"a"</js>, description=<js>"The 'a' attribute"</js>),<a name="line.387"></a>
-<span class="sourceLineNo">388</span> * <ja>@Parameter</ja>(in=<js>"query"</js>, name=<js>"b"</js>, description=<js>"The 'b' parameter"</js>, required=<jk>true</jk>),<a name="line.388"></a>
-<span class="sourceLineNo">389</span> * <ja>@Parameter</ja>(in=<js>"body"</js>, description=<js>"The HTTP content"</js>),<a name="line.389"></a>
-<span class="sourceLineNo">390</span> * <ja>@Parameter</ja>(in=<js>"header"</js>, name=<js>"D"</js>, description=<js>"The 'D' header"</js>),<a name="line.390"></a>
-<span class="sourceLineNo">391</span> * }<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> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case<a name="line.394"></a>
-<span class="sourceLineNo">395</span> * the strings are internationalized.<a name="line.395"></a>
+<span class="sourceLineNo">342</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.342"></a>
+<span class="sourceLineNo">343</span> * <p><a name="line.343"></a>
+<span class="sourceLineNo">344</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/externalDocs</code>.<a name="line.344"></a>
+<span class="sourceLineNo">345</span> */<a name="line.345"></a>
+<span class="sourceLineNo">346</span> String externalDocs() default "";<a name="line.346"></a>
+<span class="sourceLineNo">347</span><a name="line.347"></a>
+<span class="sourceLineNo">348</span> /**<a name="line.348"></a>
+<span class="sourceLineNo">349</span> * Optional tagging information for the exposed API.<a name="line.349"></a>
+<span class="sourceLineNo">350</span> * <p><a name="line.350"></a>
+<span class="sourceLineNo">351</span> * Used to populate the Swagger tags field.<a name="line.351"></a>
+<span class="sourceLineNo">352</span> * <p><a name="line.352"></a>
+<span class="sourceLineNo">353</span> * A comma-delimited list of tags for API documentation control.<a name="line.353"></a>
+<span class="sourceLineNo">354</span> * Tags can be used for logical grouping of operations by resources or any other qualifier.<a name="line.354"></a>
+<span class="sourceLineNo">355</span> * <p><a name="line.355"></a>
+<span class="sourceLineNo">356</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].tags</code> entry in the servlet resource bundle.<a name="line.356"></a>
+<span class="sourceLineNo">357</span> * (e.g. <js>"MyClass.myMethod.tags = foo,bar"</js> or <js>"myMethod.tags = foo,bar"</js>).<a name="line.357"></a>
+<span class="sourceLineNo">358</span> *<a name="line.358"></a>
+<span class="sourceLineNo">359</span> * <h5 class='section'>Example:</h5><a name="line.359"></a>
+<span class="sourceLineNo">360</span> * <p class='bcode'><a name="line.360"></a>
+<span class="sourceLineNo">361</span> * <ja>@RestMethod</ja>(tags=<js>"foo,bar"</js>)<a name="line.361"></a>
+<span class="sourceLineNo">362</span> * </p><a name="line.362"></a>
+<span class="sourceLineNo">363</span> * <p><a name="line.363"></a>
+<span class="sourceLineNo">364</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.364"></a>
+<span class="sourceLineNo">365</span> * <p><a name="line.365"></a>
+<span class="sourceLineNo">366</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/tags</code>.<a name="line.366"></a>
+<span class="sourceLineNo">367</span> */<a name="line.367"></a>
+<span class="sourceLineNo">368</span> String tags() default "";<a name="line.368"></a>
+<span class="sourceLineNo">369</span><a name="line.369"></a>
+<span class="sourceLineNo">370</span> /**<a name="line.370"></a>
+<span class="sourceLineNo">371</span> * Optional deprecated flag for the exposed API.<a name="line.371"></a>
+<span class="sourceLineNo">372</span> * <p><a name="line.372"></a>
+<span class="sourceLineNo">373</span> * Used to populate the Swagger deprecated field.<a name="line.373"></a>
+<span class="sourceLineNo">374</span> * <p><a name="line.374"></a>
+<span class="sourceLineNo">375</span> * The default value pulls the description from the <code>(className.?)[javaMethodName].deprecated</code> entry in the servlet resource bundle.<a name="line.375"></a>
+<span class="sourceLineNo">376</span> * (e.g. <js>"MyClass.myMethod.deprecated = true"</js> or <js>"myMethod.deprecated = foo,bar"</js>).<a name="line.376"></a>
+<span class="sourceLineNo">377</span> *<a name="line.377"></a>
+<span class="sourceLineNo">378</span> * <h5 class='section'>Example:</h5><a name="line.378"></a>
+<span class="sourceLineNo">379</span> * <p class='bcode'><a name="line.379"></a>
+<span class="sourceLineNo">380</span> * <ja>@RestMethod</ja>(deprecated=<jk>true</jk>)<a name="line.380"></a>
+<span class="sourceLineNo">381</span> * </p><a name="line.381"></a>
+<span class="sourceLineNo">382</span> * <p><a name="line.382"></a>
+<span class="sourceLineNo">383</span> * This field can contain variables (e.g. "$L{my.localized.variable}").<a name="line.383"></a>
+<span class="sourceLineNo">384</span> * <p><a name="line.384"></a>
+<span class="sourceLineNo">385</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/deprecated</code>.<a name="line.385"></a>
+<span class="sourceLineNo">386</span> */<a name="line.386"></a>
+<span class="sourceLineNo">387</span> boolean deprecated() default false;<a name="line.387"></a>
+<span class="sourceLineNo">388</span><a name="line.388"></a>
+<span class="sourceLineNo">389</span> /**<a name="line.389"></a>
+<span class="sourceLineNo">390</span> * Optional parameter descriptions.<a name="line.390"></a>
+<span class="sourceLineNo">391</span> * <p><a name="line.391"></a>
+<span class="sourceLineNo">392</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"parameters"</js> column<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * on the Swagger page.<a name="line.393"></a>
+<span class="sourceLineNo">394</span> *<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * <h5 class='section'>Example:</h5><a name="line.395"></a>
<span class="sourceLineNo">396</span> * <p class='bcode'><a name="line.396"></a>
-<span class="sourceLineNo">397</span> * <jk>MyClass.myMethod.description</jk> = <js>This is my method.</js><a name="line.397"></a>
-<span class="sourceLineNo">398</span> * <jk>MyClass.myMethod.req.path.a.description</jk> = <js>The 'a' attribute</js><a name="line.398"></a>
-<span class="sourceLineNo">399</span> * <jk>MyClass.myMethod.req.query.b.description</jk> = <js>The 'b' parameter</js><a name="line.399"></a>
-<span class="sourceLineNo">400</span> * <jk>MyClass.myMethod.req.body.description</jk> = <js>The HTTP content</js><a name="line.400"></a>
-<span class="sourceLineNo">401</span> * <jk>MyClass.myMethod.req.header.d.description</jk> = <js>The 'D' header</js><a name="line.401"></a>
-<span class="sourceLineNo">402</span> * <p><a name="line.402"></a>
-<span class="sourceLineNo">403</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),<a name="line.403"></a>
-<span class="sourceLineNo">404</span> * and use resource bundles if you need to support localization.<a name="line.404"></a>
-<span class="sourceLineNo">405</span> * <p><a name="line.405"></a>
-<span class="sourceLineNo">406</span> * These annotations can contain variables (e.g. "$L{my.localized.variable}").<a name="line.406"></a>
-<span class="sourceLineNo">407</span> * <p><a name="line.407"></a>
-<span class="sourceLineNo">408</span> * Corresponds to the swagger field <code>/paths/{path}/{method}/parameters</code>.<a name="line.408"></a>
-<span class="sourceLineNo">409</span> */<a name="line.409"></a>
-<span class="sourceLineNo">410</span> Parameter[] parameters() default {};<a name="line.410"></a>
-<span class="sourceLineNo">411</span><a name="line.411"></a>
-<span class="sourceLineNo">412</span> /**<a name="line.412"></a>
-<span class="sourceLineNo">413</span> * Optional output description.<a name="line.413"></a>
-<span class="sourceLineNo">414</span> * <p><a name="line.414"></a>
-<span class="sourceLineNo">415</span> * This annotation is provided for documentation purposes and is used to populate the method <js>"responses"</js> column<a name="line.415"></a>
-<span class="sourceLineNo">416</span> * on the Swagger page.<a name="line.416"></a>
-<span class="sourceLineNo">417</span> *<a name="line.417"></a>
-<span class="sourceLineNo">418</span> * <h5 class='section'>Example:</h5><a name="line.418"></a>
-<span class="sourceLineNo">419</span> * <p class='bcode'><a name="line.419"></a>
-<span class="sourceLineNo">420</span> * <ja>@RestMethod</ja>(<a name="line.420"></a>
-<span class="sourceLineNo">421</span> * name=<js>"GET"</js>, path=<js>"/"</js>,<a name="line.421"></a>
-<span class="sourceLineNo">422</span> * responses={<a name="line.422"></a>
-<span class="sourceLineNo">423</span> * <ja>@Response</ja>(200),<a name="line.423"></a>
-<span class="sourceLineNo">424</span> * <ja>@Response</ja>(<a name="line.424"></a>
-<span class="sourceLineNo">425</span> * value=302,<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * description=<js>"Thing wasn't found here"</js>,<a name="line.426"></a>
-<span class="sourceLineNo">427</span> * headers={<a name="line.427"></a>
-<span class="sourceLineNo">428</span> * <ja>@Parameter</ja>(name=<js>"Location"</js>, description=<js>"The place to find the thing"</js>)<a name="line.428"></a>
-<span class="sourceLineNo">429</span> * }<a name="line.429"></a>
-<span class="sourceLineNo">430</span> * )<a name="line.430"></a>
-<span class="sourceLineNo">431</span> * }<a name="line.431"></a>
-<span class="sourceLineNo">432</span> * )<a name="line.432"></a>
-<span class="sourceLineNo">433</span> * </p><a name="line.433"></a>
-<span class="sourceLineNo">434</span> * This is functionally equivalent to specifying the following keys in the resource bundle for the class, except in this case<a name="line.434"></a>
-<span class="sourceLineNo">435</span> * the strings are internationalized.<a name="line.435"></a>
-<span class="sourceLineNo">436</span> * <p class='bcode'><a name="line.436"></a>
-<span class="sourceLineNo">437</span> * <jk>MyClass.myMethod.res.200.description</jk> = <js>OK</js><a name="line.437"></a>
-<span class="sourceLineNo">438</span> * <jk>MyClass.myMethod.res.302.description</jk> = <js>Thing wasn't found here</js><a name="line.438"></a>
-<span class="sourceLineNo">439</span> * <jk>MyClass.myMethod.res.302.header.Location.description</jk> = <js>The place to find the thing</js><a name="line.439"></a>
-<span class="sourceLineNo">440</span> * <p><a name="line.440"></a>
-<span class="sourceLineNo">441</span> * As a general rule, use annotations when you don't care about internationalization (i.e. you only want to support English),<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * and use resource bundles if you need to support localization.<a name="line.442"></a>
-<span class="sourceLineNo">443</span> * <p><a name="line.443"></a>
-<span class="sourceLineNo">444</span> * These annotations can contain variables (e.g. "$L{my.localized.variable}").<a name="line.444"></a>
-<span class="sourceLineNo">445</span> */<a name="line.445"></a>
-<span class="sourceLineNo">446</span> Response[] responses() default {};<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> * Specifies whether this method can be called based on the client version.<a name="line.449"></a>
-<span class="sourceLineNo">450</span> * <p><a name="line.450"></a>
-<span class="sourceLineNo">451</span> * The client version is identified via the HTTP request header identified by {@link RestResource#clientVersionHeader()} which<a name="line.451"></a>
-<span class="sourceLineNo">452</span> * by default is <js>"X-Client-Version"</js>.<a name="line.452"></a>
-<span class="sourceLineNo">453</span> * <p><a name="line.453"></a>
-<span class="sourceLineNo">454</span> * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same method/path based<a name="line.454"></a>
-<span class="sourceLineNo">455</span> * on the client version.<a name="line.455"></a>
-<span class="sourceLineNo">456</span> * <p><a name="line.456"></a>
-<span class="sourceLineNo">457</span> * The format of the client version range is similar to that of OSGi versions.<a name="line.457"></a>
-<span class="sourceLineNo">458</span> * <p><a name="line.458"></a>
-<span class="sourceLineNo">459</span> * In the following example, the Java methods are mapped to the same HTTP method and URL <js>"/foobar"</js>.<a name="line.459"></a>
-<span class="sourceLineNo">460</span> * <p class='bcode'><a name="line.460"></a>
-<span class="sourceLineNo">461</span> * <jc>// Call this method if X-Client-Version is at least 2.0.<a name="line.461"></a>
-<span class="sourceLineNo">462</span> * // Note that this also matches 2.0.1.</jc><a name="line.462"></a>
-<span class="sourceLineNo">463</span> * <ja>@RestMethod</ja>(name=<js>"GET"</js>, path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)<a name="line.463"></a>
-<span class="sourceLineNo">464</span> * <jk>public</jk> Object method1() {<a name="line.464"></a>
-<span class="sourceLineNo">465</span> * ...<a name="line.465"></a>
-<span class="sourceLineNo">466</span> * }<a name="
<TRUNCATED>