http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/19e9b7df/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 9d04144..cf54be0 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 @@ -36,1919 +36,1937 @@ <span class="sourceLineNo">028</span>import org.apache.http.client.entity.*;<a name="line.28"></a> <span class="sourceLineNo">029</span>import org.apache.http.client.methods.*;<a name="line.29"></a> <span class="sourceLineNo">030</span>import org.apache.http.client.utils.*;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.http.impl.client.*;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.http.util.*;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.juneau.*;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.juneau.encoders.*;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.juneau.internal.*;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.juneau.parser.*;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.juneau.parser.ParseException;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.juneau.serializer.*;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.juneau.utils.*;<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span>/**<a name="line.41"></a> -<span class="sourceLineNo">042</span> * Represents a connection to a remote REST resource.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> -<span class="sourceLineNo">044</span> * Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * <p><a name="line.45"></a> -<span class="sourceLineNo">046</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.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * <p class='bcode'><a name="line.48"></a> -<span class="sourceLineNo">049</span> * RestClient client = <jk>new</jk> RestClient();<a name="line.49"></a> -<span class="sourceLineNo">050</span> * RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);<a name="line.50"></a> -<span class="sourceLineNo">051</span> * MyBean b = c.getResponse(MyBean.<jk>class</jk>);<a name="line.51"></a> -<span class="sourceLineNo">052</span> * </p><a name="line.52"></a> -<span class="sourceLineNo">053</span> * <p><a name="line.53"></a> -<span class="sourceLineNo">054</span> * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.<a name="line.54"></a> -<span class="sourceLineNo">055</span> *<a name="line.55"></a> -<span class="sourceLineNo">056</span> * <h5 class='section'>Additional information:</h5><a name="line.56"></a> -<span class="sourceLineNo">057</span> * <ul><a name="line.57"></a> -<span class="sourceLineNo">058</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.58"></a> -<span class="sourceLineNo">059</span> * </ul><a name="line.59"></a> -<span class="sourceLineNo">060</span> */<a name="line.60"></a> -<span class="sourceLineNo">061</span>@SuppressWarnings({ "hiding", "unchecked" })<a name="line.61"></a> -<span class="sourceLineNo">062</span>public final class RestCall {<a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> -<span class="sourceLineNo">064</span> private final RestClient client; // The client that created this call.<a name="line.64"></a> -<span class="sourceLineNo">065</span> private final HttpRequestBase request; // The request.<a name="line.65"></a> -<span class="sourceLineNo">066</span> private HttpResponse response; // The response.<a name="line.66"></a> -<span class="sourceLineNo">067</span> private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> private boolean isConnected = false; // connect() has been called.<a name="line.69"></a> -<span class="sourceLineNo">070</span> private boolean allowRedirectsOnPosts;<a name="line.70"></a> -<span class="sourceLineNo">071</span> private int retries = 1;<a name="line.71"></a> -<span class="sourceLineNo">072</span> private int redirectOnPostsTries = 5;<a name="line.72"></a> -<span class="sourceLineNo">073</span> private long retryInterval = -1;<a name="line.73"></a> -<span class="sourceLineNo">074</span> private RetryOn retryOn;<a name="line.74"></a> -<span class="sourceLineNo">075</span> private boolean ignoreErrors;<a name="line.75"></a> -<span class="sourceLineNo">076</span> private boolean byLines = false;<a name="line.76"></a> -<span class="sourceLineNo">077</span> private TeeWriter writers = new TeeWriter();<a name="line.77"></a> -<span class="sourceLineNo">078</span> private StringWriter capturedResponseWriter;<a name="line.78"></a> -<span class="sourceLineNo">079</span> private String capturedResponse;<a name="line.79"></a> -<span class="sourceLineNo">080</span> private TeeOutputStream outputStreams = new TeeOutputStream();<a name="line.80"></a> -<span class="sourceLineNo">081</span> private boolean isClosed = false;<a name="line.81"></a> -<span class="sourceLineNo">082</span> private boolean isFailed = false;<a name="line.82"></a> -<span class="sourceLineNo">083</span> private Object input;<a name="line.83"></a> -<span class="sourceLineNo">084</span> private boolean hasInput; // input() was called, even if it's setting 'null'.<a name="line.84"></a> -<span class="sourceLineNo">085</span> private Serializer serializer;<a name="line.85"></a> -<span class="sourceLineNo">086</span> private Parser parser;<a name="line.86"></a> -<span class="sourceLineNo">087</span> private URIBuilder uriBuilder;<a name="line.87"></a> -<span class="sourceLineNo">088</span> private NameValuePairs formData;<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> /**<a name="line.90"></a> -<span class="sourceLineNo">091</span> * Constructs a REST call with the specified method name.<a name="line.91"></a> -<span class="sourceLineNo">092</span> *<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param client The client that created this request.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param request The wrapped Apache HTTP client request object.<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @param uri The URI for this call.<a name="line.95"></a> -<span class="sourceLineNo">096</span> * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> protected RestCall(RestClient client, HttpRequestBase request, URI uri) throws RestCallException {<a name="line.98"></a> -<span class="sourceLineNo">099</span> this.client = client;<a name="line.99"></a> -<span class="sourceLineNo">100</span> this.request = request;<a name="line.100"></a> -<span class="sourceLineNo">101</span> for (RestCallInterceptor i : this.client.interceptors)<a name="line.101"></a> -<span class="sourceLineNo">102</span> interceptor(i);<a name="line.102"></a> -<span class="sourceLineNo">103</span> this.retryOn = client.retryOn;<a name="line.103"></a> -<span class="sourceLineNo">104</span> this.retries = client.retries;<a name="line.104"></a> -<span class="sourceLineNo">105</span> this.retryInterval = client.retryInterval;<a name="line.105"></a> -<span class="sourceLineNo">106</span> this.serializer = client.serializer;<a name="line.106"></a> -<span class="sourceLineNo">107</span> this.parser = client.parser;<a name="line.107"></a> -<span class="sourceLineNo">108</span> uriBuilder = new URIBuilder(uri);<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> /**<a name="line.111"></a> -<span class="sourceLineNo">112</span> * Sets the URI for this call.<a name="line.112"></a> -<span class="sourceLineNo">113</span> * <p><a name="line.113"></a> -<span class="sourceLineNo">114</span> * Can be any of the following types:<a name="line.114"></a> -<span class="sourceLineNo">115</span> * <ul><a name="line.115"></a> -<span class="sourceLineNo">116</span> * <li>{@link URI}<a name="line.116"></a> -<span class="sourceLineNo">117</span> * <li>{@link URL}<a name="line.117"></a> -<span class="sourceLineNo">118</span> * <li>{@link URIBuilder}<a name="line.118"></a> -<span class="sourceLineNo">119</span> * <li>Anything else converted to a string using {@link Object#toString()}.<a name="line.119"></a> -<span class="sourceLineNo">120</span> * </ul><a name="line.120"></a> -<span class="sourceLineNo">121</span> * Relative URL strings will be interpreted as relative to the root URL defined on the client.<a name="line.121"></a> -<span class="sourceLineNo">122</span> *<a name="line.122"></a> -<span class="sourceLineNo">123</span> * @param uri The URI to use for this call.<a name="line.123"></a> -<span class="sourceLineNo">124</span> * This overrides the URI passed in from the client.<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @return This object (for method chaining).<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @throws RestCallException<a name="line.126"></a> -<span class="sourceLineNo">127</span> */<a name="line.127"></a> -<span class="sourceLineNo">128</span> public RestCall uri(Object uri) throws RestCallException {<a name="line.128"></a> -<span class="sourceLineNo">129</span> try {<a name="line.129"></a> -<span class="sourceLineNo">130</span> if (uri != null)<a name="line.130"></a> -<span class="sourceLineNo">131</span> uriBuilder = new URIBuilder(client.toURI(uri));<a name="line.131"></a> -<span class="sourceLineNo">132</span> return this;<a name="line.132"></a> -<span class="sourceLineNo">133</span> } catch (URISyntaxException e) {<a name="line.133"></a> -<span class="sourceLineNo">134</span> throw new RestCallException(e);<a name="line.134"></a> -<span class="sourceLineNo">135</span> }<a name="line.135"></a> -<span class="sourceLineNo">136</span> }<a name="line.136"></a> -<span class="sourceLineNo">137</span><a name="line.137"></a> -<span class="sourceLineNo">138</span> /**<a name="line.138"></a> -<span class="sourceLineNo">139</span> * Sets the URI scheme.<a name="line.139"></a> -<span class="sourceLineNo">140</span> *<a name="line.140"></a> -<span class="sourceLineNo">141</span> * @param scheme The new URI host.<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @return This object (for method chaining).<a name="line.142"></a> -<span class="sourceLineNo">143</span> */<a name="line.143"></a> -<span class="sourceLineNo">144</span> public RestCall scheme(String scheme) {<a name="line.144"></a> -<span class="sourceLineNo">145</span> uriBuilder.setScheme(scheme);<a name="line.145"></a> -<span class="sourceLineNo">146</span> return this;<a name="line.146"></a> -<span class="sourceLineNo">147</span> }<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> /**<a name="line.149"></a> -<span class="sourceLineNo">150</span> * Sets the URI host.<a name="line.150"></a> -<span class="sourceLineNo">151</span> *<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @param host The new URI host.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @return This object (for method chaining).<a name="line.153"></a> -<span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> public RestCall host(String host) {<a name="line.155"></a> -<span class="sourceLineNo">156</span> uriBuilder.setHost(host);<a name="line.156"></a> -<span class="sourceLineNo">157</span> return this;<a name="line.157"></a> -<span class="sourceLineNo">158</span> }<a name="line.158"></a> -<span class="sourceLineNo">159</span><a name="line.159"></a> -<span class="sourceLineNo">160</span> /**<a name="line.160"></a> -<span class="sourceLineNo">161</span> * Sets the URI port.<a name="line.161"></a> -<span class="sourceLineNo">162</span> *<a name="line.162"></a> -<span class="sourceLineNo">163</span> * @param port The new URI port.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @return This object (for method chaining).<a name="line.164"></a> -<span class="sourceLineNo">165</span> */<a name="line.165"></a> -<span class="sourceLineNo">166</span> public RestCall port(int port) {<a name="line.166"></a> -<span class="sourceLineNo">167</span> uriBuilder.setPort(port);<a name="line.167"></a> -<span class="sourceLineNo">168</span> return this;<a name="line.168"></a> -<span class="sourceLineNo">169</span> }<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Adds a query parameter to the URI query.<a name="line.172"></a> -<span class="sourceLineNo">173</span> *<a name="line.173"></a> -<span class="sourceLineNo">174</span> * @param name The parameter name.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * Can be null/blank/* if the value is a {@link Map}, {@link String}, {@link NameValuePairs}, or bean.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @param value The parameter value converted to a string using UON notation.<a name="line.176"></a> -<span class="sourceLineNo">177</span> * Can also be {@link Map}, {@link String}, {@link NameValuePairs}, or bean if the name is null/blank/*.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * If a {@link String} and the name is null/blank/*, then calls {@link URIBuilder#setCustomQuery(String)}.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @param skipIfEmpty Don't add the pair if the value is empty.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.180"></a> -<span class="sourceLineNo">181</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<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 query(String name, Object value, boolean skipIfEmpty, PartSerializer partSerializer) throws RestCallException {<a name="line.185"></a> -<span class="sourceLineNo">186</span> if (partSerializer == null)<a name="line.186"></a> -<span class="sourceLineNo">187</span> partSerializer = client.getPartSerializer();<a name="line.187"></a> -<span class="sourceLineNo">188</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.188"></a> -<span class="sourceLineNo">189</span> if (value != null && ! (isEmpty(value) && skipIfEmpty))<a name="line.189"></a> -<span class="sourceLineNo">190</span> uriBuilder.addParameter(name, partSerializer.serialize(PartType.QUERY, value));<a name="line.190"></a> -<span class="sourceLineNo">191</span> } else if (value instanceof NameValuePairs) {<a name="line.191"></a> -<span class="sourceLineNo">192</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.192"></a> -<span class="sourceLineNo">193</span> query(p.getName(), p.getValue(), skipIfEmpty, partSerializer);<a name="line.193"></a> -<span class="sourceLineNo">194</span> } else if (value instanceof String) {<a name="line.194"></a> -<span class="sourceLineNo">195</span> String s = value.toString();<a name="line.195"></a> -<span class="sourceLineNo">196</span> if (! isEmpty(s))<a name="line.196"></a> -<span class="sourceLineNo">197</span> uriBuilder.setCustomQuery(s);<a name="line.197"></a> -<span class="sourceLineNo">198</span> } else if (value instanceof Map) {<a name="line.198"></a> -<span class="sourceLineNo">199</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.199"></a> -<span class="sourceLineNo">200</span> query(p.getKey(), p.getValue(), skipIfEmpty, partSerializer);<a name="line.200"></a> -<span class="sourceLineNo">201</span> } else if (isBean(value)){<a name="line.201"></a> -<span class="sourceLineNo">202</span> return query(name, toBeanMap(value), skipIfEmpty, partSerializer);<a name="line.202"></a> -<span class="sourceLineNo">203</span> } else {<a name="line.203"></a> -<span class="sourceLineNo">204</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to query(name,value,skipIfEmpty) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.204"></a> -<span class="sourceLineNo">205</span> }<a name="line.205"></a> -<span class="sourceLineNo">206</span> return this;<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> /**<a name="line.209"></a> -<span class="sourceLineNo">210</span> * Adds a query parameter to the URI query.<a name="line.210"></a> -<span class="sourceLineNo">211</span> *<a name="line.211"></a> -<span class="sourceLineNo">212</span> * @param name The parameter name.<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @param value The parameter value converted to a string using UON notation.<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @return This object (for method chaining).<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @throws RestCallException<a name="line.215"></a> -<span class="sourceLineNo">216</span> */<a name="line.216"></a> -<span class="sourceLineNo">217</span> public RestCall query(String name, Object value) throws RestCallException {<a name="line.217"></a> -<span class="sourceLineNo">218</span> return query(name, value, false, null);<a name="line.218"></a> -<span class="sourceLineNo">219</span> }<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> * Adds query parameters to the URI query.<a name="line.222"></a> -<span class="sourceLineNo">223</span> *<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @return This object (for method chaining).<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @throws RestCallException<a name="line.226"></a> -<span class="sourceLineNo">227</span> */<a name="line.227"></a> -<span class="sourceLineNo">228</span> public RestCall query(Map<String,Object> params) throws RestCallException {<a name="line.228"></a> -<span class="sourceLineNo">229</span> return query(null, params);<a name="line.229"></a> -<span class="sourceLineNo">230</span> }<a name="line.230"></a> -<span class="sourceLineNo">231</span><a name="line.231"></a> -<span class="sourceLineNo">232</span> /**<a name="line.232"></a> -<span class="sourceLineNo">233</span> * Adds a query parameter to the URI query if the parameter value is not <jk>null</jk> or an empty string.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * <p><a name="line.234"></a> -<span class="sourceLineNo">235</span> * NE = "not empty"<a name="line.235"></a> -<span class="sourceLineNo">236</span> *<a name="line.236"></a> -<span class="sourceLineNo">237</span> * @param name The parameter name.<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param value The parameter value converted to a string using UON notation.<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @return This object (for method chaining).<a name="line.239"></a> -<span class="sourceLineNo">240</span> * @throws RestCallException<a name="line.240"></a> -<span class="sourceLineNo">241</span> */<a name="line.241"></a> -<span class="sourceLineNo">242</span> public RestCall queryIfNE(String name, Object value) throws RestCallException {<a name="line.242"></a> -<span class="sourceLineNo">243</span> return query(name, value, true, null);<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Adds query parameters to the URI for any parameters that aren't null/empty.<a name="line.247"></a> -<span class="sourceLineNo">248</span> * <p><a name="line.248"></a> -<span class="sourceLineNo">249</span> * NE = "not empty"<a name="line.249"></a> -<span class="sourceLineNo">250</span> *<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @return This object (for method chaining).<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @throws RestCallException<a name="line.253"></a> -<span class="sourceLineNo">254</span> */<a name="line.254"></a> -<span class="sourceLineNo">255</span> public RestCall queryIfNE(Map<String,Object> params) throws RestCallException {<a name="line.255"></a> -<span class="sourceLineNo">256</span> return query(null, params, true, null);<a name="line.256"></a> -<span class="sourceLineNo">257</span> }<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> /**<a name="line.259"></a> -<span class="sourceLineNo">260</span> * Sets a custom URI query.<a name="line.260"></a> -<span class="sourceLineNo">261</span> *<a name="line.261"></a> -<span class="sourceLineNo">262</span> * @param query The new URI query string.<a name="line.262"></a> -<span class="sourceLineNo">263</span> * @return This object (for method chaining).<a name="line.263"></a> -<span class="sourceLineNo">264</span> */<a name="line.264"></a> -<span class="sourceLineNo">265</span> public RestCall query(String query) {<a name="line.265"></a> -<span class="sourceLineNo">266</span> uriBuilder.setCustomQuery(query);<a name="line.266"></a> -<span class="sourceLineNo">267</span> return this;<a name="line.267"></a> -<span class="sourceLineNo">268</span> }<a name="line.268"></a> -<span class="sourceLineNo">269</span><a name="line.269"></a> -<span class="sourceLineNo">270</span> /**<a name="line.270"></a> -<span class="sourceLineNo">271</span> * Adds a form data pair to this request to perform a URL-encoded form post.<a name="line.271"></a> -<span class="sourceLineNo">272</span> *<a name="line.272"></a> -<span class="sourceLineNo">273</span> * @param name The parameter name.<a name="line.273"></a> -<span class="sourceLineNo">274</span> * Can be null/blank/* if the value is a {@link Map}, {@link NameValuePairs}, or bean.<a name="line.274"></a> -<span class="sourceLineNo">275</span> * @param value The parameter value converted to a string using UON notation.<a name="line.275"></a> -<span class="sourceLineNo">276</span> * Can also be {@link Map}, {@link NameValuePairs}, or bean if the name is null/blank/*.<a name="line.276"></a> -<span class="sourceLineNo">277</span> * @param skipIfEmpty Don't add the pair if the value is empty.<a name="line.277"></a> -<span class="sourceLineNo">278</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.278"></a> -<span class="sourceLineNo">279</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<a name="line.279"></a> -<span class="sourceLineNo">280</span> * @return This object (for method chaining).<a name="line.280"></a> -<span class="sourceLineNo">281</span> * @throws RestCallException<a name="line.281"></a> -<span class="sourceLineNo">282</span> */<a name="line.282"></a> -<span class="sourceLineNo">283</span> public RestCall formData(String name, Object value, boolean skipIfEmpty, PartSerializer partSerializer) throws RestCallException {<a name="line.283"></a> -<span class="sourceLineNo">284</span> if (formData == null)<a name="line.284"></a> -<span class="sourceLineNo">285</span> formData = new NameValuePairs();<a name="line.285"></a> -<span class="sourceLineNo">286</span> if (partSerializer == null)<a name="line.286"></a> -<span class="sourceLineNo">287</span> partSerializer = client.getPartSerializer();<a name="line.287"></a> -<span class="sourceLineNo">288</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.288"></a> -<span class="sourceLineNo">289</span> if (value != null && ! (isEmpty(value) && skipIfEmpty))<a name="line.289"></a> -<span class="sourceLineNo">290</span> formData.add(new SerializedNameValuePair(name, value, partSerializer));<a name="line.290"></a> -<span class="sourceLineNo">291</span> } else if (value instanceof NameValuePairs) {<a name="line.291"></a> -<span class="sourceLineNo">292</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.292"></a> -<span class="sourceLineNo">293</span> if (! (isEmpty(p.getValue()) && skipIfEmpty))<a name="line.293"></a> -<span class="sourceLineNo">294</span> formData.add(p);<a name="line.294"></a> -<span class="sourceLineNo">295</span> } else if (value instanceof Map) {<a name="line.295"></a> -<span class="sourceLineNo">296</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.296"></a> -<span class="sourceLineNo">297</span> formData(p.getKey(), p.getValue(), skipIfEmpty, partSerializer);<a name="line.297"></a> -<span class="sourceLineNo">298</span> } else if (isBean(value)) {<a name="line.298"></a> -<span class="sourceLineNo">299</span> return formData(name, toBeanMap(value), skipIfEmpty, partSerializer);<a name="line.299"></a> -<span class="sourceLineNo">300</span> } else {<a name="line.300"></a> -<span class="sourceLineNo">301</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to formData(name,value,skipIfEmpty) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.301"></a> -<span class="sourceLineNo">302</span> }<a name="line.302"></a> -<span class="sourceLineNo">303</span> return this;<a name="line.303"></a> -<span class="sourceLineNo">304</span> }<a name="line.304"></a> -<span class="sourceLineNo">305</span><a name="line.305"></a> -<span class="sourceLineNo">306</span> /**<a name="line.306"></a> -<span class="sourceLineNo">307</span> * Adds a form data pair to this request to perform a URL-encoded form post.<a name="line.307"></a> -<span class="sourceLineNo">308</span> *<a name="line.308"></a> -<span class="sourceLineNo">309</span> * @param name The parameter name.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * Can be null/blank if the value is a {@link Map} or {@link NameValuePairs}.<a name="line.310"></a> -<span class="sourceLineNo">311</span> * @param value The parameter value converted to a string using UON notation.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * Can also be a {@link Map} or {@link NameValuePairs}.<a name="line.312"></a> -<span class="sourceLineNo">313</span> * @return This object (for method chaining).<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.<a name="line.314"></a> -<span class="sourceLineNo">315</span> */<a name="line.315"></a> -<span class="sourceLineNo">316</span> public RestCall formData(String name, Object value) throws RestCallException {<a name="line.316"></a> -<span class="sourceLineNo">317</span> return formData(name, value, false, null);<a name="line.317"></a> -<span class="sourceLineNo">318</span> }<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> * Adds form data pairs to this request to perform a URL-encoded form post.<a name="line.321"></a> -<span class="sourceLineNo">322</span> *<a name="line.322"></a> -<span class="sourceLineNo">323</span> * @param nameValuePairs The name-value pairs of the request.<a name="line.323"></a> -<span class="sourceLineNo">324</span> * @return This object (for method chaining).<a name="line.324"></a> -<span class="sourceLineNo">325</span> * @throws RestCallException<a name="line.325"></a> -<span class="sourceLineNo">326</span> */<a name="line.326"></a> -<span class="sourceLineNo">327</span> public RestCall formData(NameValuePairs nameValuePairs) throws RestCallException {<a name="line.327"></a> -<span class="sourceLineNo">328</span> return formData(null, nameValuePairs);<a name="line.328"></a> -<span class="sourceLineNo">329</span> }<a name="line.329"></a> -<span class="sourceLineNo">330</span><a name="line.330"></a> -<span class="sourceLineNo">331</span> /**<a name="line.331"></a> -<span class="sourceLineNo">332</span> * Adds form data pairs to this request to perform a URL-encoded form post.<a name="line.332"></a> -<span class="sourceLineNo">333</span> *<a name="line.333"></a> -<span class="sourceLineNo">334</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.334"></a> -<span class="sourceLineNo">335</span> * @return This object (for method chaining).<a name="line.335"></a> -<span class="sourceLineNo">336</span> * @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.<a name="line.336"></a> -<span class="sourceLineNo">337</span> */<a name="line.337"></a> -<span class="sourceLineNo">338</span> public RestCall formData(Map<String,Object> params) throws RestCallException {<a name="line.338"></a> -<span class="sourceLineNo">339</span> return formData(null, params);<a name="line.339"></a> -<span class="sourceLineNo">340</span> }<a name="line.340"></a> -<span class="sourceLineNo">341</span><a name="line.341"></a> -<span class="sourceLineNo">342</span> /**<a name="line.342"></a> -<span class="sourceLineNo">343</span> * Adds a form data pair to the request if the parameter value is not <jk>null</jk> or an empty string.<a name="line.343"></a> -<span class="sourceLineNo">344</span> * <p><a name="line.344"></a> -<span class="sourceLineNo">345</span> * NE = "not empty"<a name="line.345"></a> -<span class="sourceLineNo">346</span> *<a name="line.346"></a> -<span class="sourceLineNo">347</span> * @param name The parameter name.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param value The parameter value converted to a string using UON notation.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @return This object (for method chaining).<a name="line.349"></a> -<span class="sourceLineNo">350</span> * @throws RestCallException<a name="line.350"></a> -<span class="sourceLineNo">351</span> */<a name="line.351"></a> -<span class="sourceLineNo">352</span> public RestCall formDataIfNE(String name, Object value) throws RestCallException {<a name="line.352"></a> -<span class="sourceLineNo">353</span> return formData(name, value, true, null);<a name="line.353"></a> -<span class="sourceLineNo">354</span> }<a name="line.354"></a> -<span class="sourceLineNo">355</span><a name="line.355"></a> -<span class="sourceLineNo">356</span> /**<a name="line.356"></a> -<span class="sourceLineNo">357</span> * Adds form data parameters to the request for any parameters that aren't null/empty.<a name="line.357"></a> -<span class="sourceLineNo">358</span> * <p><a name="line.358"></a> -<span class="sourceLineNo">359</span> * NE = "not empty"<a name="line.359"></a> -<span class="sourceLineNo">360</span> *<a name="line.360"></a> -<span class="sourceLineNo">361</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.361"></a> -<span class="sourceLineNo">362</span> * @return This object (for method chaining).<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @throws RestCallException<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> public RestCall formDataIfNE(Map<String,Object> params) throws RestCallException {<a name="line.365"></a> -<span class="sourceLineNo">366</span> return formData(null, params, true, null);<a name="line.366"></a> -<span class="sourceLineNo">367</span> }<a name="line.367"></a> -<span class="sourceLineNo">368</span><a name="line.368"></a> -<span class="sourceLineNo">369</span> /**<a name="line.369"></a> -<span class="sourceLineNo">370</span> * Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.<a name="line.370"></a> -<span class="sourceLineNo">371</span> *<a name="line.371"></a> -<span class="sourceLineNo">372</span> * @param name The path variable name.<a name="line.372"></a> -<span class="sourceLineNo">373</span> * @param value The replacement value.<a name="line.373"></a> -<span class="sourceLineNo">374</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.374"></a> -<span class="sourceLineNo">375</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @return This object (for method chaining).<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @throws RestCallException If variable could not be found in path.<a name="line.377"></a> -<span class="sourceLineNo">378</span> */<a name="line.378"></a> -<span class="sourceLineNo">379</span> public RestCall path(String name, Object value, PartSerializer partSerializer) throws RestCallException {<a name="line.379"></a> -<span class="sourceLineNo">380</span> String path = uriBuilder.getPath();<a name="line.380"></a> -<span class="sourceLineNo">381</span> if (partSerializer == null)<a name="line.381"></a> -<span class="sourceLineNo">382</span> partSerializer = client.getPartSerializer();<a name="line.382"></a> -<span class="sourceLineNo">383</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.383"></a> -<span class="sourceLineNo">384</span> String var = "{" + name + "}";<a name="line.384"></a> -<span class="sourceLineNo">385</span> if (path.indexOf(var) == -1)<a name="line.385"></a> -<span class="sourceLineNo">386</span> throw new RestCallException("Path variable {"+name+"} was not found in path.");<a name="line.386"></a> -<span class="sourceLineNo">387</span> String newPath = path.replace(var, partSerializer.serialize(PartType.PATH, value));<a name="line.387"></a> -<span class="sourceLineNo">388</span> uriBuilder.setPath(newPath);<a name="line.388"></a> -<span class="sourceLineNo">389</span> } else if (value instanceof NameValuePairs) {<a name="line.389"></a> -<span class="sourceLineNo">390</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.390"></a> -<span class="sourceLineNo">391</span> path(p.getName(), p.getValue());<a name="line.391"></a> -<span class="sourceLineNo">392</span> } else if (value instanceof Map) {<a name="line.392"></a> -<span class="sourceLineNo">393</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.393"></a> -<span class="sourceLineNo">394</span> path(p.getKey(), p.getValue());<a name="line.394"></a> -<span class="sourceLineNo">395</span> } else if (isBean(value)) {<a name="line.395"></a> -<span class="sourceLineNo">396</span> return path(name, toBeanMap(value));<a name="line.396"></a> -<span class="sourceLineNo">397</span> } else {<a name="line.397"></a> -<span class="sourceLineNo">398</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to path(name,value) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.398"></a> -<span class="sourceLineNo">399</span> }<a name="line.399"></a> -<span class="sourceLineNo">400</span> return this;<a name="line.400"></a> -<span class="sourceLineNo">401</span> }<a name="line.401"></a> -<span class="sourceLineNo">402</span><a name="line.402"></a> -<span class="sourceLineNo">403</span> /**<a name="line.403"></a> -<span class="sourceLineNo">404</span> * Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.<a name="line.404"></a> -<span class="sourceLineNo">405</span> *<a name="line.405"></a> -<span class="sourceLineNo">406</span> * @param name The path variable name.<a name="line.406"></a> -<span class="sourceLineNo">407</span> * @param value The replacement value.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @return This object (for method chaining).<a name="line.408"></a> -<span class="sourceLineNo">409</span> * @throws RestCallException If variable could not be found in path.<a name="line.409"></a> -<span class="sourceLineNo">410</span> */<a name="line.410"></a> -<span class="sourceLineNo">411</span> public RestCall path(String name, Object value) throws RestCallException {<a name="line.411"></a> -<span class="sourceLineNo">412</span> return path(name, value, null);<a name="line.412"></a> -<span class="sourceLineNo">413</span> }<a name="line.413"></a> -<span class="sourceLineNo">414</span><a name="line.414"></a> -<span class="sourceLineNo">415</span> /**<a name="line.415"></a> -<span class="sourceLineNo">416</span> * Sets the URI user info.<a name="line.416"></a> -<span class="sourceLineNo">417</span> *<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @param userInfo The new URI user info.<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 userInfo(String userInfo) {<a name="line.421"></a> -<span class="sourceLineNo">422</span> uriBuilder.setUserInfo(userInfo);<a name="line.422"></a> -<span class="sourceLineNo">423</span> return this;<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> /**<a name="line.426"></a> -<span class="sourceLineNo">427</span> * Sets the URI user info.<a name="line.427"></a> -<span class="sourceLineNo">428</span> *<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @param username The new URI username.<a name="line.429"></a> -<span class="sourceLineNo">430</span> * @param password The new URI password.<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 userInfo(String username, String password) {<a name="line.433"></a> -<span class="sourceLineNo">434</span> uriBuilder.setUserInfo(username, password);<a name="line.434"></a> -<span class="sourceLineNo">435</span> return this;<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> /**<a name="line.438"></a> -<span class="sourceLineNo">439</span> * Sets the input for this REST call.<a name="line.439"></a> -<span class="sourceLineNo">440</span> *<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @param input The input to be sent to the REST resource (only valid for PUT and POST) requests. <br><a name="line.441"></a> -<span class="sourceLineNo">442</span> * Can be of the following types:<a name="line.442"></a> -<span class="sourceLineNo">443</span> * <ul class='spaced-list'><a name="line.443"></a> -<span class="sourceLineNo">444</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.444"></a> -<span class="sourceLineNo">445</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.445"></a> -<span class="sourceLineNo">446</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.446"></a> -<span class="sourceLineNo">447</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.447"></a> -<span class="sourceLineNo">448</span> * <li>{@link NameValuePairs} - Converted to a URL-encoded FORM post.<a name="line.448"></a> -<span class="sourceLineNo">449</span> * </ul><a name="line.449"></a> -<span class="sourceLineNo">450</span> * @return This object (for method chaining).<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @throws RestCallException If a retry was attempted, but the entity was not repeatable.<a name="line.451"></a> -<span class="sourceLineNo">452</span> */<a name="line.452"></a> -<span class="sourceLineNo">453</span> public RestCall input(final Object input) throws RestCallException {<a name="line.453"></a> -<span class="sourceLineNo">454</span> this.input = input;<a name="line.454"></a> -<span class="sourceLineNo">455</span> this.hasInput = true;<a name="line.455"></a> -<span class="sourceLineNo">456</span> return this;<a name="line.456"></a> -<span class="sourceLineNo">457</span> }<a name="line.457"></a> -<span class="sourceLineNo">458</span><a name="line.458"></a> -<span class="sourceLineNo">459</span> /**<a name="line.459"></a> -<span class="sourceLineNo">460</span> * Specifies the serializer to use on this call.<a name="line.460"></a> -<span class="sourceLineNo">461</span> * <p><a name="line.461"></a> -<span class="sourceLineNo">462</span> * Overrides the serializer specified on the {@link RestClient}.<a name="line.462"></a> -<span class="sourceLineNo">463</span> *<a name="line.463"></a> -<span class="sourceLineNo">464</span> * @param serializer The serializer used to serialize POJOs to the body of the HTTP request.<a name="line.464"></a> -<span class="sourceLineNo">465</span> * @return This object (for method chaining).<a name="line.465"></a> -<span class="sourceLineNo">466</span> */<a name="line.466"></a> -<span class="sourceLineNo">467</span> public RestCall serializer(Serializer serializer) {<a name="line.467"></a> -<span class="sourceLineNo">468</span> this.serializer = serializer;<a name="line.468"></a> -<span class="sourceLineNo">469</span> return this;<a name="line.469"></a> -<span class="sourceLineNo">470</span> }<a name="line.470"></a> -<span class="sourceLineNo">471</span><a name="line.471"></a> -<span class="sourceLineNo">472</span> /**<a name="line.472"></a> -<span class="sourceLineNo">473</span> * Specifies the parser to use on this call.<a name="line.473"></a> -<span class="sourceLineNo">474</span> * <p><a name="line.474"></a> -<span class="sourceLineNo">475</span> * Overrides the parser specified on the {@link RestClient}.<a name="line.475"></a> -<span class="sourceLineNo">476</span> *<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @param parser The parser used to parse POJOs from the body of the HTTP response.<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @return This object (for method chaining).<a name="line.478"></a> -<span class="sourceLineNo">479</span> */<a name="line.479"></a> -<span class="sourceLineNo">480</span> public RestCall parser(Parser parser) {<a name="line.480"></a> -<span class="sourceLineNo">481</span> this.parser = parser;<a name="line.481"></a> -<span class="sourceLineNo">482</span> return this;<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> //--------------------------------------------------------------------------------<a name="line.486"></a> -<span class="sourceLineNo">487</span> // HTTP headers<a name="line.487"></a> -<span class="sourceLineNo">488</span> //--------------------------------------------------------------------------------<a name="line.488"></a> +<span class="sourceLineNo">031</span>import org.apache.http.entity.*;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.http.impl.client.*;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.http.util.*;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.juneau.*;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.juneau.encoders.*;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.juneau.internal.*;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.juneau.internal.ObjectUtils;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.juneau.parser.*;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.juneau.parser.ParseException;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.juneau.serializer.*;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.juneau.urlencoding.*;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.juneau.utils.*;<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> +<span class="sourceLineNo">044</span>/**<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Represents a connection to a remote REST resource.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * <p><a name="line.48"></a> +<span class="sourceLineNo">049</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.49"></a> +<span class="sourceLineNo">050</span> *<a name="line.50"></a> +<span class="sourceLineNo">051</span> * <p class='bcode'><a name="line.51"></a> +<span class="sourceLineNo">052</span> * RestClient client = <jk>new</jk> RestClient();<a name="line.52"></a> +<span class="sourceLineNo">053</span> * RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);<a name="line.53"></a> +<span class="sourceLineNo">054</span> * MyBean b = c.getResponse(MyBean.<jk>class</jk>);<a name="line.54"></a> +<span class="sourceLineNo">055</span> * </p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p><a name="line.56"></a> +<span class="sourceLineNo">057</span> * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.<a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * <h5 class='section'>Additional information:</h5><a name="line.59"></a> +<span class="sourceLineNo">060</span> * <ul><a name="line.60"></a> +<span class="sourceLineNo">061</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.61"></a> +<span class="sourceLineNo">062</span> * </ul><a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span>@SuppressWarnings({ "hiding", "unchecked" })<a name="line.64"></a> +<span class="sourceLineNo">065</span>public final class RestCall {<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> private final RestClient client; // The client that created this call.<a name="line.67"></a> +<span class="sourceLineNo">068</span> private final HttpRequestBase request; // The request.<a name="line.68"></a> +<span class="sourceLineNo">069</span> private HttpResponse response; // The response.<a name="line.69"></a> +<span class="sourceLineNo">070</span> private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests.<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span> private boolean isConnected = false; // connect() has been called.<a name="line.72"></a> +<span class="sourceLineNo">073</span> private boolean allowRedirectsOnPosts;<a name="line.73"></a> +<span class="sourceLineNo">074</span> private int retries = 1;<a name="line.74"></a> +<span class="sourceLineNo">075</span> private int redirectOnPostsTries = 5;<a name="line.75"></a> +<span class="sourceLineNo">076</span> private long retryInterval = -1;<a name="line.76"></a> +<span class="sourceLineNo">077</span> private RetryOn retryOn;<a name="line.77"></a> +<span class="sourceLineNo">078</span> private boolean ignoreErrors;<a name="line.78"></a> +<span class="sourceLineNo">079</span> private boolean byLines = false;<a name="line.79"></a> +<span class="sourceLineNo">080</span> private TeeWriter writers = new TeeWriter();<a name="line.80"></a> +<span class="sourceLineNo">081</span> private StringWriter capturedResponseWriter;<a name="line.81"></a> +<span class="sourceLineNo">082</span> private String capturedResponse;<a name="line.82"></a> +<span class="sourceLineNo">083</span> private TeeOutputStream outputStreams = new TeeOutputStream();<a name="line.83"></a> +<span class="sourceLineNo">084</span> private boolean isClosed = false;<a name="line.84"></a> +<span class="sourceLineNo">085</span> private boolean isFailed = false;<a name="line.85"></a> +<span class="sourceLineNo">086</span> private Object input;<a name="line.86"></a> +<span class="sourceLineNo">087</span> private boolean hasInput; // input() was called, even if it's setting 'null'.<a name="line.87"></a> +<span class="sourceLineNo">088</span> private Serializer serializer;<a name="line.88"></a> +<span class="sourceLineNo">089</span> private Parser parser;<a name="line.89"></a> +<span class="sourceLineNo">090</span> private URIBuilder uriBuilder;<a name="line.90"></a> +<span class="sourceLineNo">091</span> private NameValuePairs formData;<a name="line.91"></a> +<span class="sourceLineNo">092</span><a name="line.92"></a> +<span class="sourceLineNo">093</span> /**<a name="line.93"></a> +<span class="sourceLineNo">094</span> * Constructs a REST call with the specified method name.<a name="line.94"></a> +<span class="sourceLineNo">095</span> *<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @param client The client that created this request.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param request The wrapped Apache HTTP client request object.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * @param uri The URI for this call.<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt.<a name="line.99"></a> +<span class="sourceLineNo">100</span> */<a name="line.100"></a> +<span class="sourceLineNo">101</span> protected RestCall(RestClient client, HttpRequestBase request, URI uri) throws RestCallException {<a name="line.101"></a> +<span class="sourceLineNo">102</span> this.client = client;<a name="line.102"></a> +<span class="sourceLineNo">103</span> this.request = request;<a name="line.103"></a> +<span class="sourceLineNo">104</span> for (RestCallInterceptor i : this.client.interceptors)<a name="line.104"></a> +<span class="sourceLineNo">105</span> interceptor(i);<a name="line.105"></a> +<span class="sourceLineNo">106</span> this.retryOn = client.retryOn;<a name="line.106"></a> +<span class="sourceLineNo">107</span> this.retries = client.retries;<a name="line.107"></a> +<span class="sourceLineNo">108</span> this.retryInterval = client.retryInterval;<a name="line.108"></a> +<span class="sourceLineNo">109</span> this.serializer = client.serializer;<a name="line.109"></a> +<span class="sourceLineNo">110</span> this.parser = client.parser;<a name="line.110"></a> +<span class="sourceLineNo">111</span> uriBuilder = new URIBuilder(uri);<a name="line.111"></a> +<span class="sourceLineNo">112</span> }<a name="line.112"></a> +<span class="sourceLineNo">113</span><a name="line.113"></a> +<span class="sourceLineNo">114</span> /**<a name="line.114"></a> +<span class="sourceLineNo">115</span> * Sets the URI for this call.<a name="line.115"></a> +<span class="sourceLineNo">116</span> * <p><a name="line.116"></a> +<span class="sourceLineNo">117</span> * Can be any of the following types:<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <ul><a name="line.118"></a> +<span class="sourceLineNo">119</span> * <li>{@link URI}<a name="line.119"></a> +<span class="sourceLineNo">120</span> * <li>{@link URL}<a name="line.120"></a> +<span class="sourceLineNo">121</span> * <li>{@link URIBuilder}<a name="line.121"></a> +<span class="sourceLineNo">122</span> * <li>Anything else converted to a string using {@link Object#toString()}.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * </ul><a name="line.123"></a> +<span class="sourceLineNo">124</span> * Relative URL strings will be interpreted as relative to the root URL defined on the client.<a name="line.124"></a> +<span class="sourceLineNo">125</span> *<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @param uri The URI to use for this call.<a name="line.126"></a> +<span class="sourceLineNo">127</span> * This overrides the URI passed in from the client.<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @return This object (for method chaining).<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @throws RestCallException<a name="line.129"></a> +<span class="sourceLineNo">130</span> */<a name="line.130"></a> +<span class="sourceLineNo">131</span> public RestCall uri(Object uri) throws RestCallException {<a name="line.131"></a> +<span class="sourceLineNo">132</span> try {<a name="line.132"></a> +<span class="sourceLineNo">133</span> if (uri != null)<a name="line.133"></a> +<span class="sourceLineNo">134</span> uriBuilder = new URIBuilder(client.toURI(uri));<a name="line.134"></a> +<span class="sourceLineNo">135</span> return this;<a name="line.135"></a> +<span class="sourceLineNo">136</span> } catch (URISyntaxException e) {<a name="line.136"></a> +<span class="sourceLineNo">137</span> throw new RestCallException(e);<a name="line.137"></a> +<span class="sourceLineNo">138</span> }<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<a name="line.139"></a> +<span class="sourceLineNo">140</span><a name="line.140"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * Sets the URI scheme.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @param scheme The new URI host.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @return This object (for method chaining).<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public RestCall scheme(String scheme) {<a name="line.147"></a> +<span class="sourceLineNo">148</span> uriBuilder.setScheme(scheme);<a name="line.148"></a> +<span class="sourceLineNo">149</span> return this;<a name="line.149"></a> +<span class="sourceLineNo">150</span> }<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> * Sets the URI host.<a name="line.153"></a> +<span class="sourceLineNo">154</span> *<a name="line.154"></a> +<span class="sourceLineNo">155</span> * @param host The new URI host.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @return This object (for method chaining).<a name="line.156"></a> +<span class="sourceLineNo">157</span> */<a name="line.157"></a> +<span class="sourceLineNo">158</span> public RestCall host(String host) {<a name="line.158"></a> +<span class="sourceLineNo">159</span> uriBuilder.setHost(host);<a name="line.159"></a> +<span class="sourceLineNo">160</span> return this;<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span><a name="line.162"></a> +<span class="sourceLineNo">163</span> /**<a name="line.163"></a> +<span class="sourceLineNo">164</span> * Sets the URI port.<a name="line.164"></a> +<span class="sourceLineNo">165</span> *<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @param port The new URI port.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @return This object (for method chaining).<a name="line.167"></a> +<span class="sourceLineNo">168</span> */<a name="line.168"></a> +<span class="sourceLineNo">169</span> public RestCall port(int port) {<a name="line.169"></a> +<span class="sourceLineNo">170</span> uriBuilder.setPort(port);<a name="line.170"></a> +<span class="sourceLineNo">171</span> return this;<a name="line.171"></a> +<span class="sourceLineNo">172</span> }<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> /**<a name="line.174"></a> +<span class="sourceLineNo">175</span> * Adds a query parameter to the URI query.<a name="line.175"></a> +<span class="sourceLineNo">176</span> *<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param name The parameter name.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * Can be null/blank/* if the value is a {@link Map}, {@link String}, {@link NameValuePairs}, or bean.<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @param value The parameter value converted to a string using UON notation.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * Can also be {@link Map}, {@link String}, {@link NameValuePairs}, or bean if the name is null/blank/*.<a name="line.180"></a> +<span class="sourceLineNo">181</span> * If a {@link String} and the name is null/blank/*, then calls {@link URIBuilder#setCustomQuery(String)}.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param skipIfEmpty Don't add the pair if the value is empty.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.183"></a> +<span class="sourceLineNo">184</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<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 query(String name, Object value, boolean skipIfEmpty, PartSerializer partSerializer) throws RestCallException {<a name="line.188"></a> +<span class="sourceLineNo">189</span> if (partSerializer == null)<a name="line.189"></a> +<span class="sourceLineNo">190</span> partSerializer = client.getPartSerializer();<a name="line.190"></a> +<span class="sourceLineNo">191</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> if (value != null && ! (ObjectUtils.isEmpty(value) && skipIfEmpty))<a name="line.192"></a> +<span class="sourceLineNo">193</span> uriBuilder.addParameter(name, partSerializer.serialize(PartType.QUERY, value));<a name="line.193"></a> +<span class="sourceLineNo">194</span> } else if (value instanceof NameValuePairs) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.195"></a> +<span class="sourceLineNo">196</span> query(p.getName(), p.getValue(), skipIfEmpty, UrlEncodingSerializer.DEFAULT_PLAINTEXT);<a name="line.196"></a> +<span class="sourceLineNo">197</span> } else if (value instanceof Map) {<a name="line.197"></a> +<span class="sourceLineNo">198</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.198"></a> +<span class="sourceLineNo">199</span> query(p.getKey(), p.getValue(), skipIfEmpty, partSerializer);<a name="line.199"></a> +<span class="sourceLineNo">200</span> } else if (isBean(value)) {<a name="line.200"></a> +<span class="sourceLineNo">201</span> return query(name, toBeanMap(value), skipIfEmpty, partSerializer);<a name="line.201"></a> +<span class="sourceLineNo">202</span> } else if (value instanceof Reader) {<a name="line.202"></a> +<span class="sourceLineNo">203</span> try {<a name="line.203"></a> +<span class="sourceLineNo">204</span> uriBuilder.setCustomQuery(IOUtils.read(value));<a name="line.204"></a> +<span class="sourceLineNo">205</span> } catch (IOException e) {<a name="line.205"></a> +<span class="sourceLineNo">206</span> throw new RestCallException(e);<a name="line.206"></a> +<span class="sourceLineNo">207</span> }<a name="line.207"></a> +<span class="sourceLineNo">208</span> } else if (value instanceof CharSequence) {<a name="line.208"></a> +<span class="sourceLineNo">209</span> String s = value.toString();<a name="line.209"></a> +<span class="sourceLineNo">210</span> if (! isEmpty(s))<a name="line.210"></a> +<span class="sourceLineNo">211</span> uriBuilder.setCustomQuery(s);<a name="line.211"></a> +<span class="sourceLineNo">212</span> } else {<a name="line.212"></a> +<span class="sourceLineNo">213</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to query(name,value,skipIfEmpty) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span> return this;<a name="line.215"></a> +<span class="sourceLineNo">216</span> }<a name="line.216"></a> +<span class="sourceLineNo">217</span><a name="line.217"></a> +<span class="sourceLineNo">218</span> /**<a name="line.218"></a> +<span class="sourceLineNo">219</span> * Adds a query parameter to the URI query.<a name="line.219"></a> +<span class="sourceLineNo">220</span> *<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @param name The parameter name.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * @param value The parameter value converted to a string using UON notation.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * @return This object (for method chaining).<a name="line.223"></a> +<span class="sourceLineNo">224</span> * @throws RestCallException<a name="line.224"></a> +<span class="sourceLineNo">225</span> */<a name="line.225"></a> +<span class="sourceLineNo">226</span> public RestCall query(String name, Object value) throws RestCallException {<a name="line.226"></a> +<span class="sourceLineNo">227</span> return query(name, value, false, null);<a name="line.227"></a> +<span class="sourceLineNo">228</span> }<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> /**<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Adds query parameters to the URI query.<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @return This object (for method chaining).<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @throws RestCallException<a name="line.235"></a> +<span class="sourceLineNo">236</span> */<a name="line.236"></a> +<span class="sourceLineNo">237</span> public RestCall query(Map<String,Object> params) throws RestCallException {<a name="line.237"></a> +<span class="sourceLineNo">238</span> return query(null, params);<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<a name="line.239"></a> +<span class="sourceLineNo">240</span><a name="line.240"></a> +<span class="sourceLineNo">241</span> /**<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Adds a query parameter to the URI query if the parameter value is not <jk>null</jk> or an empty string.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> +<span class="sourceLineNo">244</span> * NE = "not empty"<a name="line.244"></a> +<span class="sourceLineNo">245</span> *<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @param name The parameter name.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * @param value The parameter value converted to a string using UON notation.<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @return This object (for method chaining).<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @throws RestCallException<a name="line.249"></a> +<span class="sourceLineNo">250</span> */<a name="line.250"></a> +<span class="sourceLineNo">251</span> public RestCall queryIfNE(String name, Object value) throws RestCallException {<a name="line.251"></a> +<span class="sourceLineNo">252</span> return query(name, value, true, null);<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> * Adds query parameters to the URI for any parameters that aren't null/empty.<a name="line.256"></a> +<span class="sourceLineNo">257</span> * <p><a name="line.257"></a> +<span class="sourceLineNo">258</span> * NE = "not empty"<a name="line.258"></a> +<span class="sourceLineNo">259</span> *<a name="line.259"></a> +<span class="sourceLineNo">260</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.260"></a> +<span class="sourceLineNo">261</span> * @return This object (for method chaining).<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @throws RestCallException<a name="line.262"></a> +<span class="sourceLineNo">263</span> */<a name="line.263"></a> +<span class="sourceLineNo">264</span> public RestCall queryIfNE(Map<String,Object> params) throws RestCallException {<a name="line.264"></a> +<span class="sourceLineNo">265</span> return query(null, params, true, null);<a name="line.265"></a> +<span class="sourceLineNo">266</span> }<a name="line.266"></a> +<span class="sourceLineNo">267</span><a name="line.267"></a> +<span class="sourceLineNo">268</span> /**<a name="line.268"></a> +<span class="sourceLineNo">269</span> * Sets a custom URI query.<a name="line.269"></a> +<span class="sourceLineNo">270</span> *<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param query The new URI query string.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * @return This object (for method chaining).<a name="line.272"></a> +<span class="sourceLineNo">273</span> */<a name="line.273"></a> +<span class="sourceLineNo">274</span> public RestCall query(String query) {<a name="line.274"></a> +<span class="sourceLineNo">275</span> uriBuilder.setCustomQuery(query);<a name="line.275"></a> +<span class="sourceLineNo">276</span> return this;<a name="line.276"></a> +<span class="sourceLineNo">277</span> }<a name="line.277"></a> +<span class="sourceLineNo">278</span><a name="line.278"></a> +<span class="sourceLineNo">279</span> /**<a name="line.279"></a> +<span class="sourceLineNo">280</span> * Adds a form data pair to this request to perform a URL-encoded form post.<a name="line.280"></a> +<span class="sourceLineNo">281</span> *<a name="line.281"></a> +<span class="sourceLineNo">282</span> * @param name The parameter name.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * Can be null/blank/* if the value is a {@link Map}, {@link NameValuePairs}, or bean.<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param value The parameter value converted to a string using UON notation.<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Can also be {@link Map}, {@link NameValuePairs}, or bean if the name is null/blank/*.<a name="line.285"></a> +<span class="sourceLineNo">286</span> * @param skipIfEmpty Don't add the pair if the value is empty.<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.287"></a> +<span class="sourceLineNo">288</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * @return This object (for method chaining).<a name="line.289"></a> +<span class="sourceLineNo">290</span> * @throws RestCallException<a name="line.290"></a> +<span class="sourceLineNo">291</span> */<a name="line.291"></a> +<span class="sourceLineNo">292</span> public RestCall formData(String name, Object value, boolean skipIfEmpty, PartSerializer partSerializer) throws RestCallException {<a name="line.292"></a> +<span class="sourceLineNo">293</span> if (formData == null)<a name="line.293"></a> +<span class="sourceLineNo">294</span> formData = new NameValuePairs();<a name="line.294"></a> +<span class="sourceLineNo">295</span> if (partSerializer == null)<a name="line.295"></a> +<span class="sourceLineNo">296</span> partSerializer = client.getPartSerializer();<a name="line.296"></a> +<span class="sourceLineNo">297</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.297"></a> +<span class="sourceLineNo">298</span> if (value != null && ! (ObjectUtils.isEmpty(value) && skipIfEmpty))<a name="line.298"></a> +<span class="sourceLineNo">299</span> formData.add(new SerializedNameValuePair(name, value, partSerializer));<a name="line.299"></a> +<span class="sourceLineNo">300</span> } else if (value instanceof NameValuePairs) {<a name="line.300"></a> +<span class="sourceLineNo">301</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.301"></a> +<span class="sourceLineNo">302</span> if (p.getValue() != null && ! (isEmpty(p.getValue()) && skipIfEmpty))<a name="line.302"></a> +<span class="sourceLineNo">303</span> formData.add(p);<a name="line.303"></a> +<span class="sourceLineNo">304</span> } else if (value instanceof Map) {<a name="line.304"></a> +<span class="sourceLineNo">305</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.305"></a> +<span class="sourceLineNo">306</span> formData(p.getKey(), p.getValue(), skipIfEmpty, partSerializer);<a name="line.306"></a> +<span class="sourceLineNo">307</span> } else if (isBean(value)) {<a name="line.307"></a> +<span class="sourceLineNo">308</span> return formData(name, toBeanMap(value), skipIfEmpty, partSerializer);<a name="line.308"></a> +<span class="sourceLineNo">309</span> } else if (value instanceof Reader) {<a name="line.309"></a> +<span class="sourceLineNo">310</span> contentType("application/x-www-form-urlencoded");<a name="line.310"></a> +<span class="sourceLineNo">311</span> input(value);<a name="line.311"></a> +<span class="sourceLineNo">312</span> } else if (value instanceof CharSequence) {<a name="line.312"></a> +<span class="sourceLineNo">313</span> try {<a name="line.313"></a> +<span class="sourceLineNo">314</span> contentType("application/x-www-form-urlencoded");<a name="line.314"></a> +<span class="sourceLineNo">315</span> input(new StringEntity(value.toString()));<a name="line.315"></a> +<span class="sourceLineNo">316</span> } catch (UnsupportedEncodingException e) {}<a name="line.316"></a> +<span class="sourceLineNo">317</span> } else {<a name="line.317"></a> +<span class="sourceLineNo">318</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to formData(name,value,skipIfEmpty) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.318"></a> +<span class="sourceLineNo">319</span> }<a name="line.319"></a> +<span class="sourceLineNo">320</span> return this;<a name="line.320"></a> +<span class="sourceLineNo">321</span> }<a name="line.321"></a> +<span class="sourceLineNo">322</span><a name="line.322"></a> +<span class="sourceLineNo">323</span> /**<a name="line.323"></a> +<span class="sourceLineNo">324</span> * Adds a form data pair to this request to perform a URL-encoded form post.<a name="line.324"></a> +<span class="sourceLineNo">325</span> *<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @param name The parameter name.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * Can be null/blank if the value is a {@link Map} or {@link NameValuePairs}.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * @param value The parameter value converted to a string using UON notation.<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Can also be a {@link Map} or {@link NameValuePairs}.<a name="line.329"></a> +<span class="sourceLineNo">330</span> * @return This object (for method chaining).<a name="line.330"></a> +<span class="sourceLineNo">331</span> * @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.<a name="line.331"></a> +<span class="sourceLineNo">332</span> */<a name="line.332"></a> +<span class="sourceLineNo">333</span> public RestCall formData(String name, Object value) throws RestCallException {<a name="line.333"></a> +<span class="sourceLineNo">334</span> return formData(name, value, false, null);<a name="line.334"></a> +<span class="sourceLineNo">335</span> }<a name="line.335"></a> +<span class="sourceLineNo">336</span><a name="line.336"></a> +<span class="sourceLineNo">337</span> /**<a name="line.337"></a> +<span class="sourceLineNo">338</span> * Adds form data pairs to this request to perform a URL-encoded form post.<a name="line.338"></a> +<span class="sourceLineNo">339</span> *<a name="line.339"></a> +<span class="sourceLineNo">340</span> * @param nameValuePairs The name-value pairs of the request.<a name="line.340"></a> +<span class="sourceLineNo">341</span> * @return This object (for method chaining).<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @throws RestCallException<a name="line.342"></a> +<span class="sourceLineNo">343</span> */<a name="line.343"></a> +<span class="sourceLineNo">344</span> public RestCall formData(NameValuePairs nameValuePairs) throws RestCallException {<a name="line.344"></a> +<span class="sourceLineNo">345</span> return formData(null, nameValuePairs);<a name="line.345"></a> +<span class="sourceLineNo">346</span> }<a name="line.346"></a> +<span class="sourceLineNo">347</span><a name="line.347"></a> +<span class="sourceLineNo">348</span> /**<a name="line.348"></a> +<span class="sourceLineNo">349</span> * Adds form data pairs to this request to perform a URL-encoded form post.<a name="line.349"></a> +<span class="sourceLineNo">350</span> *<a name="line.350"></a> +<span class="sourceLineNo">351</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.351"></a> +<span class="sourceLineNo">352</span> * @return This object (for method chaining).<a name="line.352"></a> +<span class="sourceLineNo">353</span> * @throws RestCallException If name was null/blank and value wasn't a {@link Map} or {@link NameValuePairs}.<a name="line.353"></a> +<span class="sourceLineNo">354</span> */<a name="line.354"></a> +<span class="sourceLineNo">355</span> public RestCall formData(Map<String,Object> params) throws RestCallException {<a name="line.355"></a> +<span class="sourceLineNo">356</span> return formData(null, params);<a name="line.356"></a> +<span class="sourceLineNo">357</span> }<a name="line.357"></a> +<span class="sourceLineNo">358</span><a name="line.358"></a> +<span class="sourceLineNo">359</span> /**<a name="line.359"></a> +<span class="sourceLineNo">360</span> * Adds a form data pair to the request if the parameter value is not <jk>null</jk> or an empty string.<a name="line.360"></a> +<span class="sourceLineNo">361</span> * <p><a name="line.361"></a> +<span class="sourceLineNo">362</span> * NE = "not empty"<a name="line.362"></a> +<span class="sourceLineNo">363</span> *<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @param name The parameter name.<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @param value The parameter value converted to a string using UON notation.<a name="line.365"></a> +<span class="sourceLineNo">366</span> * @return This object (for method chaining).<a name="line.366"></a> +<span class="sourceLineNo">367</span> * @throws RestCallException<a name="line.367"></a> +<span class="sourceLineNo">368</span> */<a name="line.368"></a> +<span class="sourceLineNo">369</span> public RestCall formDataIfNE(String name, Object value) throws RestCallException {<a name="line.369"></a> +<span class="sourceLineNo">370</span> return formData(name, value, true, null);<a name="line.370"></a> +<span class="sourceLineNo">371</span> }<a name="line.371"></a> +<span class="sourceLineNo">372</span><a name="line.372"></a> +<span class="sourceLineNo">373</span> /**<a name="line.373"></a> +<span class="sourceLineNo">374</span> * Adds form data parameters to the request for any parameters that aren't null/empty.<a name="line.374"></a> +<span class="sourceLineNo">375</span> * <p><a name="line.375"></a> +<span class="sourceLineNo">376</span> * NE = "not empty"<a name="line.376"></a> +<span class="sourceLineNo">377</span> *<a name="line.377"></a> +<span class="sourceLineNo">378</span> * @param params The parameters. Values are converted to a string using UON notation.<a name="line.378"></a> +<span class="sourceLineNo">379</span> * @return This object (for method chaining).<a name="line.379"></a> +<span class="sourceLineNo">380</span> * @throws RestCallException<a name="line.380"></a> +<span class="sourceLineNo">381</span> */<a name="line.381"></a> +<span class="sourceLineNo">382</span> public RestCall formDataIfNE(Map<String,Object> params) throws RestCallException {<a name="line.382"></a> +<span class="sourceLineNo">383</span> return formData(null, params, true, null);<a name="line.383"></a> +<span class="sourceLineNo">384</span> }<a name="line.384"></a> +<span class="sourceLineNo">385</span><a name="line.385"></a> +<span class="sourceLineNo">386</span> /**<a name="line.386"></a> +<span class="sourceLineNo">387</span> * Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.<a name="line.387"></a> +<span class="sourceLineNo">388</span> *<a name="line.388"></a> +<span class="sourceLineNo">389</span> * @param name The path variable name.<a name="line.389"></a> +<span class="sourceLineNo">390</span> * @param value The replacement value.<a name="line.390"></a> +<span class="sourceLineNo">391</span> * @param partSerializer The part serializer to use to convert the value to a string.<a name="line.391"></a> +<span class="sourceLineNo">392</span> * If <jk>null</jk>, then the URL-encoding serializer defined on the client is used.<a name="line.392"></a> +<span class="sourceLineNo">393</span> * @return This object (for method chaining).<a name="line.393"></a> +<span class="sourceLineNo">394</span> * @throws RestCallException If variable could not be found in path.<a name="line.394"></a> +<span class="sourceLineNo">395</span> */<a name="line.395"></a> +<span class="sourceLineNo">396</span> public RestCall path(String name, Object value, PartSerializer partSerializer) throws RestCallException {<a name="line.396"></a> +<span class="sourceLineNo">397</span> String path = uriBuilder.getPath();<a name="line.397"></a> +<span class="sourceLineNo">398</span> if (partSerializer == null)<a name="line.398"></a> +<span class="sourceLineNo">399</span> partSerializer = client.getPartSerializer();<a name="line.399"></a> +<span class="sourceLineNo">400</span> if (! ("*".equals(name) || isEmpty(name))) {<a name="line.400"></a> +<span class="sourceLineNo">401</span> String var = "{" + name + "}";<a name="line.401"></a> +<span class="sourceLineNo">402</span> if (path.indexOf(var) == -1)<a name="line.402"></a> +<span class="sourceLineNo">403</span> throw new RestCallException("Path variable {"+name+"} was not found in path.");<a name="line.403"></a> +<span class="sourceLineNo">404</span> String newPath = path.replace(var, partSerializer.serialize(PartType.PATH, value));<a name="line.404"></a> +<span class="sourceLineNo">405</span> uriBuilder.setPath(newPath);<a name="line.405"></a> +<span class="sourceLineNo">406</span> } else if (value instanceof NameValuePairs) {<a name="line.406"></a> +<span class="sourceLineNo">407</span> for (NameValuePair p : (NameValuePairs)value)<a name="line.407"></a> +<span class="sourceLineNo">408</span> path(p.getName(), p.getValue(), partSerializer);<a name="line.408"></a> +<span class="sourceLineNo">409</span> } else if (value instanceof Map) {<a name="line.409"></a> +<span class="sourceLineNo">410</span> for (Map.Entry<String,Object> p : ((Map<String,Object>) value).entrySet())<a name="line.410"></a> +<span class="sourceLineNo">411</span> path(p.getKey(), p.getValue(), partSerializer);<a name="line.411"></a> +<span class="sourceLineNo">412</span> } else if (isBean(value)) {<a name="line.412"></a> +<span class="sourceLineNo">413</span> return path(name, toBeanMap(value), partSerializer);<a name="line.413"></a> +<span class="sourceLineNo">414</span> } else if (value != null) {<a name="line.414"></a> +<span class="sourceLineNo">415</span> throw new FormattedRuntimeException("Invalid name ''{0}'' passed to path(name,value) for data type ''{1}''", name, ClassUtils.getReadableClassNameForObject(value));<a name="line.415"></a> +<span class="sourceLineNo">416</span> }<a name="line.416"></a> +<span class="sourceLineNo">417</span> return this;<a name="line.417"></a> +<span class="sourceLineNo">418</span> }<a name="line.418"></a> +<span class="sourceLineNo">419</span><a name="line.419"></a> +<span class="sourceLineNo">420</span> /**<a name="line.420"></a> +<span class="sourceLineNo">421</span> * Replaces a variable of the form <js>"{name}"</js> in the URL path with the specified value.<a name="line.421"></a> +<span class="sourceLineNo">422</span> *<a name="line.422"></a> +<span class="sourceLineNo">423</span> * @param name The path variable name.<a name="line.423"></a> +<span class="sourceLineNo">424</span> * @param value The replacement value.<a name="line.424"></a> +<span class="sourceLineNo">425</span> * @return This object (for method chaining).<a name="line.425"></a> +<span class="sourceLineNo">426</span> * @throws RestCallException If variable could not be found in path.<a name="line.426"></a> +<span class="sourceLineNo">427</span> */<a name="line.427"></a> +<span class="sourceLineNo">428</span> public RestCall path(String name, Object value) throws RestCallException {<a name="line.428"></a> +<span class="sourceLineNo">429</span> return path(name, value, null);<a name="line.429"></a> +<span class="sourceLineNo">430</span> }<a name="line.430"></a> +<span class="sourceLineNo">431</span><a name="line.431"></a> +<span class="sourceLineNo">432</span> /**<a name="line.432"></a> +<span class="sourceLineNo">433</span> * Sets the URI user info.<a name="line.433"></a> +<span class="sourceLineNo">434</span> *<a name="line.434"></a> +<span class="sourceLineNo">435</span> * @param userInfo The new URI user info.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * @return This object (for method chaining).<a name="line.436"></a> +<span class="sourceLineNo">437</span> */<a name="line.437"></a> +<span class="sourceLineNo">438</span> public RestCall userInfo(String userInfo) {<a name="line.438"></a> +<span class="sourceLineNo">439</span> uriBuilder.setUserInfo(userInfo);<a name="line.439"></a> +<span class="sourceLineNo">440</span>
<TRUNCATED>
