http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/33cef683/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestCall.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestCall.html b/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestCall.html index cef6c1e..a2b1e2f 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestCall.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestCall.html @@ -24,1540 +24,1599 @@ <span class="sourceLineNo">016</span>import java.lang.reflect.*;<a name="line.16"></a> <span class="sourceLineNo">017</span>import java.net.*;<a name="line.17"></a> <span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import java.util.logging.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.util.regex.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.http.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.http.client.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.http.client.config.*;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.http.client.methods.*;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.http.client.utils.*;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.http.impl.client.*;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.http.util.*;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.juneau.*;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.juneau.encoders.*;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.juneau.internal.*;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.juneau.parser.*;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.juneau.parser.ParseException;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.juneau.serializer.*;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.juneau.utils.*;<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span>/**<a name="line.37"></a> -<span class="sourceLineNo">038</span> * Represents a connection to a remote REST resource.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <p><a name="line.39"></a> -<span class="sourceLineNo">040</span> * Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so...<a name="line.42"></a> -<span class="sourceLineNo">043</span> *<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p class='bcode'><a name="line.44"></a> -<span class="sourceLineNo">045</span> * RestClient client = <jk>new</jk> RestClient();<a name="line.45"></a> -<span class="sourceLineNo">046</span> * RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);<a name="line.46"></a> -<span class="sourceLineNo">047</span> * MyBean b = c.getResponse(MyBean.<jk>class</jk>);<a name="line.47"></a> -<span class="sourceLineNo">048</span> * </p><a name="line.48"></a> -<span class="sourceLineNo">049</span> * <p><a name="line.49"></a> -<span class="sourceLineNo">050</span> * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.<a name="line.50"></a> -<span class="sourceLineNo">051</span> *<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <h5 class='section'>Additional information:</h5><a name="line.52"></a> -<span class="sourceLineNo">053</span> * <ul><a name="line.53"></a> -<span class="sourceLineNo">054</span> * <li><a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client &gt; REST client API</a> for more information and code examples.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * </ul><a name="line.55"></a> -<span class="sourceLineNo">056</span> */<a name="line.56"></a> -<span class="sourceLineNo">057</span>@SuppressWarnings("hiding")<a name="line.57"></a> -<span class="sourceLineNo">058</span>public final class RestCall {<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> private final RestClient client; // The client that created this call.<a name="line.60"></a> -<span class="sourceLineNo">061</span> private final HttpRequestBase request; // The request.<a name="line.61"></a> -<span class="sourceLineNo">062</span> private HttpResponse response; // The response.<a name="line.62"></a> -<span class="sourceLineNo">063</span> private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> private boolean isConnected = false; // connect() has been called.<a name="line.65"></a> -<span class="sourceLineNo">066</span> private boolean allowRedirectsOnPosts;<a name="line.66"></a> -<span class="sourceLineNo">067</span> private int retries = 1;<a name="line.67"></a> -<span class="sourceLineNo">068</span> private int redirectOnPostsTries = 5;<a name="line.68"></a> -<span class="sourceLineNo">069</span> private long retryInterval = -1;<a name="line.69"></a> -<span class="sourceLineNo">070</span> private RetryOn retryOn;<a name="line.70"></a> -<span class="sourceLineNo">071</span> private boolean ignoreErrors;<a name="line.71"></a> -<span class="sourceLineNo">072</span> private boolean byLines = false;<a name="line.72"></a> -<span class="sourceLineNo">073</span> private TeeWriter writers = new TeeWriter();<a name="line.73"></a> -<span class="sourceLineNo">074</span> private StringWriter capturedResponseWriter;<a name="line.74"></a> -<span class="sourceLineNo">075</span> private String capturedResponse;<a name="line.75"></a> -<span class="sourceLineNo">076</span> private TeeOutputStream outputStreams = new TeeOutputStream();<a name="line.76"></a> -<span class="sourceLineNo">077</span> private boolean isClosed = false;<a name="line.77"></a> -<span class="sourceLineNo">078</span> private boolean isFailed = false;<a name="line.78"></a> -<span class="sourceLineNo">079</span> private Object input;<a name="line.79"></a> -<span class="sourceLineNo">080</span> private Serializer serializer;<a name="line.80"></a> -<span class="sourceLineNo">081</span> private Parser parser;<a name="line.81"></a> -<span class="sourceLineNo">082</span> private URIBuilder uriBuilder;<a name="line.82"></a> -<span class="sourceLineNo">083</span><a name="line.83"></a> -<span class="sourceLineNo">084</span> /**<a name="line.84"></a> -<span class="sourceLineNo">085</span> * Constructs a REST call with the specified method name.<a name="line.85"></a> -<span class="sourceLineNo">086</span> *<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @param client The client that created this request.<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param request The wrapped Apache HTTP client request object.<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @param uri The URI for this call.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.<a name="line.90"></a> -<span class="sourceLineNo">091</span> */<a name="line.91"></a> -<span class="sourceLineNo">092</span> protected RestCall(RestClient client, HttpRequestBase request, URI uri) throws RestCallException {<a name="line.92"></a> -<span class="sourceLineNo">093</span> this.client = client;<a name="line.93"></a> -<span class="sourceLineNo">094</span> this.request = request;<a name="line.94"></a> -<span class="sourceLineNo">095</span> for (RestCallInterceptor i : this.client.interceptors)<a name="line.95"></a> -<span class="sourceLineNo">096</span> interceptor(i);<a name="line.96"></a> -<span class="sourceLineNo">097</span> this.retryOn = client.retryOn;<a name="line.97"></a> -<span class="sourceLineNo">098</span> this.retries = client.retries;<a name="line.98"></a> -<span class="sourceLineNo">099</span> this.retryInterval = client.retryInterval;<a name="line.99"></a> -<span class="sourceLineNo">100</span> this.serializer = client.serializer;<a name="line.100"></a> -<span class="sourceLineNo">101</span> this.parser = client.parser;<a name="line.101"></a> -<span class="sourceLineNo">102</span> uriBuilder = new URIBuilder(uri);<a name="line.102"></a> -<span class="sourceLineNo">103</span> }<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> /**<a name="line.105"></a> -<span class="sourceLineNo">106</span> * Sets the URI for this call.<a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p><a name="line.107"></a> -<span class="sourceLineNo">108</span> * Can be any of the following types:<a name="line.108"></a> -<span class="sourceLineNo">109</span> * <ul><a name="line.109"></a> -<span class="sourceLineNo">110</span> * <li>{@link URI}<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <li>{@link URL}<a name="line.111"></a> -<span class="sourceLineNo">112</span> * <li>{@link URIBuilder}<a name="line.112"></a> -<span class="sourceLineNo">113</span> * <li>Anything else converted to a string using {@link Object#toString()}.<a name="line.113"></a> -<span class="sourceLineNo">114</span> * </ul><a name="line.114"></a> -<span class="sourceLineNo">115</span> * Relative URL strings will be interpreted as relative to the root URL defined on the client.<a name="line.115"></a> -<span class="sourceLineNo">116</span> *<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param uri The URI to use for this call.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * This overrides the URI passed in from the client.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @return This object (for method chaining).<a name="line.119"></a> -<span class="sourceLineNo">120</span> * @throws RestCallException<a name="line.120"></a> -<span class="sourceLineNo">121</span> */<a name="line.121"></a> -<span class="sourceLineNo">122</span> public RestCall uri(Object uri) throws RestCallException {<a name="line.122"></a> -<span class="sourceLineNo">123</span> try {<a name="line.123"></a> -<span class="sourceLineNo">124</span> if (uri != null)<a name="line.124"></a> -<span class="sourceLineNo">125</span> uriBuilder = new URIBuilder(client.toURI(uri));<a name="line.125"></a> -<span class="sourceLineNo">126</span> return this;<a name="line.126"></a> -<span class="sourceLineNo">127</span> } catch (URISyntaxException e) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> throw new RestCallException(e);<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span> }<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Sets the URI scheme.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @param scheme The new URI host.<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @return This object (for method chaining).<a name="line.136"></a> -<span class="sourceLineNo">137</span> */<a name="line.137"></a> -<span class="sourceLineNo">138</span> public RestCall scheme(String scheme) {<a name="line.138"></a> -<span class="sourceLineNo">139</span> uriBuilder.setScheme(scheme);<a name="line.139"></a> -<span class="sourceLineNo">140</span> return this;<a name="line.140"></a> -<span class="sourceLineNo">141</span> }<a name="line.141"></a> -<span class="sourceLineNo">142</span><a name="line.142"></a> -<span class="sourceLineNo">143</span> /**<a name="line.143"></a> -<span class="sourceLineNo">144</span> * Sets the URI host.<a name="line.144"></a> -<span class="sourceLineNo">145</span> *<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @param host The new URI host.<a name="line.146"></a> -<span class="sourceLineNo">147</span> * @return This object (for method chaining).<a name="line.147"></a> -<span class="sourceLineNo">148</span> */<a name="line.148"></a> -<span class="sourceLineNo">149</span> public RestCall host(String host) {<a name="line.149"></a> -<span class="sourceLineNo">150</span> uriBuilder.setHost(host);<a name="line.150"></a> -<span class="sourceLineNo">151</span> return this;<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span><a name="line.153"></a> -<span class="sourceLineNo">154</span> /**<a name="line.154"></a> -<span class="sourceLineNo">155</span> * Sets the URI port.<a name="line.155"></a> -<span class="sourceLineNo">156</span> *<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @param port The new URI port.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * @return This object (for method chaining).<a name="line.158"></a> -<span class="sourceLineNo">159</span> */<a name="line.159"></a> -<span class="sourceLineNo">160</span> public RestCall port(int port) {<a name="line.160"></a> -<span class="sourceLineNo">161</span> uriBuilder.setPort(port);<a name="line.161"></a> -<span class="sourceLineNo">162</span> return this;<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * Adds a parameter to the URI query.<a name="line.166"></a> -<span class="sourceLineNo">167</span> *<a name="line.167"></a> -<span class="sourceLineNo">168</span> * @param name The parameter name.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @param value The parameter value converted to a string using UON notation.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * @return This object (for method chaining).<a name="line.170"></a> -<span class="sourceLineNo">171</span> * @throws RestCallException<a name="line.171"></a> -<span class="sourceLineNo">172</span> */<a name="line.172"></a> -<span class="sourceLineNo">173</span> public RestCall param(String name, Object value) throws RestCallException {<a name="line.173"></a> -<span class="sourceLineNo">174</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.174"></a> -<span class="sourceLineNo">175</span> return this;<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> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Adds parameters to the URI query.<a name="line.179"></a> -<span class="sourceLineNo">180</span> *<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.181"></a> -<span class="sourceLineNo">182</span> * @return This object (for method chaining).<a name="line.182"></a> -<span class="sourceLineNo">183</span> * @throws RestCallException<a name="line.183"></a> -<span class="sourceLineNo">184</span> */<a name="line.184"></a> -<span class="sourceLineNo">185</span> public RestCall params(Map<String,Object> params) throws RestCallException {<a name="line.185"></a> -<span class="sourceLineNo">186</span> for (Map.Entry<String,Object> p : params.entrySet())<a name="line.186"></a> -<span class="sourceLineNo">187</span> uriBuilder.addParameter(p.getKey(), client.getUrlEncodingSerializer().serializeUrlPart(p.getValue()));<a name="line.187"></a> -<span class="sourceLineNo">188</span> return this;<a name="line.188"></a> -<span class="sourceLineNo">189</span> }<a name="line.189"></a> -<span class="sourceLineNo">190</span><a name="line.190"></a> -<span class="sourceLineNo">191</span> /**<a name="line.191"></a> -<span class="sourceLineNo">192</span> * Adds a parameter to the URI query if the parameter value is not <jk>null</jk>.<a name="line.192"></a> -<span class="sourceLineNo">193</span> *<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @param name The parameter name.<a name="line.194"></a> -<span class="sourceLineNo">195</span> * @param value The parameter value converted to a string using UON notation.<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @return This object (for method chaining).<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @throws RestCallException<a name="line.197"></a> -<span class="sourceLineNo">198</span> */<a name="line.198"></a> -<span class="sourceLineNo">199</span> public RestCall paramIfNN(String name, Object value) throws RestCallException {<a name="line.199"></a> -<span class="sourceLineNo">200</span> if (value != null)<a name="line.200"></a> -<span class="sourceLineNo">201</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.201"></a> -<span class="sourceLineNo">202</span> return this;<a name="line.202"></a> -<span class="sourceLineNo">203</span> }<a name="line.203"></a> -<span class="sourceLineNo">204</span><a name="line.204"></a> -<span class="sourceLineNo">205</span> /**<a name="line.205"></a> -<span class="sourceLineNo">206</span> * Same as {@link #params(Map)} but ignores values that are <jk>null</jk>.<a name="line.206"></a> -<span class="sourceLineNo">207</span> *<a name="line.207"></a> -<span class="sourceLineNo">208</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @return This object (for method chaining).<a name="line.209"></a> -<span class="sourceLineNo">210</span> * @throws RestCallException<a name="line.210"></a> -<span class="sourceLineNo">211</span> */<a name="line.211"></a> -<span class="sourceLineNo">212</span> public RestCall paramsIfNN(Map<String,Object> params) throws RestCallException {<a name="line.212"></a> -<span class="sourceLineNo">213</span> if (params != null) {<a name="line.213"></a> -<span class="sourceLineNo">214</span> for (Map.Entry<String,Object> e : params.entrySet()) {<a name="line.214"></a> -<span class="sourceLineNo">215</span> Object value = e.getValue();<a name="line.215"></a> -<span class="sourceLineNo">216</span> if (value != null)<a name="line.216"></a> -<span class="sourceLineNo">217</span> uriBuilder.addParameter(e.getKey(), client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.217"></a> -<span class="sourceLineNo">218</span> }<a name="line.218"></a> -<span class="sourceLineNo">219</span> }<a name="line.219"></a> -<span class="sourceLineNo">220</span> return this;<a name="line.220"></a> -<span class="sourceLineNo">221</span> }<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> /**<a name="line.223"></a> -<span class="sourceLineNo">224</span> * Adds a parameter to the URI query if the parameter value is not <jk>null</jk> or an empty string.<a name="line.224"></a> -<span class="sourceLineNo">225</span> *<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @param name The parameter name.<a name="line.226"></a> -<span class="sourceLineNo">227</span> * @param value The parameter value converted to a string using UON notation.<a name="line.227"></a> -<span class="sourceLineNo">228</span> * @return This object (for method chaining).<a name="line.228"></a> -<span class="sourceLineNo">229</span> * @throws RestCallException<a name="line.229"></a> -<span class="sourceLineNo">230</span> */<a name="line.230"></a> -<span class="sourceLineNo">231</span> public RestCall paramIfNE(String name, Object value) throws RestCallException {<a name="line.231"></a> -<span class="sourceLineNo">232</span> if (! StringUtils.isEmpty(value))<a name="line.232"></a> -<span class="sourceLineNo">233</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.233"></a> -<span class="sourceLineNo">234</span> return this;<a name="line.234"></a> -<span class="sourceLineNo">235</span> }<a name="line.235"></a> -<span class="sourceLineNo">236</span><a name="line.236"></a> -<span class="sourceLineNo">237</span> /**<a name="line.237"></a> -<span class="sourceLineNo">238</span> * Same as {@link #params(Map)} but ignores values that are <jk>null</jk> or empty strings.<a name="line.238"></a> -<span class="sourceLineNo">239</span> *<a name="line.239"></a> -<span class="sourceLineNo">240</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @return This object (for method chaining).<a name="line.241"></a> -<span class="sourceLineNo">242</span> * @throws RestCallException<a name="line.242"></a> -<span class="sourceLineNo">243</span> */<a name="line.243"></a> -<span class="sourceLineNo">244</span> public RestCall paramIfNE(Map<String,Object> params) throws RestCallException {<a name="line.244"></a> -<span class="sourceLineNo">245</span> if (params != null) {<a name="line.245"></a> -<span class="sourceLineNo">246</span> for (Map.Entry<String,Object> e : params.entrySet()) {<a name="line.246"></a> -<span class="sourceLineNo">247</span> Object value = e.getValue();<a name="line.247"></a> -<span class="sourceLineNo">248</span> if (! StringUtils.isEmpty(value))<a name="line.248"></a> -<span class="sourceLineNo">249</span> uriBuilder.addParameter(e.getKey(), client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.249"></a> -<span class="sourceLineNo">250</span> }<a name="line.250"></a> -<span class="sourceLineNo">251</span> }<a name="line.251"></a> -<span class="sourceLineNo">252</span> return this;<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span><a name="line.254"></a> -<span class="sourceLineNo">255</span> /**<a name="line.255"></a> -<span class="sourceLineNo">256</span> * Sets a custom URI query.<a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @param query The new URI query string.<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @return This object (for method chaining).<a name="line.259"></a> -<span class="sourceLineNo">260</span> */<a name="line.260"></a> -<span class="sourceLineNo">261</span> public RestCall query(String query) {<a name="line.261"></a> -<span class="sourceLineNo">262</span> uriBuilder.setCustomQuery(query);<a name="line.262"></a> -<span class="sourceLineNo">263</span> return this;<a name="line.263"></a> -<span class="sourceLineNo">264</span> }<a name="line.264"></a> -<span class="sourceLineNo">265</span><a name="line.265"></a> -<span class="sourceLineNo">266</span> /**<a name="line.266"></a> -<span class="sourceLineNo">267</span> * Sets the URI user info.<a name="line.267"></a> -<span class="sourceLineNo">268</span> *<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @param userInfo The new URI user info.<a name="line.269"></a> -<span class="sourceLineNo">270</span> * @return This object (for method chaining).<a name="line.270"></a> -<span class="sourceLineNo">271</span> */<a name="line.271"></a> -<span class="sourceLineNo">272</span> public RestCall userInfo(String userInfo) {<a name="line.272"></a> -<span class="sourceLineNo">273</span> uriBuilder.setUserInfo(userInfo);<a name="line.273"></a> -<span class="sourceLineNo">274</span> return this;<a name="line.274"></a> -<span class="sourceLineNo">275</span> }<a name="line.275"></a> -<span class="sourceLineNo">276</span><a name="line.276"></a> -<span class="sourceLineNo">277</span> /**<a name="line.277"></a> -<span class="sourceLineNo">278</span> * Sets the URI user info.<a name="line.278"></a> +<span class="sourceLineNo">019</span>import java.util.concurrent.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.logging.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.regex.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.http.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.http.client.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.http.client.config.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.http.client.methods.*;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.http.client.utils.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.http.impl.client.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.http.util.*;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.juneau.*;<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.internal.*;<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>import org.apache.juneau.parser.ParseException;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.juneau.serializer.*;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.juneau.utils.*;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>/**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Represents a connection to a remote REST resource.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class.<a name="line.41"></a> +<span class="sourceLineNo">042</span> * <p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so...<a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <p class='bcode'><a name="line.45"></a> +<span class="sourceLineNo">046</span> * RestClient client = <jk>new</jk> RestClient();<a name="line.46"></a> +<span class="sourceLineNo">047</span> * RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);<a name="line.47"></a> +<span class="sourceLineNo">048</span> * MyBean b = c.getResponse(MyBean.<jk>class</jk>);<a name="line.48"></a> +<span class="sourceLineNo">049</span> * </p><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.<a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <h5 class='section'>Additional information:</h5><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <ul><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <li><a class="doclink" href="package-summary.html#RestClient">org.apache.juneau.rest.client &gt; REST client API</a> for more information and code examples.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * </ul><a name="line.56"></a> +<span class="sourceLineNo">057</span> */<a name="line.57"></a> +<span class="sourceLineNo">058</span>@SuppressWarnings("hiding")<a name="line.58"></a> +<span class="sourceLineNo">059</span>public final class RestCall {<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> private final RestClient client; // The client that created this call.<a name="line.61"></a> +<span class="sourceLineNo">062</span> private final HttpRequestBase request; // The request.<a name="line.62"></a> +<span class="sourceLineNo">063</span> private HttpResponse response; // The response.<a name="line.63"></a> +<span class="sourceLineNo">064</span> private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> private boolean isConnected = false; // connect() has been called.<a name="line.66"></a> +<span class="sourceLineNo">067</span> private boolean allowRedirectsOnPosts;<a name="line.67"></a> +<span class="sourceLineNo">068</span> private int retries = 1;<a name="line.68"></a> +<span class="sourceLineNo">069</span> private int redirectOnPostsTries = 5;<a name="line.69"></a> +<span class="sourceLineNo">070</span> private long retryInterval = -1;<a name="line.70"></a> +<span class="sourceLineNo">071</span> private RetryOn retryOn;<a name="line.71"></a> +<span class="sourceLineNo">072</span> private boolean ignoreErrors;<a name="line.72"></a> +<span class="sourceLineNo">073</span> private boolean byLines = false;<a name="line.73"></a> +<span class="sourceLineNo">074</span> private TeeWriter writers = new TeeWriter();<a name="line.74"></a> +<span class="sourceLineNo">075</span> private StringWriter capturedResponseWriter;<a name="line.75"></a> +<span class="sourceLineNo">076</span> private String capturedResponse;<a name="line.76"></a> +<span class="sourceLineNo">077</span> private TeeOutputStream outputStreams = new TeeOutputStream();<a name="line.77"></a> +<span class="sourceLineNo">078</span> private boolean isClosed = false;<a name="line.78"></a> +<span class="sourceLineNo">079</span> private boolean isFailed = false;<a name="line.79"></a> +<span class="sourceLineNo">080</span> private Object input;<a name="line.80"></a> +<span class="sourceLineNo">081</span> private Serializer serializer;<a name="line.81"></a> +<span class="sourceLineNo">082</span> private Parser parser;<a name="line.82"></a> +<span class="sourceLineNo">083</span> private URIBuilder uriBuilder;<a name="line.83"></a> +<span class="sourceLineNo">084</span> private final ExecutorService executorService;<a name="line.84"></a> +<span class="sourceLineNo">085</span><a name="line.85"></a> +<span class="sourceLineNo">086</span> /**<a name="line.86"></a> +<span class="sourceLineNo">087</span> * Constructs a REST call with the specified method name.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @param client The client that created this request.<a name="line.89"></a> +<span class="sourceLineNo">090</span> * @param request The wrapped Apache HTTP client request object.<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param uri The URI for this call.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.<a name="line.92"></a> +<span class="sourceLineNo">093</span> */<a name="line.93"></a> +<span class="sourceLineNo">094</span> protected RestCall(RestClient client, HttpRequestBase request, URI uri) throws RestCallException {<a name="line.94"></a> +<span class="sourceLineNo">095</span> this.client = client;<a name="line.95"></a> +<span class="sourceLineNo">096</span> this.request = request;<a name="line.96"></a> +<span class="sourceLineNo">097</span> for (RestCallInterceptor i : this.client.interceptors)<a name="line.97"></a> +<span class="sourceLineNo">098</span> interceptor(i);<a name="line.98"></a> +<span class="sourceLineNo">099</span> this.retryOn = client.retryOn;<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.retries = client.retries;<a name="line.100"></a> +<span class="sourceLineNo">101</span> this.retryInterval = client.retryInterval;<a name="line.101"></a> +<span class="sourceLineNo">102</span> this.serializer = client.serializer;<a name="line.102"></a> +<span class="sourceLineNo">103</span> this.parser = client.parser;<a name="line.103"></a> +<span class="sourceLineNo">104</span> this.executorService = client.executorService;<a name="line.104"></a> +<span class="sourceLineNo">105</span> uriBuilder = new URIBuilder(uri);<a name="line.105"></a> +<span class="sourceLineNo">106</span> }<a name="line.106"></a> +<span class="sourceLineNo">107</span><a name="line.107"></a> +<span class="sourceLineNo">108</span> /**<a name="line.108"></a> +<span class="sourceLineNo">109</span> * Sets the URI for this call.<a name="line.109"></a> +<span class="sourceLineNo">110</span> * <p><a name="line.110"></a> +<span class="sourceLineNo">111</span> * Can be any of the following types:<a name="line.111"></a> +<span class="sourceLineNo">112</span> * <ul><a name="line.112"></a> +<span class="sourceLineNo">113</span> * <li>{@link URI}<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <li>{@link URL}<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <li>{@link URIBuilder}<a name="line.115"></a> +<span class="sourceLineNo">116</span> * <li>Anything else converted to a string using {@link Object#toString()}.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * </ul><a name="line.117"></a> +<span class="sourceLineNo">118</span> * Relative URL strings will be interpreted as relative to the root URL defined on the client.<a name="line.118"></a> +<span class="sourceLineNo">119</span> *<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @param uri The URI to use for this call.<a name="line.120"></a> +<span class="sourceLineNo">121</span> * This overrides the URI passed in from the client.<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @return This object (for method chaining).<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @throws RestCallException<a name="line.123"></a> +<span class="sourceLineNo">124</span> */<a name="line.124"></a> +<span class="sourceLineNo">125</span> public RestCall uri(Object uri) throws RestCallException {<a name="line.125"></a> +<span class="sourceLineNo">126</span> try {<a name="line.126"></a> +<span class="sourceLineNo">127</span> if (uri != null)<a name="line.127"></a> +<span class="sourceLineNo">128</span> uriBuilder = new URIBuilder(client.toURI(uri));<a name="line.128"></a> +<span class="sourceLineNo">129</span> return this;<a name="line.129"></a> +<span class="sourceLineNo">130</span> } catch (URISyntaxException e) {<a name="line.130"></a> +<span class="sourceLineNo">131</span> throw new RestCallException(e);<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Sets the URI scheme.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @param scheme The new URI host.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @return This object (for method chaining).<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> public RestCall scheme(String scheme) {<a name="line.141"></a> +<span class="sourceLineNo">142</span> uriBuilder.setScheme(scheme);<a name="line.142"></a> +<span class="sourceLineNo">143</span> return this;<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> /**<a name="line.146"></a> +<span class="sourceLineNo">147</span> * Sets the URI host.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @param host The new URI host.<a name="line.149"></a> +<span class="sourceLineNo">150</span> * @return This object (for method chaining).<a name="line.150"></a> +<span class="sourceLineNo">151</span> */<a name="line.151"></a> +<span class="sourceLineNo">152</span> public RestCall host(String host) {<a name="line.152"></a> +<span class="sourceLineNo">153</span> uriBuilder.setHost(host);<a name="line.153"></a> +<span class="sourceLineNo">154</span> return this;<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span><a name="line.156"></a> +<span class="sourceLineNo">157</span> /**<a name="line.157"></a> +<span class="sourceLineNo">158</span> * Sets the URI port.<a name="line.158"></a> +<span class="sourceLineNo">159</span> *<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param port The new URI port.<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @return This object (for method chaining).<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> public RestCall port(int port) {<a name="line.163"></a> +<span class="sourceLineNo">164</span> uriBuilder.setPort(port);<a name="line.164"></a> +<span class="sourceLineNo">165</span> return this;<a name="line.165"></a> +<span class="sourceLineNo">166</span> }<a name="line.166"></a> +<span class="sourceLineNo">167</span><a name="line.167"></a> +<span class="sourceLineNo">168</span> /**<a name="line.168"></a> +<span class="sourceLineNo">169</span> * Adds a parameter to the URI query.<a name="line.169"></a> +<span class="sourceLineNo">170</span> *<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @param name The parameter name.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param value The parameter value converted to a string using UON notation.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @return This object (for method chaining).<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @throws RestCallException<a name="line.174"></a> +<span class="sourceLineNo">175</span> */<a name="line.175"></a> +<span class="sourceLineNo">176</span> public RestCall param(String name, Object value) throws RestCallException {<a name="line.176"></a> +<span class="sourceLineNo">177</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.177"></a> +<span class="sourceLineNo">178</span> return this;<a name="line.178"></a> +<span class="sourceLineNo">179</span> }<a name="line.179"></a> +<span class="sourceLineNo">180</span><a name="line.180"></a> +<span class="sourceLineNo">181</span> /**<a name="line.181"></a> +<span class="sourceLineNo">182</span> * Adds parameters to the URI query.<a name="line.182"></a> +<span class="sourceLineNo">183</span> *<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.184"></a> +<span class="sourceLineNo">185</span> * @return This object (for method chaining).<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @throws RestCallException<a name="line.186"></a> +<span class="sourceLineNo">187</span> */<a name="line.187"></a> +<span class="sourceLineNo">188</span> public RestCall params(Map<String,Object> params) throws RestCallException {<a name="line.188"></a> +<span class="sourceLineNo">189</span> for (Map.Entry<String,Object> p : params.entrySet())<a name="line.189"></a> +<span class="sourceLineNo">190</span> uriBuilder.addParameter(p.getKey(), client.getUrlEncodingSerializer().serializeUrlPart(p.getValue()));<a name="line.190"></a> +<span class="sourceLineNo">191</span> return this;<a name="line.191"></a> +<span class="sourceLineNo">192</span> }<a name="line.192"></a> +<span class="sourceLineNo">193</span><a name="line.193"></a> +<span class="sourceLineNo">194</span> /**<a name="line.194"></a> +<span class="sourceLineNo">195</span> * Adds a parameter to the URI query if the parameter value is not <jk>null</jk>.<a name="line.195"></a> +<span class="sourceLineNo">196</span> *<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @param name The parameter name.<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @param value The parameter value converted to a string using UON notation.<a name="line.198"></a> +<span class="sourceLineNo">199</span> * @return This object (for method chaining).<a name="line.199"></a> +<span class="sourceLineNo">200</span> * @throws RestCallException<a name="line.200"></a> +<span class="sourceLineNo">201</span> */<a name="line.201"></a> +<span class="sourceLineNo">202</span> public RestCall paramIfNN(String name, Object value) throws RestCallException {<a name="line.202"></a> +<span class="sourceLineNo">203</span> if (value != null)<a name="line.203"></a> +<span class="sourceLineNo">204</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.204"></a> +<span class="sourceLineNo">205</span> return this;<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> /**<a name="line.208"></a> +<span class="sourceLineNo">209</span> * Adds a parameter to the URI query if the parameter value is not <jk>null</jk> or an empty string.<a name="line.209"></a> +<span class="sourceLineNo">210</span> *<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @param name The parameter name.<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @param value The parameter value converted to a string using UON notation.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @return This object (for method chaining).<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @throws RestCallException<a name="line.214"></a> +<span class="sourceLineNo">215</span> */<a name="line.215"></a> +<span class="sourceLineNo">216</span> public RestCall paramIfNE(String name, Object value) throws RestCallException {<a name="line.216"></a> +<span class="sourceLineNo">217</span> if (! StringUtils.isEmpty(value))<a name="line.217"></a> +<span class="sourceLineNo">218</span> uriBuilder.addParameter(name, client.getUrlEncodingSerializer().serializeUrlPart(value));<a name="line.218"></a> +<span class="sourceLineNo">219</span> return this;<a name="line.219"></a> +<span class="sourceLineNo">220</span> }<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> /**<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Sets a custom URI query.<a name="line.223"></a> +<span class="sourceLineNo">224</span> *<a name="line.224"></a> +<span class="sourceLineNo">225</span> * @param query The new URI query string.<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @return This object (for method chaining).<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> public RestCall query(String query) {<a name="line.228"></a> +<span class="sourceLineNo">229</span> uriBuilder.setCustomQuery(query);<a name="line.229"></a> +<span class="sourceLineNo">230</span> return this;<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<a name="line.231"></a> +<span class="sourceLineNo">232</span><a name="line.232"></a> +<span class="sourceLineNo">233</span> /**<a name="line.233"></a> +<span class="sourceLineNo">234</span> * Sets the URI user info.<a name="line.234"></a> +<span class="sourceLineNo">235</span> *<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @param userInfo The new URI user info.<a name="line.236"></a> +<span class="sourceLineNo">237</span> * @return This object (for method chaining).<a name="line.237"></a> +<span class="sourceLineNo">238</span> */<a name="line.238"></a> +<span class="sourceLineNo">239</span> public RestCall userInfo(String userInfo) {<a name="line.239"></a> +<span class="sourceLineNo">240</span> uriBuilder.setUserInfo(userInfo);<a name="line.240"></a> +<span class="sourceLineNo">241</span> return this;<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span><a name="line.243"></a> +<span class="sourceLineNo">244</span> /**<a name="line.244"></a> +<span class="sourceLineNo">245</span> * Sets the URI user info.<a name="line.245"></a> +<span class="sourceLineNo">246</span> *<a name="line.246"></a> +<span class="sourceLineNo">247</span> * @param username The new URI username.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @param password The new URI password.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @return This object (for method chaining).<a name="line.249"></a> +<span class="sourceLineNo">250</span> */<a name="line.250"></a> +<span class="sourceLineNo">251</span> public RestCall userInfo(String username, String password) {<a name="line.251"></a> +<span class="sourceLineNo">252</span> uriBuilder.setUserInfo(username, password);<a name="line.252"></a> +<span class="sourceLineNo">253</span> return this;<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> /**<a name="line.256"></a> +<span class="sourceLineNo">257</span> * Sets the input for this REST call.<a name="line.257"></a> +<span class="sourceLineNo">258</span> *<a name="line.258"></a> +<span class="sourceLineNo">259</span> * @param input The input to be sent to the REST resource (only valid for PUT and POST) requests. <br><a name="line.259"></a> +<span class="sourceLineNo">260</span> * Can be of the following types:<a name="line.260"></a> +<span class="sourceLineNo">261</span> * <ul class='spaced-list'><a name="line.261"></a> +<span class="sourceLineNo">262</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.262"></a> +<span class="sourceLineNo">263</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.265"></a> +<span class="sourceLineNo">266</span> * </ul><a name="line.266"></a> +<span class="sourceLineNo">267</span> * @return This object (for method chaining).<a name="line.267"></a> +<span class="sourceLineNo">268</span> * @throws RestCallException If a retry was attempted, but the entity was not repeatable.<a name="line.268"></a> +<span class="sourceLineNo">269</span> */<a name="line.269"></a> +<span class="sourceLineNo">270</span> public RestCall input(final Object input) throws RestCallException {<a name="line.270"></a> +<span class="sourceLineNo">271</span> this.input = input;<a name="line.271"></a> +<span class="sourceLineNo">272</span> return this;<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> /**<a name="line.275"></a> +<span class="sourceLineNo">276</span> * Specifies the serializer to use on this call.<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <p><a name="line.277"></a> +<span class="sourceLineNo">278</span> * Overrides the serializer specified on the {@link RestClient}.<a name="line.278"></a> <span class="sourceLineNo">279</span> *<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @param username The new URI username.<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @param password The new URI password.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * @return This object (for method chaining).<a name="line.282"></a> -<span class="sourceLineNo">283</span> */<a name="line.283"></a> -<span class="sourceLineNo">284</span> public RestCall userInfo(String username, String password) {<a name="line.284"></a> -<span class="sourceLineNo">285</span> uriBuilder.setUserInfo(username, password);<a name="line.285"></a> -<span class="sourceLineNo">286</span> return this;<a name="line.286"></a> -<span class="sourceLineNo">287</span> }<a name="line.287"></a> -<span class="sourceLineNo">288</span><a name="line.288"></a> -<span class="sourceLineNo">289</span> /**<a name="line.289"></a> -<span class="sourceLineNo">290</span> * Sets the input for this REST call.<a name="line.290"></a> -<span class="sourceLineNo">291</span> *<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @param input The input to be sent to the REST resource (only valid for PUT and POST) requests. <br><a name="line.292"></a> -<span class="sourceLineNo">293</span> * Can be of the following types:<a name="line.293"></a> -<span class="sourceLineNo">294</span> * <ul class='spaced-list'><a name="line.294"></a> -<span class="sourceLineNo">295</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.295"></a> -<span class="sourceLineNo">296</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.296"></a> -<span class="sourceLineNo">297</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.297"></a> -<span class="sourceLineNo">298</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.298"></a> -<span class="sourceLineNo">299</span> * </ul><a name="line.299"></a> -<span class="sourceLineNo">300</span> * @return This object (for method chaining).<a name="line.300"></a> -<span class="sourceLineNo">301</span> * @throws RestCallException If a retry was attempted, but the entity was not repeatable.<a name="line.301"></a> -<span class="sourceLineNo">302</span> */<a name="line.302"></a> -<span class="sourceLineNo">303</span> public RestCall input(final Object input) throws RestCallException {<a name="line.303"></a> -<span class="sourceLineNo">304</span> this.input = input;<a name="line.304"></a> -<span class="sourceLineNo">305</span> return this;<a name="line.305"></a> -<span class="sourceLineNo">306</span> }<a name="line.306"></a> -<span class="sourceLineNo">307</span><a name="line.307"></a> -<span class="sourceLineNo">308</span> /**<a name="line.308"></a> -<span class="sourceLineNo">309</span> * Specifies the serializer to use on this call.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * <p><a name="line.310"></a> -<span class="sourceLineNo">311</span> * Overrides the serializer specified on the {@link RestClient}.<a name="line.311"></a> -<span class="sourceLineNo">312</span> *<a name="line.312"></a> -<span class="sourceLineNo">313</span> * @param serializer The serializer used to serialize POJOs to the body of the HTTP request.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @return This object (for method chaining).<a name="line.314"></a> -<span class="sourceLineNo">315</span> */<a name="line.315"></a> -<span class="sourceLineNo">316</span> public RestCall serializer(Serializer serializer) {<a name="line.316"></a> -<span class="sourceLineNo">317</span> this.serializer = serializer;<a name="line.317"></a> -<span class="sourceLineNo">318</span> return this;<a name="line.318"></a> -<span class="sourceLineNo">319</span> }<a name="line.319"></a> -<span class="sourceLineNo">320</span><a name="line.320"></a> -<span class="sourceLineNo">321</span> /**<a name="line.321"></a> -<span class="sourceLineNo">322</span> * Specifies the parser to use on this call.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * <p><a name="line.323"></a> -<span class="sourceLineNo">324</span> * Overrides the parser specified on the {@link RestClient}.<a name="line.324"></a> -<span class="sourceLineNo">325</span> *<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @param parser The parser used to parse POJOs from the body of the HTTP response.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * @return This object (for method chaining).<a name="line.327"></a> -<span class="sourceLineNo">328</span> */<a name="line.328"></a> -<span class="sourceLineNo">329</span> public RestCall parser(Parser parser) {<a name="line.329"></a> -<span class="sourceLineNo">330</span> this.parser = parser;<a name="line.330"></a> -<span class="sourceLineNo">331</span> return this;<a name="line.331"></a> -<span class="sourceLineNo">332</span> }<a name="line.332"></a> -<span class="sourceLineNo">333</span><a name="line.333"></a> -<span class="sourceLineNo">334</span><a name="line.334"></a> -<span class="sourceLineNo">335</span> //--------------------------------------------------------------------------------<a name="line.335"></a> -<span class="sourceLineNo">336</span> // HTTP headers<a name="line.336"></a> -<span class="sourceLineNo">337</span> //--------------------------------------------------------------------------------<a name="line.337"></a> -<span class="sourceLineNo">338</span><a name="line.338"></a> -<span class="sourceLineNo">339</span> /**<a name="line.339"></a> -<span class="sourceLineNo">340</span> * Convenience method for setting a header value on the request.<a name="line.340"></a> -<span class="sourceLineNo">341</span> * <p><a name="line.341"></a> -<span class="sourceLineNo">342</span> * Equivalent to calling <code>restCall.getRequest().setHeader(name, value.toString())</code>.<a name="line.342"></a> -<span class="sourceLineNo">343</span> *<a name="line.343"></a> -<span class="sourceLineNo">344</span> * @param name The header name.<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @param value The header value.<a name="line.345"></a> -<span class="sourceLineNo">346</span> * @return This object (for method chaining).<a name="line.346"></a> -<span class="sourceLineNo">347</span> */<a name="line.347"></a> -<span class="sourceLineNo">348</span> public RestCall header(String name, Object value) {<a name="line.348"></a> -<span class="sourceLineNo">349</span> request.setHeader(name, value.toString());<a name="line.349"></a> -<span class="sourceLineNo">350</span> return this;<a name="line.350"></a> -<span class="sourceLineNo">351</span> }<a name="line.351"></a> -<span class="sourceLineNo">352</span><a name="line.352"></a> -<span class="sourceLineNo">353</span> /**<a name="line.353"></a> -<span class="sourceLineNo">354</span> * Sets the value for the <code>Accept</code> request header.<a name="line.354"></a> -<span class="sourceLineNo">355</span> * <p><a name="line.355"></a> -<span class="sourceLineNo">356</span> * This overrides the media type specified on the parser, but is overridden by calling <code>header(<js>"Accept"</js>, value);</code><a name="line.356"></a> -<span class="sourceLineNo">357</span> *<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @param value The new header value.<a name="line.358"></a> -<span class="sourceLineNo">359</span> * @return This object (for method chaining).<a name="line.359"></a> -<span class="sourceLineNo">360</span> */<a name="line.360"></a> -<span class="sourceLineNo">361</span> public RestCall accept(Object value) {<a name="line.361"></a> -<span class="sourceLineNo">362</span> return header("Accept", value);<a name="line.362"></a> -<span class="sourceLineNo">363</span> }<a name="line.363"></a> -<span class="sourceLineNo">364</span><a name="line.364"></a> -<span class="sourceLineNo">365</span> /**<a name="line.365"></a> -<span class="sourceLineNo">366</span> * Sets the value for the <code>Accept-Charset</code> request header.<a name="line.366"></a> -<span class="sourceLineNo">367</span> * <p><a name="line.367"></a> -<span class="sourceLineNo">368</span> * This is a shortcut for calling <code>header(<js>"Accept-Charset"</js>, value);</code><a name="line.368"></a> -<span class="sourceLineNo">369</span> *<a name="line.369"></a> -<span class="sourceLineNo">370</span> * @param value The new header value.<a name="line.370"></a> -<span class="sourceLineNo">371</span> * @return This object (for method chaining).<a name="line.371"></a> -<span class="sourceLineNo">372</span> */<a name="line.372"></a> -<span class="sourceLineNo">373</span> public RestCall acceptCharset(Object value) {<a name="line.373"></a> -<span class="sourceLineNo">374</span> return header("Accept-Charset", value);<a name="line.374"></a> -<span class="sourceLineNo">375</span> }<a name="line.375"></a> -<span class="sourceLineNo">376</span><a name="line.376"></a> -<span class="sourceLineNo">377</span> /**<a name="line.377"></a> -<span class="sourceLineNo">378</span> * Sets the value for the <code>Accept-Encoding</code> request header.<a name="line.378"></a> -<span class="sourceLineNo">379</span> * <p><a name="line.379"></a> -<span class="sourceLineNo">380</span> * This is a shortcut for calling <code>header(<js>"Accept-Encoding"</js>, value);</code><a name="line.380"></a> -<span class="sourceLineNo">381</span> *<a name="line.381"></a> -<span class="sourceLineNo">382</span> * @param value The new header value.<a name="line.382"></a> -<span class="sourceLineNo">383</span> * @return This object (for method chaining).<a name="line.383"></a> -<span class="sourceLineNo">384</span> */<a name="line.384"></a> -<span class="sourceLineNo">385</span> public RestCall acceptEncoding(Object value) {<a name="line.385"></a> -<span class="sourceLineNo">386</span> return header("Accept-Encoding", value);<a name="line.386"></a> -<span class="sourceLineNo">387</span> }<a name="line.387"></a> -<span class="sourceLineNo">388</span><a name="line.388"></a> -<span class="sourceLineNo">389</span> /**<a name="line.389"></a> -<span class="sourceLineNo">390</span> * Sets the value for the <code>Accept-Language</code> request header.<a name="line.390"></a> -<span class="sourceLineNo">391</span> * <p><a name="line.391"></a> -<span class="sourceLineNo">392</span> * This is a shortcut for calling <code>header(<js>"Accept-Language"</js>, value);</code><a name="line.392"></a> -<span class="sourceLineNo">393</span> *<a name="line.393"></a> -<span class="sourceLineNo">394</span> * @param value The new header value.<a name="line.394"></a> -<span class="sourceLineNo">395</span> * @return This object (for method chaining).<a name="line.395"></a> -<span class="sourceLineNo">396</span> */<a name="line.396"></a> -<span class="sourceLineNo">397</span> public RestCall acceptLanguage(Object value) {<a name="line.397"></a> -<span class="sourceLineNo">398</span> return header("Accept-Language", value);<a name="line.398"></a> -<span class="sourceLineNo">399</span> }<a name="line.399"></a> -<span class="sourceLineNo">400</span><a name="line.400"></a> -<span class="sourceLineNo">401</span> /**<a name="line.401"></a> -<span class="sourceLineNo">402</span> * Sets the value for the <code>Authorization</code> request header.<a name="line.402"></a> -<span class="sourceLineNo">403</span> * <p><a name="line.403"></a> -<span class="sourceLineNo">404</span> * This is a shortcut for calling <code>header(<js>"Authorization"</js>, value);</code><a name="line.404"></a> -<span class="sourceLineNo">405</span> *<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @param value The new header value.<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @return This object (for method chaining).<a name="line.407"></a> -<span class="sourceLineNo">408</span> */<a name="line.408"></a> -<span class="sourceLineNo">409</span> public RestCall authorization(Object value) {<a name="line.409"></a> -<span class="sourceLineNo">410</span> return header("Authorization", value);<a name="line.410"></a> -<span class="sourceLineNo">411</span> }<a name="line.411"></a> -<span class="sourceLineNo">412</span><a name="line.412"></a> -<span class="sourceLineNo">413</span> /**<a name="line.413"></a> -<span class="sourceLineNo">414</span> * Sets the value for the <code>Cache-Control</code> request header.<a name="line.414"></a> -<span class="sourceLineNo">415</span> * <p><a name="line.415"></a> -<span class="sourceLineNo">416</span> * This is a shortcut for calling <code>header(<js>"Cache-Control"</js>, value);</code><a name="line.416"></a> -<span class="sourceLineNo">417</span> *<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @param value The new header value.<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @return This object (for method chaining).<a name="line.419"></a> -<span class="sourceLineNo">420</span> */<a name="line.420"></a> -<span class="sourceLineNo">421</span> public RestCall cacheControl(Object value) {<a name="line.421"></a> -<span class="sourceLineNo">422</span> return header("Cache-Control", value);<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> /**<a name="line.425"></a> -<span class="sourceLineNo">426</span> * Sets the value for the <code>Connection</code> request header.<a name="line.426"></a> -<span class="sourceLineNo">427</span> * <p><a name="line.427"></a> -<span class="sourceLineNo">428</span> * This is a shortcut for calling <code>header(<js>"Connection"</js>, value);</code><a name="line.428"></a> -<span class="sourceLineNo">429</span> *<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param value The new header value.<a name="line.430"></a> -<span class="sourceLineNo">431</span> * @return This object (for method chaining).<a name="line.431"></a> -<span class="sourceLineNo">432</span> */<a name="line.432"></a> -<span class="sourceLineNo">433</span> public RestCall connection(Object value) {<a name="line.433"></a> -<span class="sourceLineNo">434</span> return header("Connection", value);<a name="line.434"></a> -<span class="sourceLineNo">435</span> }<a name="line.435"></a> -<span class="sourceLineNo">436</span><a name="line.436"></a> -<span class="sourceLineNo">437</span> /**<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Sets the value for the <code>Content-Length</code> request header.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * <p><a name="line.439"></a> -<span class="sourceLineNo">440</span> * This is a shortcut for calling <code>header(<js>"Content-Length"</js>, value);</code><a name="line.440"></a> -<span class="sourceLineNo">441</span> *<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @param value The new header value.<a name="line.442"></a> -<span class="sourceLineNo">443</span> * @return This object (for method chaining).<a name="line.443"></a> -<span class="sourceLineNo">444</span> */<a name="line.444"></a> -<span class="sourceLineNo">445</span> public RestCall contentLength(Object value) {<a name="line.445"></a> -<span class="sourceLineNo">446</span> return header("Content-Length", value);<a name="line.446"></a> -<span class="sourceLineNo">447</span> }<a name="line.447"></a> -<span class="sourceLineNo">448</span><a name="line.448"></a> -<span class="sourceLineNo">449</span> /**<a name="line.449"></a> -<span class="sourceLineNo">450</span> * Sets the value for the <code>Content-Type</code> request header.<a name="line.450"></a> -<span class="sourceLineNo">451</span> * <p><a name="line.451"></a> -<span class="sourceLineNo">452</span> * This overrides the media type specified on the serializer, but is overridden by calling <code>header(<js>"Content-Type"</js>, value);</code><a name="line.452"></a> -<span class="sourceLineNo">453</span> *<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param value The new header value.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * @return This object (for method chaining).<a name="line.455"></a> -<span class="sourceLineNo">456</span> */<a name="line.456"></a> -<span class="sourceLineNo">457</span> public RestCall contentType(Object value) {<a name="line.457"></a> -<span class="sourceLineNo">458</span> return header("Content-Type", value);<a name="line.458"></a> -<span class="sourceLineNo">459</span> }<a name="line.459"></a> -<span class="sourceLineNo">460</span><a name="line.460"></a> -<span class="sourceLineNo">461</span> /**<a name="line.461"></a> -<span class="sourceLineNo">462</span> * Sets the value for the <code>Date</code> request header.<a name="line.462"></a> -<span class="sourceLineNo">463</span> * <p><a name="line.463"></a> -<span class="sourceLineNo">464</span> * This is a shortcut for calling <code>header(<js>"Date"</js>, value);</code><a name="line.464"></a> -<span class="sourceLineNo">465</span> *<a name="line.465"></a> -<span class="sourceLineNo">466</span> * @param value The new header value.<a name="line.466"></a> -<span class="sourceLineNo">467</span> * @return This object (for method chaining).<a name="line.467"></a> -<span class="sourceLineNo">468</span> */<a name="line.468"></a> -<span class="sourceLineNo">469</span> public RestCall date(Object value) {<a name="line.469"></a> -<span class="sourceLineNo">470</span> return header("Date", value);<a name="line.470"></a> -<span class="sourceLineNo">471</span> }<a name="line.471"></a> -<span class="sourceLineNo">472</span><a name="line.472"></a> -<span class="sourceLineNo">473</span> /**<a name="line.473"></a> -<span class="sourceLineNo">474</span> * Sets the value for the <code>Expect</code> request header.<a name="line.474"></a> -<span class="sourceLineNo">475</span> * <p><a name="line.475"></a> -<span class="sourceLineNo">476</span> * This is a shortcut for calling <code>header(<js>"Expect"</js>, value);</code><a name="line.476"></a> -<span class="sourceLineNo">477</span> *<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param value The new header value.<a name="line.478"></a> -<span class="sourceLineNo">479</span> * @return This object (for method chaining).<a name="line.479"></a> -<span class="sourceLineNo">480</span> */<a name="line.480"></a> -<span class="sourceLineNo">481</span> public RestCall expect(Object value) {<a name="line.481"></a> -<span class="sourceLineNo">482</span> return header("Expect", value);<a name="line.482"></a> -<span class="sourceLineNo">483</span> }<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> * Sets the value for the <code>Forwarded</code> request header.<a name="line.486"></a> -<span class="sourceLineNo">487</span> * <p><a name="line.487"></a> -<span class="sourceLineNo">488</span> * This is a shortcut for calling <code>header(<js>"Forwarded"</js>, value);</code><a name="line.488"></a> -<span class="sourceLineNo">489</span> *<a name="line.489"></a> -<span class="sourceLineNo">490</span> * @param value The new header value.<a name="line.490"></a> -<span class="sourceLineNo">491</span> * @return This object (for method chaining).<a name="line.491"></a> -<span class="sourceLineNo">492</span> */<a name="line.492"></a> -<span class="sourceLineNo">493</span> public RestCall forwarded(Object value) {<a name="line.493"></a> -<span class="sourceLineNo">494</span> return header("Forwarded", value);<a name="line.494"></a> -<span class="sourceLineNo">495</span> }<a name="line.495"></a> -<span class="sourceLineNo">496</span><a name="line.496"></a> -<span class="sourceLineNo">497</span> /**<a name="line.497"></a> -<span class="sourceLineNo">498</span> * Sets the value for the <code>From</code> request header.<a name="line.498"></a> -<span class="sourceLineNo">499</span> * <p><a name="line.499"></a> -<span class="sourceLineNo">500</span> * This is a shortcut for calling <code>header(<js>"From"</js>, value);</code><a name="line.500"></a> -<span class="sourceLineNo">501</span> *<a name="line.501"></a> -<span class="sourceLineNo">502</span> * @param value The new header value.<a name="line.502"></a> -<span class="sourceLineNo">503</span> * @return This object (for method chaining).<a name="line.503"></a> -<span class="sourceLineNo">504</span> */<a name="line.504"></a> -<span class="sourceLineNo">505</span> public RestCall from(Object value) {<a name="line.505"></a> -<span class="sourceLineNo">506</span> return header("From", value);<a name="line.506"></a> -<span class="sourceLineNo">507</span> }<a name="line.507"></a> -<span class="sourceLineNo">508</span><a name="line.508"></a> -<span class="sourceLineNo">509</span> /**<a name="line.509"></a> -<span class="sourceLineNo">510</span> * Sets the value for the <code>Host</code> request header.<a name="line.510"></a> -<span class="sourceLineNo">511</span> * <p><a name="line.511"></a> -<span class="sourceLineNo">512</span> * This is a shortcut for calling <code>header(<js>"Host"</js>, value);</code><a name="line.512"></a> -<span class="sourceLineNo">513</span> *<a name="line.513"></a> -<span class="sourceLineNo">514</span> * @param value The new header value.<a name="line.514"></a> -<span class="sourceLineNo">515</span> * @return This object (for method chaining).<a name="line.515"></a> -<span class="sourceLineNo">516</span> */<a name="line.516"></a> -<span class="sourceLineNo">517</span> public RestCall host(Object value) {<a name="line.517"></a> -<span class="sourceLineNo">518</span> return header("Host", value);<a name="line.518"></a> -<span class="sourceLineNo">519</span> }<a name="line.519"></a> -<span class="sourceLineNo">520</span><a name="line.520"></a> -<span class="sourceLineNo">521</span> /**<a name="line.521"></a> -<span class="sourceLineNo">522</span> * Sets the value for the <code>If-Match</code> request header.<a name="line.522"></a> -<span class="sourceLineNo">523</span> * <p><a name="line.523"></a> -<span class="sourceLineNo">524</span> * This is a shortcut for calling <code>header(<js>"If-Match"</js>, value);</code><a name="line.524"></a> -<span class="sourceLineNo">525</span> *<a name="line.525"></a> -<span class="sourceLineNo">526</span> * @param value The new header value.<a name="line.526"></a> -<span class="sourceLineNo">527</span> * @return This object (for method chaining).<a name="line.527"></a> -<span class="sourceLineNo">528</span> */<a name="line.528"></a> -<span class="sourceLineNo">529</span> public RestCall ifMatch(Object value) {<a name="line.529"></a> -<span class="sourceLineNo">530</span> return header("If-Match", value);<a name="line.530"></a> -<span class="sourceLineNo">531</span> }<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> * Sets the value for the <code>If-Modified-Since</code> request header.<a name="line.534"></a> -<span class="sourceLineNo">535</span> * <p><a name="line.535"></a> -<span class="sourceLineNo">536</span> * This is a shortcut for calling <code>header(<js>"If-Modified-Since"</js>, value);</code><a name="line.536"></a> -<span class="sourceLineNo">537</span> *<a name="line.537"></a> -<span class="sourceLineNo">538</span> * @param value The new header value.<a name="line.538"></a> -<span class="sourceLineNo">539</span> * @return This object (for method chaining).<a name="line.539"></a> -<span class="sourceLineNo">540</span> */<a name="line.540"></a> -<span class="sourceLineNo">541</span> public RestCall ifModifiedSince(Object value) {<a name="line.541"></a> -<span class="sourceLineNo">542</span> return header("If-Modified-Since", value);<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> /**<a name="line.545"></a> -<span class="sourceLineNo">546</span> * Sets the value for the <code>If-None-Match</code> request header.<a name="line.546"></a> -<span class="sourceLineNo">547</span> * <p><a name="line.547"></a> -<span class="sourceLineNo">548</span> * This is a shortcut for calling <code>header(<js>"If-None-Match"</js>, value);</code><a name="line.548"></a> -<span class="sourceLineNo">549</span> *<a name="line.549"></a> -<span class="sourceLineNo">550</span> * @param value The new header value.<a name="line.550"></a> -<span class="sourceLineNo">551</span> * @return This object (for method chaining).<a name="line.551"></a> -<span class="sourceLineNo">552</span> */<a name="line.552"></a> -<span class="sourceLineNo">553</span> public RestCall ifNoneMatch(Object value) {<a name="line.553"></a> -<span class="sourceLineNo">554</span> return header("If-None-Match", value);<a name="line.554"></a> -<span class="sourceLineNo">555</span> }<a name="line.555"></a> -<span class="sourceLineNo">556</span><a name="line.556"></a> -<span class="sourceLineNo">557</span> /**<a name="line.557"></a> -<span class="sourceLineNo">558</span> * Sets the value for the <code>If-Range</code> request header.<a name="line.558"></a> -<span class="sourceLineNo">559</span> * <p><a name="line.559"></a> -<span class="sourceLineNo">560</span> * This is a shortcut for calling <code>header(<js>"If-Range"</js>, value);</code><a name="line.560"></a> -<span class="sourceLineNo">561</span> *<a name="line.561"></a> -<span class="sourceLineNo">562</span> * @param value The new header value.<a name="line.562"></a> -<span class="sourceLineNo">563</span> * @return This object (for method chaining).<a name="line.563"></a> -<span class="sourceLineNo">564</span> */<a name="line.564"></a> -<span class="sourceLineNo">565</span> public RestCall ifRange(Object value) {<a name="line.565"></a> -<span class="sourceLineNo">566</span> return header("If-Range", value);<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> /**<a name="line.569"></a> -<span class="sourceLineNo">570</span> * Sets the value for the <code>If-Unmodified-Since</code> request header.<a name="line.570"></a> -<span class="sourceLineNo">571</span> * <p><a name="line.571"></a> -<span class="sourceLineNo">572</span> * This is a shortcut for calling <code>header(<js>"If-Unmodified-Since"</js>, value);</code><a name="line.572"></a> -<span class="sourceLineNo">573</span> *<a name="line.573"></a> -<span class="sourceLineNo">574</span> * @param value The new header value.<a name="line.574"></a> -<span class="sourceLineNo">575</span> * @return This object (for method chaining).<a name="line.575"></a> -<span class="sourceLineNo">576</span> */<a name="line.576"></a> -<span class="sourceLineNo">577</span> public RestCall ifUnmodifiedSince(Object value) {<a name="line.577"></a> -<span class="sourceLineNo">578</span> return header("If-Unmodified-Since", value);<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> /**<a name="line.581"></a> -<span class="sourceLineNo">582</span> * Sets the value for the <code>Max-Forwards</code> request header.<a name="line.582"></a> -<span class="sourceLineNo">583</span> * <p><a name="line.583"></a> -<span class="sourceLineNo">584</span> * This is a shortcut for calling <code>header(<js>"Max-Forwards"</js>, value);</code><a name="line.584"></a> -<span class="sourceLineNo">585</span> *<a name="line.585"></a> -<span class="sourceLineNo">586</span> * @param value The new header value.<a name="line.586"></a> -<span class="sourceLineNo">587</span> * @return This object (for method chaining).<a name="line.587"></a> -<span class="sourceLineNo">588</span> */<a name="line.588"></a> -<span class="sourceLineNo">589</span> public RestCall maxForwards(Object value) {<a name="line.589"></a> -<span class="sourceLineNo">590</span> return header("If-Unmodified-Since", value);<a name="line.590"></a> -<span class="sourceLineNo">591</span> }<a name="line.591"></a> -<span class="sourceLineNo">592</span><a name="line.592"></a> -<span class="sourceLineNo">593</span> /**<a name="line.593"></a> -<span class="sourceLineNo">594</span> * Sets the value for the <code>Origin</code> request header.<a name="line.594"></a> -<span class="sourceLineNo">595</span> * <p><a name="line.595"></a> -<span class="sourceLineNo">596</span> * This is a shortcut for calling <code>header(<js>"Origin"</js>, value);</code><a name="line.596"></a> -<span class="sourceLineNo">597</span> *<a name="line.597"></a> -<span class="sourceLineNo">598</span> * @param value The new header value.<a name="line.598"></a> -<span class="sourceLineNo">599</span> * @return This object (for method chaining).<a name="line.599"></a> -<span class="sourceLineNo">600</span> */<a name="line.600"></a> -<span class="sourceLineNo">601</span> public RestCall origin(Object value) {<a name="line.601"></a> -<span class="sourceLineNo">602</span> return header("If-Unmodified-Since", value);<a name="line.602"></a> -<span class="sourceLineNo">603</span> }<a name="line.603"></a> -<span class="sourceLineNo">604</span><a name="line.604"></a> -<span class="sourceLineNo">605</span> /**<a name="line.605"></a> -<span class="sourceLineNo">606</span> * Sets the value for the <code>Pragma</code> request header.<a name="line.606"></a> -<span class="sourceLineNo">607</span> * <p><a name="line.607"></a> -<span class="sourceLineNo">608</span> * This is a shortcut for calling <code>header(<js>"Pragma"</js>, value);</code><a name="line.608"></a> -<span class="sourceLineNo">609</span> *<a name="line.609"></a> -<span class="sourceLineNo">610</span> * @param value The new header value.<a name="line.610"></a> -<span class="sourceLineNo">611</span> * @return This object (for method chaining).<a name="line.611"></a> -<span class="sourceLineNo">612</span> */<a name="line.612"></a> -<span class="sourceLineNo">613</span> public RestCall pragma(Object value) {<a name="line.613"></a> -<span class="sourceLineNo">614</span> return header("Pragma", value);<a name="line.614"></a> -<span class="sourceLineNo">615</span> }<a name="line.615"></a> -<span class="sourceLineNo">616</span><a name="line.616"></a> -<span class="sourceLineNo">617</span> /**<a name="line.617"></a> -<span class="sourceLineNo">618</span> * Sets the value for the <code>Proxy-Authorization</code> request header.<a name="line.618"></a> -<span class="sourceLineNo">619</span> * <p><a name="line.619"></a> -<span class="sourceLineNo">620</span> * This is a shortcut for calling <code>header(<js>"Proxy-Authorization"</js>, value);</code><a name="line.620"></a> -<span class="sourceLineNo">621</span> *<a name="line.621"></a> -<span class="sourceLineNo">622</span> * @param value The new header value.<a name="line.622"></a> -<span class="sourceLineNo">623</span> * @return This object (for method chaining).<a name="line.623"></a> -<span class="sourceLineNo">624</span> */<a name="line.624"></a> -<span class="sourceLineNo">625</span> public RestCall proxyAuthorization(Object value) {<a name="line.625"></a> -<span class="sourceLineNo">626</span> return header("Proxy-Authorization", value);<a name="line.626"></a> -<span class="sourceLineNo">627</span> }<a name="line.627"></a> -<span class="sourceLineNo">628</span><a name="line.628"></a> -<span class="sourceLineNo">629</span> /**<a name="line.629"></a> -<span class="sourceLineNo">630</span> * Sets the value for the <code>Range</code> request header.<a name="line.630"></a> -<span class="sourceLineNo">631</span> * <p><a name="line.631"></a> -<span class="sourceLineNo">632</span> * This is a shortcut for calling <code>header(<js>"Range"</js>, value);</code><a name="line.632"></a> -<span class="sourceLineNo">633</span> *<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param value The new header value.<a name="line.634"></a> -<span class="sourceLineNo">635</span> * @return This object (for method chaining).<a name="line.635"></a> -<span class="sourceLineNo">636</span> */<a name="line.636"></a> -<span class="sourceLineNo">637</span> public RestCall range(Object value) {<a name="line.637"></a> -<span class="sourceLineNo">638</span> return header("Range", value);<a name="line.638"></a> -<span class="sourceLineNo">639</span> }<a name="line.639"></a> -<span class="sourceLineNo">640</span><a name="line.640"></a> -<span class="sourceLineNo">641</span> /**<a name="line.641"></a> -<span class="sourceLineNo">642</span> * Sets the value for the <code>Referer</code> request header.<a name="line.642"></a> -<span class="sourceLineNo">643</span> * <p><a name="line.643"></a> -<span class="sourceLineNo">644</span> * This is a shortcut for calling <code>header(<js>"Referer"</js>, value);</code><a name="line.644"></a> -<span class="sourceLineNo">645</span> *<a name="line.645"></a> -<span class="sourceLineNo">646</span> * @param value The new header value.<a name="line.646"></a> -<span class="sourceLineNo">647</span> * @return This object (for method chaining).<a name="line.647"></a> -<span class="sourceLineNo">648</span> */<a name="line.648"></a> -<span class="sourceLineNo">649</span> public RestCall referer(Object value) {<a name="line.649"></a> -<span class="sourceLineNo">650</span> return header("Referer", value);<a name="line.650"></a> -<span class="sourceLineNo">651</span> }<a name="line.651"></a> -<span class="sourceLineNo">652</span><a name="line.652"></a> -<span class="sourceLineNo">653</span> /**<a name="line.653"></a> -<span class="sourceLineNo">654</span> * Sets the value for the <code>TE</code> request header.<a name="line.654"></a> -<span class="sourceLineNo">655</span> * <p><a name="line.655"></a> -<span class="sourceLineNo">656</span> * This is a shortcut for calling <code>header(<js>"TE"</js>, value);</code><a name="line.656"></a> -<span class="sourceLineNo">657</span> *<a name="line.657"></a> -<span class="sourceLineNo">658</span> * @param value The new header value.<a name="line.658"></a> -<span class="sourceLineNo">659</span> * @return This object (for method chaining).<a name="line.659"></a> -<span class="sourceLineNo">660</span> */<a name="line.660"></a> -<span class="sourceLineNo">661</span> public RestCall te(Object value) {<a name="line.661"></a> -<span class="sourceLineNo">662</span> return header("TE", value);<a name="line.662"></a> -<span class="sourceLineNo">663</span> }<a name="line.663"></a> -<span class="sourceLineNo">664</span><a name="line.664"></a> -<span class="sourceLineNo">665</span> /**<a name="line.665"></a> -<span class="sourceLineNo">666</span> * Sets the value for the <code>User-Agent</code> request header.<a name="line.666"></a> -<span class="sourceLineNo">667</span> * <p><a name="line.667"></a> -<span class="sourceLineNo">668</span> * This is a shortcut for calling <code>header(<js>"User-Agent"</js>, value);</code><a name="line.668"></a> -<span class="sourceLineNo">669</span> *<a name="line.669"></a> -<span class="sourceLineNo">670</span> * @param value The new header value.<a name="line.670"></a> -<span class="sourceLineNo">671</span> * @return This object (for method chaining).<a name="line.671"></a> -<span class="sourceLineNo">672</span> */<a name="line.672"></a> -<span class="sourceLineNo">673</span> public RestCall userAgent(Object value) {<a name="line.673"></a> -<span class="sourceLineNo">674</span> return header("User-Agent", value);<a name="line.674"></a> -<span class="sourceLineNo">675</span> }<a name="line.675"></a> -<span class="sourceLineNo">676</span><a name="line.676"></a> -<span class="sourceLineNo">677</span> /**<a name="line.677"></a> -<span
<TRUNCATED>
