| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.rest.annotation;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> |
| <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>import java.nio.charset.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.annotation.*;<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.rest.converter.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.juneau.rest.guard.*;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.rest.httppart.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.rest.matcher.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.juneau.rest.servlet.*;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.juneau.rest.swagger.*;<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.dto.swagger.*;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.juneau.encoders.*;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.juneau.http.header.*;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.juneau.parser.*;<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> * Identifies a REST PUT operation Java method on a {@link RestServlet} implementation class.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * This is a specialized subtype of <c><ja>{@link RestOp @RestOp}(method=<jsf>PUT</jsf>)</c>.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <ul class='seealso'><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li class='link'>{@doc jrs.RestOpAnnotatedMethods}<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li class='extlink'>{@source}<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * </ul><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>@Target(METHOD)<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>@Retention(RUNTIME)<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>@Inherited<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>@ContextApply(RestPutAnnotation.RestOpContextApply.class)<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@AnnotationGroup(RestOp.class)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public @interface RestPut {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Specifies whether this method can be called based on the client version.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * The client version is identified via the HTTP request header identified by<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * {@link Rest#clientVersionHeader() @Rest(clientVersionHeader)} which by default is <js>"Client-Version"</js>.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * This is a specialized kind of {@link RestMatcher} that allows you to invoke different Java methods for the same<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * method/path based on the client version.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <p><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * The format of the client version range is similar to that of OSGi versions.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> *<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <p><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * In the following example, the Java methods are mapped to the same HTTP method and URL <js>"/foobar"</js>.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p class='bjava'><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <jc>// Call this method if Client-Version is at least 2.0.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * // Note that this also matches 2.0.1.</jc><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <ja>@RestPut</ja>(path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <jk>public</jk> Object method1() {...}<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <jc>// Call this method if Client-Version is at least 1.1, but less than 2.0.</jc><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <ja>@RestPut</ja>(path=<js>"/foobar"</js>, clientVersion=<js>"[1.1,2.0)"</js>)<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <jk>public</jk> Object method2() {...}<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <jc>// Call this method if Client-Version is less than 1.1.</jc><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <ja>@RestPut</ja>(path=<js>"/foobar"</js>, clientVersion=<js>"[0,1.1)"</js>)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <jk>public</jk> Object method3() {...}<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * </p><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> *<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <p><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * It's common to combine the client version with transforms that will convert new POJOs into older POJOs for<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * backwards compatibility.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p class='bjava'><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <jc>// Call this method if Client-Version is at least 2.0.</jc><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <ja>@RestPut</ja>(path=<js>"/foobar"</js>, clientVersion=<js>"2.0"</js>)<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <jk>public</jk> NewPojo newMethod() {...}<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * <jc>// Call this method if X-Client-Version is at least 1.1, but less than 2.0.</jc><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <ja>@RestPut</ja>(path=<js>"/foobar"</js>, clientVersion=<js>"[1.1,2.0)"</js>)<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <ja>@BeanConfig</ja>(swaps=NewToOldSwap.<jk>class</jk>)<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * <jk>public</jk> NewPojo oldMethod() {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * <jk>return</jk> newMethod();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> *<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * <p><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Note that in the previous example, we're returning the exact same POJO, but using a transform to convert it into<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * an older form.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * The old method could also just return back a completely different object.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * The range can be any of the following:<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <ul><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <li><js>"[0,1.0)"</js> = Less than 1.0. 1.0 and 1.0.0 does not match.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <li><js>"[0,1.0]"</js> = Less than or equal to 1.0. Note that 1.0.1 will match.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <li><js>"1.0"</js> = At least 1.0. 1.0 and 2.0 will match.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * </ul><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <ul class='seealso'><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#clientVersionHeader(String)}<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * </ul><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @return The annotation value.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> String clientVersion() default "";<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * Supported content media types.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> *<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <p><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Overrides the media types inferred from the parsers that identify what media types can be consumed by the resource.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> *<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <ul class='notes'><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <li class='note'><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Supports {@doc jrs.SvlVariables}<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * </ul><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <ul class='seealso'><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#consumes(MediaType...)}<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * </ul><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> *<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return The annotation value.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> String[] consumes() default {};<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> /**<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * Allows you to extend the {@link RestOpContext} class to modify how any of the methods are implemented.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> *<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <ul class='seealso'><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#type(Class)}<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * </ul><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return The annotation value.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> Class<? extends RestOpContext> contextClass() default RestOpContext.Void.class;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /**<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * Class-level response converters.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> *<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * <p><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Associates one or more {@link RestConverter converters} with this method.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * <ul class='seealso'><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#converters()} - Registering converters with REST resources.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * </ul><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> *<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @return The annotation value.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> Class<? extends RestConverter>[] converters() default {};<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> /**<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * Enable debug mode.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> *<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * <p><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Enables the following:<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * <ul class='spaced-list'><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * <li><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * HTTP request/response bodies are cached in memory for logging purposes.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * <li><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * Request/response messages are automatically logged.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * </ul><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> *<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * <ul class='values'><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * <li><js>"true"</js> - Debug is enabled for all requests.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * <li><js>"false"</js> - Debug is disabled for all requests.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <li><js>"conditional"</js> - Debug is enabled only for requests that have a <c class='snippet'>Debug: true</c> header.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * <li><js>""</js> (or anything else) - Debug mode is inherited from class.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * </ul><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> *<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * <ul class='notes'><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * <li class='note'><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * Supports {@doc jrs.SvlVariables}<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * </ul><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> *<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <ul class='seealso'><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#debugEnablement()}<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * </ul><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> *<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return The annotation value.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> */<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> String debug() default "";<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * Default <c>Accept</c> header.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> *<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * <p><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * The default value for the <c>Accept</c> header if not specified on a request.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> *<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * <p><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * This is a shortcut for using {@link #defaultRequestHeaders()} for just this specific header.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> *<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * @return The annotation value.<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> */<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> String defaultAccept() default "";<a name="line.207"></a> |
| <span class="sourceLineNo">208</span><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> /**<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * Default character encoding.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> *<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * <p><a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * The default character encoding for the request and response if not specified on the request.<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> *<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * <ul class='notes'><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * <li class='note'><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Supports {@doc jrs.SvlVariables}<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * </ul><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> *<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * <ul class='seealso'><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#defaultCharset(Charset)}<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#defaultCharset(Charset)}<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * <li class='ja'>{@link Rest#defaultCharset}<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * </ul><a name="line.225"></a> |
| <span class="sourceLineNo">226</span> *<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * @return The annotation value.<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> */<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> String defaultCharset() default "";<a name="line.229"></a> |
| <span class="sourceLineNo">230</span><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> /**<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * Default <c>Content-Type</c> header.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> *<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * <p><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * The default value for the <c>Content-Type</c> header if not specified on a request.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> *<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <p><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * This is a shortcut for using {@link #defaultRequestHeaders()} for just this specific header.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> *<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * @return The annotation value.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> */<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> String defaultContentType() 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 form-data parameters.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> *<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * <p><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * Strings are of the format <js>"name=value"</js>.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> *<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * <p><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * Affects values returned by {@link RestRequest#getFormParam(String)} when the parameter is not present on the<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * request.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> *<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * <h5 class='section'>Example:</h5><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * <p class='bjava'><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <ja>@RestPut</ja>(path=<js>"/*"</js>, defaultRequestFormData={<js>"foo=bar"</js>})<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * <jk>public</jk> String doPut(<ja>@FormData</ja>(<js>"foo"</js>) String <jv>foo</jv>) {...}<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * </p><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> *<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * <ul class='notes'><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * <li class='note'><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * You can use either <js>':'</js> or <js>'='</js> as the key/value delimiter.<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * <li class='note'><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Key and value is trimmed of whitespace.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * <li class='note'><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * Supports {@doc jrs.SvlVariables}<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * </ul><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> *<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * @return The annotation value.<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> */<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> String[] defaultRequestFormData() default {};<a name="line.272"></a> |
| <span class="sourceLineNo">273</span><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> /**<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * Specifies default values for query parameters.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> *<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * <p><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * Strings are of the format <js>"name=value"</js>.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> *<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * <p><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * Affects values returned by {@link RestRequest#getQueryParam(String)} when the parameter is not present on the request.<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * <h5 class='section'>Example:</h5><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * <p class='bjava'><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * <ja>@RestPut</ja>(path=<js>"/*"</js>, defaultRequestQueryData={<js>"foo=bar"</js>})<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * <jk>public</jk> String doPut(<ja>@Query</ja>(<js>"foo"</js>) String <jv>foo</jv>) {...}<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * </p><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> *<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * <ul class='notes'><a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * <li class='note'><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * You can use either <js>':'</js> or <js>'='</js> as the key/value delimiter.<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * <li class='note'><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * Key and value is trimmed of whitespace.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * <li class='note'><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * Supports {@doc jrs.SvlVariables}<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * </ul><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> *<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @return The annotation value.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> */<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> String[] defaultRequestQueryData() default {};<a name="line.301"></a> |
| <span class="sourceLineNo">302</span><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> /**<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * Default request attributes.<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> *<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * <p><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * Specifies default values for request attributes if they're not already set on the request.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> *<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * <p><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * Affects values returned by the following methods:<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * <ul><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * <li class='jm'>{@link RestRequest#getAttribute(String)}.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * <li class='jm'>{@link RestRequest#getAttributes()}.<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * </ul><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> *<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * <h5 class='section'>Example:</h5><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * <p class='bjava'><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * <jc>// Defined via annotation resolving to a config file setting with default value.</jc><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * <ja>@Rest</ja>(defaultRequestAttributes={<js>"Foo=bar"</js>, <js>"Baz: $C{REST/myAttributeValue}"</js>})<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * <jk>public class</jk> MyResource {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> *<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * <jc>// Override at the method level.</jc><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * <ja>@RestGet</ja>(defaultRequestAttributes={<js>"Foo: bar"</js>})<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <jk>public</jk> Object myMethod() {...}<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * </p><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> *<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * </ul><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * <ul class='notes'><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * <li class='note'><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * Supports {@doc jrs.SvlVariables}<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * </ul><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> *<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * <ul class='seealso'><a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#defaultRequestAttributes(NamedAttribute...)}<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * <li class='ja'>{@link Rest#defaultRequestAttributes()}<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * </ul><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> *<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @return The annotation value.<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> */<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> String[] defaultRequestAttributes() default {};<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> /**<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * Default request headers.<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> *<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * <p><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * Specifies default values for request headers if they're not passed in through the request.<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> *<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * <h5 class='section'>Example:</h5><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * <p class='bjava'><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * <jc>// Assume "text/json" Accept value when Accept not specified</jc><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * <ja>@RestPut</ja>(path=<js>"/*"</js>, defaultRequestHeaders={<js>"Accept: text/json"</js>})<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * <jk>public</jk> String doPut() {...}<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * </p><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> *<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * <ul class='notes'><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * <li class='note'><a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * Supports {@doc jrs.SvlVariables}<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * </ul><a name="line.361"></a> |
| <span class="sourceLineNo">362</span> *<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * <ul class='seealso'><a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#defaultRequestHeaders(org.apache.http.Header...)}<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * </ul><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> *<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * @return The annotation value.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> */<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> String[] defaultRequestHeaders() default {};<a name="line.369"></a> |
| <span class="sourceLineNo">370</span><a name="line.370"></a> |
| <span class="sourceLineNo">371</span> /**<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * Default response headers.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> *<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * <p><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * Specifies default values for response headers if they're not overwritten during the request.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> *<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * <h5 class='section'>Example:</h5><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * <p class='bjava'><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <jc>// Assume "text/json" Accept value when Accept not specified</jc><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * <ja>@RestPut</ja>(path=<js>"/*"</js>, defaultResponseHeaders={<js>"Content-Type: text/json"</js>})<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * <jk>public</jk> String doPut() {...}<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * </p><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> *<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * <ul class='notes'><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * <li class='note'><a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * Supports {@doc jrs.SvlVariables}<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * </ul><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> *<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * <ul class='seealso'><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#defaultResponseHeaders(org.apache.http.Header...)}<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * </ul><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> *<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * @return The annotation value.<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> */<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> String[] defaultResponseHeaders() default {};<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> /**<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * Optional description for the exposed API.<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> *<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * <p><a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * This description is used in the following locations:<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * <ul class='spaced-list'><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * <li><a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * The value returned by {@link Operation#getDescription()} in the auto-generated swagger.<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> * <li><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * The <js>"$RS{operationDescription}"</js> variable.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * <li><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * The description of the method in the Swagger page.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * </ul><a name="line.410"></a> |
| <span class="sourceLineNo">411</span> *<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * <ul class='notes'><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * <li class='note'><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * Corresponds to the swagger field <c>/paths/{path}/{method}/description</c>.<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * <li class='note'><a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * Supports {@doc jrs.SvlVariables}<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * </ul><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> *<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> * @return The annotation value.<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> */<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> String[] description() 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> * Specifies the compression encoders for this method.<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> *<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * <p><a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * Encoders are used to enable various kinds of compression (e.g. <js>"gzip"</js>) on requests and responses.<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> *<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * <p><a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * This value overrides encoders specified at the class level using {@link Rest#encoders()}.<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * The {@link org.apache.juneau.encoders.EncoderSet.Inherit} class can be used to include values from the parent class.<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> *<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> * <h5 class='section'>Example:</h5><a name="line.434"></a> |
| <span class="sourceLineNo">435</span> * <p class='bjava'><a name="line.435"></a> |
| <span class="sourceLineNo">436</span> * <jc>// Define a REST resource that handles GZIP compression.</jc><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * <ja>@Rest</ja>(<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * encoders={<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * GzipEncoder.<jk>class</jk><a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * }<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> * )<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * <jk>public class</jk> MyResource {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> *<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * <jc>// Define a REST method that can also use a custom encoder.</jc><a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * <ja>@RestPut</ja>(<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * encoders={<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * EncoderSet.Inherit.<jk>class</jk>, MyEncoder.<jk>class</jk><a name="line.447"></a> |
| <span class="sourceLineNo">448</span> * }<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> * )<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * <jk>public void</jk> doPut(MyBean <jv>bean</jv>) {<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * ...<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> * }<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> * }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> * </p><a name="line.454"></a> |
| <span class="sourceLineNo">455</span> *<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> * <p><a name="line.456"></a> |
| <span class="sourceLineNo">457</span> * The programmatic equivalent to this annotation is:<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * <p class='bjava'><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * RestOpContext.Builder <jv>builder</jv> = RestOpContext.<jsm>create</jsm>(<jv>method</jv>,<jv>restContext</jv>);<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * <jv>builder</jv>.getEncoders().set(<jv>classes</jv>);<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * </p><a name="line.461"></a> |
| <span class="sourceLineNo">462</span> *<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * <ul class='seealso'><a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * <li class='link'>{@doc jrs.Encoders}<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> * </ul><a name="line.465"></a> |
| <span class="sourceLineNo">466</span> *<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @return The annotation value.<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> */<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> Class<? extends Encoder>[] encoders() default {};<a name="line.469"></a> |
| <span class="sourceLineNo">470</span><a name="line.470"></a> |
| <span class="sourceLineNo">471</span> /**<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> * Method-level guards.<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> *<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> * <p><a name="line.474"></a> |
| <span class="sourceLineNo">475</span> * Associates one or more {@link RestGuard RestGuards} with this method.<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> *<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * <ul class='seealso'><a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#guards()}<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * </ul><a name="line.479"></a> |
| <span class="sourceLineNo">480</span> *<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @return The annotation value.<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> Class<? extends RestGuard>[] guards() default {};<a name="line.483"></a> |
| <span class="sourceLineNo">484</span><a name="line.484"></a> |
| <span class="sourceLineNo">485</span> /**<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> * Method matchers.<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> *<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * <p><a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * Associates one more more {@link RestMatcher RestMatchers} with this method.<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> *<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * <p><a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * Matchers are used to allow multiple Java methods to handle requests assigned to the same URL path pattern, but<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> * differing based on some request attribute, such as a specific header value.<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> *<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> * <ul class='seealso'><a name="line.495"></a> |
| <span class="sourceLineNo">496</span> * <li class='jac'>{@link RestMatcher}<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> * </ul><a name="line.497"></a> |
| <span class="sourceLineNo">498</span> *<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> * @return The annotation value.<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> */<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> Class<? extends RestMatcher>[] matchers() default {};<a name="line.501"></a> |
| <span class="sourceLineNo">502</span><a name="line.502"></a> |
| <span class="sourceLineNo">503</span> /**<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> * The maximum allowed input size (in bytes) on HTTP requests.<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> *<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * <p><a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * Useful for alleviating DoS attacks by throwing an exception when too much input is received instead of resulting<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * in out-of-memory errors which could affect system stability.<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> *<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * <h5 class='section'>Example:</h5><a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * <p class='bjava'><a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * <ja>@RestPut</ja>(<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * maxInput=<js>"100M"</js><a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * )<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * </p><a name="line.515"></a> |
| <span class="sourceLineNo">516</span> *<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * <ul class='notes'><a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * <li class='note'><a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * Supports {@doc jrs.SvlVariables}<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * </ul><a name="line.521"></a> |
| <span class="sourceLineNo">522</span> *<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * <ul class='seealso'><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#maxInput(String)}<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#maxInput(String)}<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * <li class='ja'>{@link Rest#maxInput}<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * </ul><a name="line.527"></a> |
| <span class="sourceLineNo">528</span> *<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * @return The annotation value.<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> */<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> String maxInput() default "";<a name="line.531"></a> |
| <span class="sourceLineNo">532</span><a name="line.532"></a> |
| <span class="sourceLineNo">533</span> /**<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * Dynamically apply this annotation to the specified methods.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> *<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * <ul class='seealso'><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * <li class='link'>{@doc jm.DynamicallyAppliedAnnotations}<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * </ul><a name="line.538"></a> |
| <span class="sourceLineNo">539</span> *<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * @return The annotation value.<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> */<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> String[] on() default {};<a name="line.542"></a> |
| <span class="sourceLineNo">543</span><a name="line.543"></a> |
| <span class="sourceLineNo">544</span> /**<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * Specifies the parsers for converting HTTP request bodies into POJOs for this method.<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> * Parsers are used to convert the content of HTTP requests into POJOs.<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> * <br>Any of the Juneau framework parsers can be used in this setting.<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> * <br>The parser selected is based on the request <c>Content-Type</c> header matched against the values returned by the following method<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> * using a best-match algorithm:<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> * <ul class='javatree'><a name="line.552"></a> |
| <span class="sourceLineNo">553</span> * <li class='jm'>{@link Parser#getMediaTypes()}<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> * </ul><a name="line.554"></a> |
| <span class="sourceLineNo">555</span> *<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * <p><a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * This value overrides parsers specified at the class level using {@link Rest#parsers()}.<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * The {@link org.apache.juneau.parser.ParserSet.Inherit} class can be used to include values from the parent class.<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> *<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * <h5 class='section'>Example:</h5><a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * <p class='bjava'><a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * <jc>// Define a REST resource that can consume JSON and HTML.</jc><a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * <ja>@Rest</ja>(<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * parsers={<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> * JsonParser.<jk>class</jk>,<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> * HtmlParser.<jk>class</jk><a name="line.566"></a> |
| <span class="sourceLineNo">567</span> * }<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> * )<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> * <jk>public class</jk> MyResource {<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> *<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> * <jc>// Define a REST method that can also consume XML.</jc><a name="line.571"></a> |
| <span class="sourceLineNo">572</span> * <ja>@RestPut</ja>(<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> * parsers={<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> * ParserSet.Inherit.<jk>class</jk>, XmlParser.<jk>class</jk><a name="line.574"></a> |
| <span class="sourceLineNo">575</span> * }<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> * )<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> * <jk>public void</jk> doPut(MyBean <jv>bean</jv>) {<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * ...<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * }<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * }<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> * </p><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> * The programmatic equivalent to this annotation is:<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * <p class='bjava'><a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * RestOpContext.Builder <jv>builder</jv> = RestOpContext.<jsm>create</jsm>(<jv>method</jv>,<jv>restContext</jv>);<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * <jv>builder</jv>.getParsers().set(<jv>classes</jv>);<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * </p><a name="line.588"></a> |
| <span class="sourceLineNo">589</span> *<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * <ul class='seealso'><a name="line.590"></a> |
| <span class="sourceLineNo">591</span> * <li class='link'>{@doc jrs.Marshalling}<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> * </ul><a name="line.592"></a> |
| <span class="sourceLineNo">593</span> *<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> * @return The annotation value.<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> */<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> Class<?>[] parsers() default {};<a name="line.596"></a> |
| <span class="sourceLineNo">597</span><a name="line.597"></a> |
| <span class="sourceLineNo">598</span> /**<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> * Optional path pattern for the specified method.<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> *<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * <p><a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * Appending <js>"/*"</js> to the end of the path pattern will make it match any remainder too.<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * <br>Not appending <js>"/*"</js> to the end of the pattern will cause a 404 (Not found) error to occur if the exact<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * pattern is not found.<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> *<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> * <p><a name="line.606"></a> |
| <span class="sourceLineNo">607</span> * The path can contain variables that get resolved to {@link org.apache.juneau.http.annotation.Path @Path} parameters.<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> *<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> * <h5 class='figure'>Examples:</h5><a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * <p class='bjava'><a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * <ja>@RestPut</ja>(path=<js>"/myurl/{foo}/{bar}/{baz}/*"</js>)<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> * </p><a name="line.612"></a> |
| <span class="sourceLineNo">613</span> * <p class='bjava'><a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * <ja>@RestPut</ja>(path=<js>"/myurl/{0}/{1}/{2}/*"</js>)<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * </p><a name="line.615"></a> |
| <span class="sourceLineNo">616</span> *<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * <p><a name="line.617"></a> |
| <span class="sourceLineNo">618</span> * If you do not specify a path name, then the path name is inferred from the Java method name.<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> *<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> * <h5 class='figure'>Example:</h5><a name="line.620"></a> |
| <span class="sourceLineNo">621</span> * <p class='bjava'><a name="line.621"></a> |
| <span class="sourceLineNo">622</span> * <jc>// Path is assumed to be "/foo".</jc><a name="line.622"></a> |
| <span class="sourceLineNo">623</span> * <ja>@RestPut</ja><a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * <jk>public void</jk> foo() {...}<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> * </p><a name="line.625"></a> |
| <span class="sourceLineNo">626</span> *<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> * <p><a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * Note that you can also use {@link #value()} to specify the path.<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> *<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * <ul class='seealso'><a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * <li class='ja'>{@link org.apache.juneau.http.annotation.Path}<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> * </ul><a name="line.632"></a> |
| <span class="sourceLineNo">633</span> *<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * @return The annotation value.<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> */<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> String[] path() default {};<a name="line.636"></a> |
| <span class="sourceLineNo">637</span><a name="line.637"></a> |
| <span class="sourceLineNo">638</span> /**<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * Supported accept media types.<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> *<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> * <p><a name="line.641"></a> |
| <span class="sourceLineNo">642</span> * Overrides the media types inferred from the serializers that identify what media types can be produced by the resource.<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> *<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> * <ul class='notes'><a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * <li class='note'><a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * Supports {@doc jrs.SvlVariables}<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> * (e.g. <js>"$S{mySystemProperty}"</js>).<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * </ul><a name="line.648"></a> |
| <span class="sourceLineNo">649</span> *<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * <ul class='seealso'><a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#produces(MediaType...)}<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> * </ul><a name="line.652"></a> |
| <span class="sourceLineNo">653</span> *<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> * @return The annotation value.<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> */<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> String[] produces() default {};<a name="line.656"></a> |
| <span class="sourceLineNo">657</span><a name="line.657"></a> |
| <span class="sourceLineNo">658</span> /**<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * Role guard.<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> *<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> * <p><a name="line.661"></a> |
| <span class="sourceLineNo">662</span> * An expression defining if a user with the specified roles are allowed to access this method.<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> *<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> * <h5 class='section'>Example:</h5><a name="line.664"></a> |
| <span class="sourceLineNo">665</span> * <p class='bjava'><a name="line.665"></a> |
| <span class="sourceLineNo">666</span> * <jk>public class</jk> MyResource <jk>extends</jk> BasicRestServlet <jk>implements</jk> BasicUniversalConfig {<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> *<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * <ja>@RestPut</ja>(<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * path=<js>"/foo"</js>,<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * roleGuard=<js>"ROLE_ADMIN || (ROLE_READ_WRITE &amp;&amp; ROLE_SPECIAL)"</js><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * )<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * <jk>public</jk> Object doPut() {<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * }<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * }<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * </p><a name="line.675"></a> |
| <span class="sourceLineNo">676</span> *<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * <ul class='notes'><a name="line.677"></a> |
| <span class="sourceLineNo">678</span> * <li class='note'><a name="line.678"></a> |
| <span class="sourceLineNo">679</span> * Supports any of the following expression constructs:<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> * <ul><a name="line.680"></a> |
| <span class="sourceLineNo">681</span> * <li><js>"foo"</js> - Single arguments.<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> * <li><js>"foo,bar,baz"</js> - Multiple OR'ed arguments.<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> * <li><js>"foo | bar | baz"</js> - Multiple OR'ed arguments, pipe syntax.<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> * <li><js>"foo || bar || baz"</js> - Multiple OR'ed arguments, Java-OR syntax.<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> * <li><js>"fo*"</js> - Patterns including <js>'*'</js> and <js>'?'</js>.<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> * <li><js>"fo* &amp; *oo"</js> - Multiple AND'ed arguments, ampersand syntax.<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> * <li><js>"fo* &amp;&amp; *oo"</js> - Multiple AND'ed arguments, Java-AND syntax.<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> * <li><js>"fo* || (*oo || bar)"</js> - Parenthesis.<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * </ul><a name="line.689"></a> |
| <span class="sourceLineNo">690</span> * <li class='note'><a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * AND operations take precedence over OR operations (as expected).<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * <li class='note'><a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * Whitespace is ignored.<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> * <li class='note'><a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * <jk>null</jk> or empty expressions always match as <jk>false</jk>.<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * <li class='note'><a name="line.696"></a> |
| <span class="sourceLineNo">697</span> * If patterns are used, you must specify the list of declared roles using {@link #rolesDeclared()} or {@link org.apache.juneau.rest.RestOpContext.Builder#rolesDeclared(String...)}.<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * <li class='note'><a name="line.698"></a> |
| <span class="sourceLineNo">699</span> * Supports {@doc jrs.SvlVariables}<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> * <li class='note'><a name="line.701"></a> |
| <span class="sourceLineNo">702</span> * When defined on parent/child classes and methods, ALL guards within the hierarchy must pass.<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * </ul><a name="line.703"></a> |
| <span class="sourceLineNo">704</span> *<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * <ul class='seealso'><a name="line.705"></a> |
| <span class="sourceLineNo">706</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#roleGuard(String)}<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> * </ul><a name="line.707"></a> |
| <span class="sourceLineNo">708</span> *<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> * @return The annotation value.<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> */<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> String roleGuard() default "";<a name="line.711"></a> |
| <span class="sourceLineNo">712</span><a name="line.712"></a> |
| <span class="sourceLineNo">713</span> /**<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> * Declared roles.<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> *<a name="line.715"></a> |
| <span class="sourceLineNo">716</span> * <p><a name="line.716"></a> |
| <span class="sourceLineNo">717</span> * A comma-delimited list of all possible user roles.<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> *<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * <p><a name="line.719"></a> |
| <span class="sourceLineNo">720</span> * Used in conjunction with {@link #roleGuard()} is used with patterns.<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> *<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * <h5 class='section'>Example:</h5><a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * <p class='bjava'><a name="line.723"></a> |
| <span class="sourceLineNo">724</span> * <jk>public class</jk> MyResource <jk>extends</jk> BasicRestServlet <jk>implements</jk> BasicUniversalConfig {<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> *<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> * <ja>@RestPut</ja>(<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> * path=<js>"/foo"</js>,<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * rolesDeclared=<js>"ROLE_ADMIN,ROLE_READ_WRITE,ROLE_READ_ONLY,ROLE_SPECIAL"</js>,<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> * roleGuard=<js>"ROLE_ADMIN || (ROLE_READ_WRITE &amp;&amp; ROLE_SPECIAL)"</js><a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * )<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * <jk>public</jk> Object doPut() {<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * }<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> * }<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> * </p><a name="line.734"></a> |
| <span class="sourceLineNo">735</span> *<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> * <ul class='seealso'><a name="line.736"></a> |
| <span class="sourceLineNo">737</span> * <li class='jm'>{@link org.apache.juneau.rest.RestOpContext.Builder#rolesDeclared(String...)}<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> * </ul><a name="line.738"></a> |
| <span class="sourceLineNo">739</span> *<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> * @return The annotation value.<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> */<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> String rolesDeclared() default "";<a name="line.742"></a> |
| <span class="sourceLineNo">743</span><a name="line.743"></a> |
| <span class="sourceLineNo">744</span> /**<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * Specifies the serializers for marshalling POJOs into response bodies for this method.<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> *<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> * <p><a name="line.747"></a> |
| <span class="sourceLineNo">748</span> * Serializer are used to convert POJOs to HTTP response bodies.<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> * <br>Any of the Juneau framework serializers can be used in this setting.<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> * <br>The serializer selected is based on the request <c>Accept</c> header matched against the values returned by the following method<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> * using a best-match algorithm:<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> * <ul class='javatree'><a name="line.752"></a> |
| <span class="sourceLineNo">753</span> * <li class='jm'>{@link Serializer#getMediaTypeRanges()}<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> * </ul><a name="line.754"></a> |
| <span class="sourceLineNo">755</span> *<a name="line.755"></a> |
| <span class="sourceLineNo">756</span> * <p><a name="line.756"></a> |
| <span class="sourceLineNo">757</span> * This value overrides serializers specified at the class level using {@link Rest#serializers()}.<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> * The {@link org.apache.juneau.serializer.SerializerSet.Inherit} class can be used to include values from the parent class.<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> *<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> * <h5 class='section'>Example:</h5><a name="line.760"></a> |
| <span class="sourceLineNo">761</span> * <p class='bjava'><a name="line.761"></a> |
| <span class="sourceLineNo">762</span> * <jc>// Define a REST resource that can produce JSON and HTML.</jc><a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * <ja>@Rest</ja>(<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * serializers={<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> * JsonParser.<jk>class</jk>,<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> * HtmlParser.<jk>class</jk><a name="line.766"></a> |
| <span class="sourceLineNo">767</span> * }<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> * )<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> * <jk>public class</jk> MyResource {<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> *<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> * <jc>// Define a REST method that can also produce XML.</jc><a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * <ja>@RestPut</ja>(<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> * parsers={<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * SerializerSet.Inherit.<jk>class</jk>, XmlParser.<jk>class</jk><a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * }<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * )<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> * <jk>public</jk> MyBean doPut() {<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> * ...<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> * }<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> * }<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> * </p><a name="line.781"></a> |
| <span class="sourceLineNo">782</span> *<a name="line.782"></a> |
| <span class="sourceLineNo">783</span> * <p><a name="line.783"></a> |
| <span class="sourceLineNo">784</span> * The programmatic equivalent to this annotation is:<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> * <p class='bjava'><a name="line.785"></a> |
| <span class="sourceLineNo">786</span> * RestOpContext.Builder <jv>builder</jv> = RestOpContext.<jsm>create</jsm>(<jv>method</jv>,<jv>restContext</jv>);<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> * <jv>builder</jv>.getSerializers().set(<jv>classes</jv>);<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> * </p><a name="line.788"></a> |
| <span class="sourceLineNo">789</span> *<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> * <ul class='seealso'><a name="line.790"></a> |
| <span class="sourceLineNo">791</span> * <li class='link'>{@doc jrs.Marshalling}<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> * </ul><a name="line.792"></a> |
| <span class="sourceLineNo">793</span> *<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> * @return The annotation value.<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> */<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> Class<? extends Serializer>[] serializers() default {};<a name="line.796"></a> |
| <span class="sourceLineNo">797</span><a name="line.797"></a> |
| <span class="sourceLineNo">798</span> /**<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> * Optional summary for the exposed API.<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> *<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> * <p><a name="line.801"></a> |
| <span class="sourceLineNo">802</span> * This summary is used in the following locations:<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> * <ul class='spaced-list'><a name="line.803"></a> |
| <span class="sourceLineNo">804</span> * <li><a name="line.804"></a> |
| <span class="sourceLineNo">805</span> * The value returned by {@link Operation#getSummary()} in the auto-generated swagger.<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> * <li><a name="line.806"></a> |
| <span class="sourceLineNo">807</span> * The <js>"$RS{operationSummary}"</js> variable.<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> * <li><a name="line.808"></a> |
| <span class="sourceLineNo">809</span> * The summary of the method in the Swagger page.<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> * </ul><a name="line.810"></a> |
| <span class="sourceLineNo">811</span> *<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> * <ul class='notes'><a name="line.812"></a> |
| <span class="sourceLineNo">813</span> * <li class='note'><a name="line.813"></a> |
| <span class="sourceLineNo">814</span> * Corresponds to the swagger field <c>/paths/{path}/{method}/summary</c>.<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> * <li class='note'><a name="line.815"></a> |
| <span class="sourceLineNo">816</span> * Supports {@doc jrs.SvlVariables}<a name="line.816"></a> |
| <span class="sourceLineNo">817</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> * </ul><a name="line.818"></a> |
| <span class="sourceLineNo">819</span> *<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> * @return The annotation value.<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> */<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> String summary() default "";<a name="line.822"></a> |
| <span class="sourceLineNo">823</span><a name="line.823"></a> |
| <span class="sourceLineNo">824</span> /**<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * Provides swagger-specific metadata on this method.<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> *<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * <p><a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * Used to populate the auto-generated OPTIONS swagger documentation.<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> *<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> * <p><a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * The format of this annotation is JSON when all individual parts are concatenated.<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> * <br>The starting and ending <js>'{'</js>/<js>'}'</js> characters around the entire value are optional.<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> *<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> * <h5 class='section'>Example:</h5><a name="line.834"></a> |
| <span class="sourceLineNo">835</span> * <p class='bjava'><a name="line.835"></a> |
| <span class="sourceLineNo">836</span> * <ja>@RestPut</ja>(<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> * path=<js>"/{propertyName}"</js>,<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> *<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> * <jc>// Swagger info.</jc><a name="line.839"></a> |
| <span class="sourceLineNo">840</span> * swagger={<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> * <js>"parameters:["</js>,<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> * <js>"{name:'propertyName',in:'path',description:'The system property name.'},"</js>,<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> * <js>"{in:'body',description:'The new system property value.'}"</js>,<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> * <js>"],"</js>,<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> * <js>"responses:{"</js>,<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> * <js>"302: {headers:{Location:{description:'The root URL of this resource.'}}},"</js>,<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> * <js>"403: {description:'User is not an admin.'}"</js>,<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> * <js>"}"</js><a name="line.848"></a> |
| <span class="sourceLineNo">849</span> * }<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * )<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> * </p><a name="line.851"></a> |
| <span class="sourceLineNo">852</span> *<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> * <ul class='notes'><a name="line.853"></a> |
| <span class="sourceLineNo">854</span> * <li class='note'><a name="line.854"></a> |
| <span class="sourceLineNo">855</span> * The format is {@doc jd.Swagger}.<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> * <br>Multiple lines are concatenated with newlines.<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> * <li class='note'><a name="line.857"></a> |
| <span class="sourceLineNo">858</span> * The starting and ending <js>'{'</js>/<js>'}'</js> characters around the entire value are optional.<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> * <li class='note'><a name="line.859"></a> |
| <span class="sourceLineNo">860</span> * These values are superimposed on top of any Swagger JSON file present for the resource in the classpath.<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> * <li class='note'><a name="line.861"></a> |
| <span class="sourceLineNo">862</span> * Supports {@doc jrs.SvlVariables}<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> * </ul><a name="line.864"></a> |
| <span class="sourceLineNo">865</span> *<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> * <ul class='seealso'><a name="line.866"></a> |
| <span class="sourceLineNo">867</span> * <li class='ja'>{@link OpSwagger}<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> * <li class='jc'>{@link SwaggerProvider}<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> * </ul><a name="line.869"></a> |
| <span class="sourceLineNo">870</span> *<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> * @return The annotation value.<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> */<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> OpSwagger swagger() default @OpSwagger;<a name="line.873"></a> |
| <span class="sourceLineNo">874</span><a name="line.874"></a> |
| <span class="sourceLineNo">875</span> /**<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> * REST method path.<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> *<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> * <p><a name="line.878"></a> |
| <span class="sourceLineNo">879</span> * Can be used to provide a shortened form for the {@link #path()} value.<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> *<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> * <p><a name="line.881"></a> |
| <span class="sourceLineNo">882</span> * The following examples are considered equivalent.<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> * <p class='bjava'><a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * <jc>// Normal form</jc><a name="line.884"></a> |
| <span class="sourceLineNo">885</span> * <ja>@RestPut</ja>(path=<js>"/{propertyName}"</js>)<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> *<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> * <jc>// Shortened form</jc><a name="line.887"></a> |
| <span class="sourceLineNo">888</span> * <ja>@RestPut</ja>(<js>"/{propertyName}"</js>)<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> * </p><a name="line.889"></a> |
| <span class="sourceLineNo">890</span> *<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> * @return The annotation value.<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> */<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> String value() default "";<a name="line.893"></a> |
| <span class="sourceLineNo">894</span>}<a name="line.894"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
