Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / http / annotation / Request.html
blob: 363b94c2578202a302295f989b2df7d6889bcf41 [file] [log] [blame]
<!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.http.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><a name="line.19"></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.httppart.*;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.juneau.oapi.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Request bean annotation.<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Identifies an interface to use to interact with HTTP parts of an HTTP request through a bean.<a name="line.28"></a>
<span class="sourceLineNo">029</span> *<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Can be used in the following locations:<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;ul&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;li&gt;Arguments and argument-types of server-side &lt;ja&gt;@RestOp&lt;/ja&gt;-annotated methods.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;li&gt;Arguments and argument-types of client-side &lt;ja&gt;@RemoteResource&lt;/ja&gt;-annotated interfaces.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;/ul&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;h5 class='topic'&gt;Arguments and argument-types of server-side @RestOp-annotated methods&lt;/h5&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Annotation that can be applied to a parameter of a &lt;ja&gt;@RestOp&lt;/ja&gt;-annotated method to identify it as an interface for retrieving HTTP parts through a bean interface.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p class='bjava'&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;ja&gt;@RestGet&lt;/ja&gt;(&lt;js&gt;"/mypath/{p1}/{p2}/*"&lt;/js&gt;)<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;jk&gt;public void&lt;/jk&gt; myMethod(&lt;ja&gt;@Request&lt;/ja&gt; MyRequest &lt;jv&gt;requestBean&lt;/jv&gt;) {...}<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyRequest {<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;ja&gt;@Path&lt;/ja&gt; &lt;jc&gt;// Path variable name inferred from getter.&lt;/jc&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * String getP1();<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;ja&gt;@Path&lt;/ja&gt;(&lt;js&gt;"p2"&lt;/js&gt;)<a name="line.51"></a>
<span class="sourceLineNo">052</span> * String getX();<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;ja&gt;@Path&lt;/ja&gt;(&lt;js&gt;"/*"&lt;/js&gt;)<a name="line.54"></a>
<span class="sourceLineNo">055</span> * String getRemainder();<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;ja&gt;@Query&lt;/ja&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * String getQ1();<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;jc&gt;// Schema-based query parameter: Pipe-delimited lists of comma-delimited lists of integers.&lt;/jc&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;ja&gt;@Query&lt;/ja&gt;(<a name="line.61"></a>
<span class="sourceLineNo">062</span> * collectionFormat=&lt;js&gt;"pipes"&lt;/js&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * items=&lt;ja&gt;@Items&lt;/ja&gt;(<a name="line.63"></a>
<span class="sourceLineNo">064</span> * items=&lt;ja&gt;@SubItems&lt;/ja&gt;(<a name="line.64"></a>
<span class="sourceLineNo">065</span> * collectionFormat=&lt;js&gt;"csv"&lt;/js&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * type=&lt;js&gt;"integer"&lt;/js&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * )<a name="line.67"></a>
<span class="sourceLineNo">068</span> * )<a name="line.68"></a>
<span class="sourceLineNo">069</span> * )<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;jk&gt;int&lt;/jk&gt;[][] getQ3();<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;ja&gt;@Header&lt;/ja&gt;(&lt;js&gt;"*"&lt;/js&gt;)<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Map&amp;lt;String,Object&amp;gt; getHeaders();<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;/p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;p class='bjava'&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;jc&gt;// Same as above but annotation defined on interface.&lt;/jc&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;ja&gt;@RestGet&lt;/ja&gt;(path=&lt;js&gt;"/mypath/{p1}/{p2}/*"&lt;/js&gt;)<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;jk&gt;public void&lt;/jk&gt; myMethod(MyRequest &lt;jv&gt;requestBean&lt;/jv&gt;) {...}<a name="line.78"></a>
<span class="sourceLineNo">079</span> *<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;ja&gt;@Request&lt;/ja&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyRequest {...}<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * The return types of the getters must be the supported parameter types for the HTTP-part annotation used.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;br&gt;Schema-based serialization and parsing is allowed just as if used as individual parameter types.<a name="line.85"></a>
<span class="sourceLineNo">086</span> *<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;ul class='seealso'&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;/ul&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> *<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;h5 class='topic'&gt;Arguments and argument-types of client-side @RemoteResource-annotated interfaces&lt;/h5&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;p&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Annotation applied to Java method arguments of interface proxies to denote a bean with remote resource annotations.<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span> * &lt;p class='bjava'&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * &lt;ja&gt;@RemoteResource&lt;/ja&gt;(path=&lt;js&gt;"/myproxy"&lt;/js&gt;)<a name="line.96"></a>
<span class="sourceLineNo">097</span> * &lt;jk&gt;public interface&lt;/jk&gt; MyProxy {<a name="line.97"></a>
<span class="sourceLineNo">098</span> *<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;ja&gt;@RemoteGet&lt;/ja&gt;(&lt;js&gt;"/mymethod/{p1}/{p2}"&lt;/js&gt;)<a name="line.99"></a>
<span class="sourceLineNo">100</span> * String myProxyMethod(&lt;ja&gt;@Request&lt;/ja&gt; MyRequest &lt;jv&gt;requestBean&lt;/jv&gt;);<a name="line.100"></a>
<span class="sourceLineNo">101</span> * }<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;jk&gt;public class&lt;/jk&gt; MyRequest {<a name="line.103"></a>
<span class="sourceLineNo">104</span> *<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;ja&gt;@Path&lt;/ja&gt; &lt;jc&gt;// Path variable name inferred from getter.&lt;/jc&gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;jk&gt;public&lt;/jk&gt; String getP1() {...}<a name="line.106"></a>
<span class="sourceLineNo">107</span> *<a name="line.107"></a>
<span class="sourceLineNo">108</span> * &lt;ja&gt;@Path&lt;/ja&gt;(&lt;js&gt;"p2"&lt;/js&gt;)<a name="line.108"></a>
<span class="sourceLineNo">109</span> * &lt;jk&gt;public&lt;/jk&gt; String getX() {...}<a name="line.109"></a>
<span class="sourceLineNo">110</span> *<a name="line.110"></a>
<span class="sourceLineNo">111</span> * &lt;ja&gt;@Path&lt;/ja&gt;(&lt;js&gt;"/*"&lt;/js&gt;)<a name="line.111"></a>
<span class="sourceLineNo">112</span> * &lt;jk&gt;public&lt;/jk&gt; String getRemainder() {...}<a name="line.112"></a>
<span class="sourceLineNo">113</span> *<a name="line.113"></a>
<span class="sourceLineNo">114</span> * &lt;ja&gt;@Query&lt;/ja&gt;<a name="line.114"></a>
<span class="sourceLineNo">115</span> * &lt;jk&gt;public&lt;/jk&gt; String getQ1() {...}<a name="line.115"></a>
<span class="sourceLineNo">116</span> *<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;jc&gt;// Schema-based query parameter: Pipe-delimited lists of comma-delimited lists of integers.&lt;/jc&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;ja&gt;@Query&lt;/ja&gt;(<a name="line.118"></a>
<span class="sourceLineNo">119</span> * schema=&lt;ja&gt;@Query&lt;/ja&gt;(<a name="line.119"></a>
<span class="sourceLineNo">120</span> * collectionFormat=&lt;js&gt;"pipes"&lt;/js&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span> * items=&lt;ja&gt;@Items&lt;/ja&gt;(<a name="line.121"></a>
<span class="sourceLineNo">122</span> * items=&lt;ja&gt;@SubItems&lt;/ja&gt;(<a name="line.122"></a>
<span class="sourceLineNo">123</span> * collectionFormat=&lt;js&gt;"csv"&lt;/js&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span> * type=&lt;js&gt;"integer"&lt;/js&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * )<a name="line.125"></a>
<span class="sourceLineNo">126</span> * )<a name="line.126"></a>
<span class="sourceLineNo">127</span> * )<a name="line.127"></a>
<span class="sourceLineNo">128</span> * )<a name="line.128"></a>
<span class="sourceLineNo">129</span> * &lt;jk&gt;public&lt;/jk&gt; &lt;jk&gt;int&lt;/jk&gt;[][] getQ3() {...}<a name="line.129"></a>
<span class="sourceLineNo">130</span> *<a name="line.130"></a>
<span class="sourceLineNo">131</span> * &lt;ja&gt;@Header&lt;/ja&gt;(&lt;js&gt;"*"&lt;/js&gt;)<a name="line.131"></a>
<span class="sourceLineNo">132</span> * &lt;jk&gt;public&lt;/jk&gt; Map&amp;lt;String,Object&amp;gt; getHeaders() {...}<a name="line.132"></a>
<span class="sourceLineNo">133</span> * }<a name="line.133"></a>
<span class="sourceLineNo">134</span> * &lt;/p&gt;<a name="line.134"></a>
<span class="sourceLineNo">135</span> *<a name="line.135"></a>
<span class="sourceLineNo">136</span> * &lt;ul class='seealso'&gt;<a name="line.136"></a>
<span class="sourceLineNo">137</span> * &lt;li class='link'&gt;{@doc jrc.Request}<a name="line.137"></a>
<span class="sourceLineNo">138</span> * &lt;/ul&gt;<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span> * &lt;ul class='seealso'&gt;<a name="line.140"></a>
<span class="sourceLineNo">141</span> * &lt;li class='extlink'&gt;{@source}<a name="line.141"></a>
<span class="sourceLineNo">142</span> * &lt;/ul&gt;<a name="line.142"></a>
<span class="sourceLineNo">143</span> */<a name="line.143"></a>
<span class="sourceLineNo">144</span>@Documented<a name="line.144"></a>
<span class="sourceLineNo">145</span>@Target({PARAMETER,TYPE,METHOD})<a name="line.145"></a>
<span class="sourceLineNo">146</span>@Retention(RUNTIME)<a name="line.146"></a>
<span class="sourceLineNo">147</span>@Inherited<a name="line.147"></a>
<span class="sourceLineNo">148</span>@Repeatable(RequestAnnotation.Array.class)<a name="line.148"></a>
<span class="sourceLineNo">149</span>@ContextApply(RequestAnnotation.Applier.class)<a name="line.149"></a>
<span class="sourceLineNo">150</span>public @interface Request {<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> * Dynamically apply this annotation to the specified classes.<a name="line.153"></a>
<span class="sourceLineNo">154</span> *<a name="line.154"></a>
<span class="sourceLineNo">155</span> * &lt;ul class='seealso'&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span> * &lt;li class='link'&gt;{@doc jm.DynamicallyAppliedAnnotations}<a name="line.156"></a>
<span class="sourceLineNo">157</span> * &lt;/ul&gt;<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> String[] on() 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> * Dynamically apply this annotation to the specified classes.<a name="line.164"></a>
<span class="sourceLineNo">165</span> *<a name="line.165"></a>
<span class="sourceLineNo">166</span> * &lt;p&gt;<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Identical to {@link #on()} except allows you to specify class objects instead of a strings.<a name="line.167"></a>
<span class="sourceLineNo">168</span> *<a name="line.168"></a>
<span class="sourceLineNo">169</span> * &lt;ul class='seealso'&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span> * &lt;li class='link'&gt;{@doc jm.DynamicallyAppliedAnnotations}<a name="line.170"></a>
<span class="sourceLineNo">171</span> * &lt;/ul&gt;<a name="line.171"></a>
<span class="sourceLineNo">172</span> *<a name="line.172"></a>
<span class="sourceLineNo">173</span> * @return The annotation value.<a name="line.173"></a>
<span class="sourceLineNo">174</span> */<a name="line.174"></a>
<span class="sourceLineNo">175</span> Class&lt;?&gt;[] onClass() default {};<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
<span class="sourceLineNo">178</span> * Specifies the {@link HttpPartParser} class used for parsing strings to values.<a name="line.178"></a>
<span class="sourceLineNo">179</span> *<a name="line.179"></a>
<span class="sourceLineNo">180</span> * &lt;p&gt;<a name="line.180"></a>
<span class="sourceLineNo">181</span> * Overrides for this part the part parser defined on the REST resource which by default is {@link OpenApiParser}.<a name="line.181"></a>
<span class="sourceLineNo">182</span> *<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @return The annotation value.<a name="line.183"></a>
<span class="sourceLineNo">184</span> */<a name="line.184"></a>
<span class="sourceLineNo">185</span> Class&lt;? extends HttpPartParser&gt; parser() default HttpPartParser.Void.class;<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> /**<a name="line.187"></a>
<span class="sourceLineNo">188</span> * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.<a name="line.188"></a>
<span class="sourceLineNo">189</span> *<a name="line.189"></a>
<span class="sourceLineNo">190</span> * &lt;p&gt;<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Overrides for this part the part serializer defined on the REST client which by default is {@link OpenApiSerializer}.<a name="line.191"></a>
<span class="sourceLineNo">192</span> *<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @return The annotation value.<a name="line.193"></a>
<span class="sourceLineNo">194</span> */<a name="line.194"></a>
<span class="sourceLineNo">195</span> Class&lt;? extends HttpPartSerializer&gt; serializer() default HttpPartSerializer.Void.class;<a name="line.195"></a>
<span class="sourceLineNo">196</span>}<a name="line.196"></a>
</pre>
</div>
</body>
</html>