http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/80ff9b74/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestClient.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestClient.html b/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestClient.html index a8b7c2c..b6e3b37 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestClient.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/client/RestClient.html @@ -20,347 +20,347 @@ <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> <span class="sourceLineNo">013</span>package org.apache.juneau.rest.client;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> -<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span>import java.lang.reflect.*;<a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.lang.reflect.Proxy;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import java.net.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.util.concurrent.*;<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.methods.*;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.http.client.utils.*;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.http.entity.*;<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.juneau.*;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.juneau.internal.*;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.juneau.json.*;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.juneau.parser.*;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.juneau.serializer.*;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.juneau.urlencoding.*;<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span>/**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Utility class for interfacing with remote REST interfaces.<a name="line.36"></a> -<span class="sourceLineNo">037</span> *<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <h6 class='topic'>Features</h6><a name="line.38"></a> -<span class="sourceLineNo">039</span> * <ul class='spaced-list'><a name="line.39"></a> -<span class="sourceLineNo">040</span> * <li>Convert POJOs directly to HTTP request message bodies using {@link Serializer} class.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <li>Convert HTTP response message bodies directly to POJOs using {@link Parser} class.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <li>Fluent interface.<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <li>Thread safe.<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <li>API for interacting with remoteable services.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * </ul><a name="line.45"></a> -<span class="sourceLineNo">046</span> *<a name="line.46"></a> -<span class="sourceLineNo">047</span> * <h5 class='section'>Additional information:</h5><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <ul><a name="line.48"></a> -<span class="sourceLineNo">049</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.49"></a> -<span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> -<span class="sourceLineNo">051</span> */<a name="line.51"></a> -<span class="sourceLineNo">052</span>public class RestClient extends CoreObject {<a name="line.52"></a> -<span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span> private final Map<String,String> headers;<a name="line.54"></a> -<span class="sourceLineNo">055</span> private final CloseableHttpClient httpClient;<a name="line.55"></a> -<span class="sourceLineNo">056</span> private final boolean keepHttpClientOpen;<a name="line.56"></a> -<span class="sourceLineNo">057</span> final Serializer serializer;<a name="line.57"></a> -<span class="sourceLineNo">058</span> private final UrlEncodingSerializer urlEncodingSerializer; // Used for form posts only.<a name="line.58"></a> -<span class="sourceLineNo">059</span> final Parser parser;<a name="line.59"></a> -<span class="sourceLineNo">060</span> private final String remoteableServletUri;<a name="line.60"></a> +<span class="sourceLineNo">015</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span><a name="line.16"></a> +<span class="sourceLineNo">017</span>import java.io.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.lang.reflect.Proxy;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.net.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.*;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.concurrent.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.regex.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span><a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.http.*;<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.entity.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.http.impl.client.*;<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.internal.*;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.juneau.json.*;<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.remoteable.*;<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.urlencoding.*;<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> * Utility class for interfacing with remote REST interfaces.<a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <h6 class='topic'>Features</h6><a name="line.41"></a> +<span class="sourceLineNo">042</span> * <ul class='spaced-list'><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <li>Convert POJOs directly to HTTP request message bodies using {@link Serializer} class.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <li>Convert HTTP response message bodies directly to POJOs using {@link Parser} class.<a name="line.44"></a> +<span class="sourceLineNo">045</span> * <li>Fluent interface.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <li>Thread safe.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <li>API for interacting with remoteable services.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * </ul><a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <h5 class='section'>Additional information:</h5><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <ul><a name="line.51"></a> +<span class="sourceLineNo">052</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.52"></a> +<span class="sourceLineNo">053</span> * </ul><a name="line.53"></a> +<span class="sourceLineNo">054</span> */<a name="line.54"></a> +<span class="sourceLineNo">055</span>public class RestClient extends CoreObject {<a name="line.55"></a> +<span class="sourceLineNo">056</span><a name="line.56"></a> +<span class="sourceLineNo">057</span> private final Map<String,String> headers;<a name="line.57"></a> +<span class="sourceLineNo">058</span> private final CloseableHttpClient httpClient;<a name="line.58"></a> +<span class="sourceLineNo">059</span> private final boolean keepHttpClientOpen;<a name="line.59"></a> +<span class="sourceLineNo">060</span> private final UrlEncodingSerializer urlEncodingSerializer; // Used for form posts only.<a name="line.60"></a> <span class="sourceLineNo">061</span> private final String rootUrl;<a name="line.61"></a> <span class="sourceLineNo">062</span> private volatile boolean isClosed = false;<a name="line.62"></a> <span class="sourceLineNo">063</span> private final StackTraceElement[] creationStack;<a name="line.63"></a> <span class="sourceLineNo">064</span> private StackTraceElement[] closedStack;<a name="line.64"></a> -<span class="sourceLineNo">065</span> final RetryOn retryOn;<a name="line.65"></a> -<span class="sourceLineNo">066</span> final int retries;<a name="line.66"></a> -<span class="sourceLineNo">067</span> final long retryInterval;<a name="line.67"></a> -<span class="sourceLineNo">068</span> final boolean debug;<a name="line.68"></a> -<span class="sourceLineNo">069</span> final RestCallInterceptor[] interceptors;<a name="line.69"></a> -<span class="sourceLineNo">070</span> final ExecutorService executorService;<a name="line.70"></a> -<span class="sourceLineNo">071</span> final boolean executorServiceShutdownOnClose;<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> /**<a name="line.73"></a> -<span class="sourceLineNo">074</span> * Create a new REST client.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @param propertyStore<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param httpClient<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @param keepHttpClientOpen<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param serializer<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @param parser<a name="line.79"></a> -<span class="sourceLineNo">080</span> * @param urlEncodingSerializer<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @param headers<a name="line.81"></a> -<span class="sourceLineNo">082</span> * @param interceptors<a name="line.82"></a> -<span class="sourceLineNo">083</span> * @param remoteableServletUri<a name="line.83"></a> -<span class="sourceLineNo">084</span> * @param remoteableServiceUriMap<a name="line.84"></a> -<span class="sourceLineNo">085</span> * @param rootUri<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @param retryOn<a name="line.86"></a> -<span class="sourceLineNo">087</span> * @param retries<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param retryInterval<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @param debug<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @param executorService<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @param executorServiceShutdownOnClose<a name="line.91"></a> -<span class="sourceLineNo">092</span> */<a name="line.92"></a> -<span class="sourceLineNo">093</span> public RestClient(<a name="line.93"></a> -<span class="sourceLineNo">094</span> PropertyStore propertyStore,<a name="line.94"></a> -<span class="sourceLineNo">095</span> CloseableHttpClient httpClient,<a name="line.95"></a> -<span class="sourceLineNo">096</span> boolean keepHttpClientOpen,<a name="line.96"></a> -<span class="sourceLineNo">097</span> Serializer serializer,<a name="line.97"></a> -<span class="sourceLineNo">098</span> Parser parser,<a name="line.98"></a> -<span class="sourceLineNo">099</span> UrlEncodingSerializer urlEncodingSerializer,<a name="line.99"></a> -<span class="sourceLineNo">100</span> Map<String,String> headers,<a name="line.100"></a> -<span class="sourceLineNo">101</span> List<RestCallInterceptor> interceptors,<a name="line.101"></a> -<span class="sourceLineNo">102</span> String remoteableServletUri,<a name="line.102"></a> -<span class="sourceLineNo">103</span> Map<Method,String> remoteableServiceUriMap,<a name="line.103"></a> -<span class="sourceLineNo">104</span> String rootUri,<a name="line.104"></a> -<span class="sourceLineNo">105</span> RetryOn retryOn,<a name="line.105"></a> -<span class="sourceLineNo">106</span> int retries,<a name="line.106"></a> -<span class="sourceLineNo">107</span> long retryInterval,<a name="line.107"></a> -<span class="sourceLineNo">108</span> boolean debug,<a name="line.108"></a> -<span class="sourceLineNo">109</span> ExecutorService executorService,<a name="line.109"></a> -<span class="sourceLineNo">110</span> boolean executorServiceShutdownOnClose) {<a name="line.110"></a> -<span class="sourceLineNo">111</span> super(propertyStore);<a name="line.111"></a> -<span class="sourceLineNo">112</span> this.httpClient = httpClient;<a name="line.112"></a> -<span class="sourceLineNo">113</span> this.keepHttpClientOpen = keepHttpClientOpen;<a name="line.113"></a> -<span class="sourceLineNo">114</span> this.serializer = serializer;<a name="line.114"></a> -<span class="sourceLineNo">115</span> this.parser = parser;<a name="line.115"></a> -<span class="sourceLineNo">116</span> this.urlEncodingSerializer = urlEncodingSerializer;<a name="line.116"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> // These are read directly by RestCall.<a name="line.66"></a> +<span class="sourceLineNo">067</span> final Serializer serializer;<a name="line.67"></a> +<span class="sourceLineNo">068</span> final Parser parser;<a name="line.68"></a> +<span class="sourceLineNo">069</span> final RetryOn retryOn;<a name="line.69"></a> +<span class="sourceLineNo">070</span> final int retries;<a name="line.70"></a> +<span class="sourceLineNo">071</span> final long retryInterval;<a name="line.71"></a> +<span class="sourceLineNo">072</span> final boolean debug;<a name="line.72"></a> +<span class="sourceLineNo">073</span> final RestCallInterceptor[] interceptors;<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> // This is lazy-created.<a name="line.75"></a> +<span class="sourceLineNo">076</span> private volatile ExecutorService executorService;<a name="line.76"></a> +<span class="sourceLineNo">077</span> boolean executorServiceShutdownOnClose = true;<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span><a name="line.79"></a> +<span class="sourceLineNo">080</span> RestClient(<a name="line.80"></a> +<span class="sourceLineNo">081</span> PropertyStore propertyStore,<a name="line.81"></a> +<span class="sourceLineNo">082</span> CloseableHttpClient httpClient,<a name="line.82"></a> +<span class="sourceLineNo">083</span> boolean keepHttpClientOpen,<a name="line.83"></a> +<span class="sourceLineNo">084</span> Serializer serializer,<a name="line.84"></a> +<span class="sourceLineNo">085</span> Parser parser,<a name="line.85"></a> +<span class="sourceLineNo">086</span> UrlEncodingSerializer urlEncodingSerializer,<a name="line.86"></a> +<span class="sourceLineNo">087</span> Map<String,String> headers,<a name="line.87"></a> +<span class="sourceLineNo">088</span> List<RestCallInterceptor> interceptors,<a name="line.88"></a> +<span class="sourceLineNo">089</span> String rootUri,<a name="line.89"></a> +<span class="sourceLineNo">090</span> RetryOn retryOn,<a name="line.90"></a> +<span class="sourceLineNo">091</span> int retries,<a name="line.91"></a> +<span class="sourceLineNo">092</span> long retryInterval,<a name="line.92"></a> +<span class="sourceLineNo">093</span> boolean debug,<a name="line.93"></a> +<span class="sourceLineNo">094</span> ExecutorService executorService,<a name="line.94"></a> +<span class="sourceLineNo">095</span> boolean executorServiceShutdownOnClose) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> super(propertyStore);<a name="line.96"></a> +<span class="sourceLineNo">097</span> this.httpClient = httpClient;<a name="line.97"></a> +<span class="sourceLineNo">098</span> this.keepHttpClientOpen = keepHttpClientOpen;<a name="line.98"></a> +<span class="sourceLineNo">099</span> this.serializer = serializer;<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.parser = parser;<a name="line.100"></a> +<span class="sourceLineNo">101</span> this.urlEncodingSerializer = urlEncodingSerializer;<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> Map<String,String> h2 = new ConcurrentHashMap<String,String>(headers);<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> this.headers = Collections.unmodifiableMap(h2);<a name="line.105"></a> +<span class="sourceLineNo">106</span> this.rootUrl = rootUri;<a name="line.106"></a> +<span class="sourceLineNo">107</span> this.retryOn = retryOn;<a name="line.107"></a> +<span class="sourceLineNo">108</span> this.retries = retries;<a name="line.108"></a> +<span class="sourceLineNo">109</span> this.retryInterval = retryInterval;<a name="line.109"></a> +<span class="sourceLineNo">110</span> this.debug = debug;<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> List<RestCallInterceptor> l = new ArrayList<RestCallInterceptor>(interceptors);<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (debug)<a name="line.113"></a> +<span class="sourceLineNo">114</span> l.add(RestCallLogger.DEFAULT);<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> this.interceptors = l.toArray(new RestCallInterceptor[l.size()]);<a name="line.116"></a> <span class="sourceLineNo">117</span><a name="line.117"></a> -<span class="sourceLineNo">118</span> Map<String,String> h2 = new ConcurrentHashMap<String,String>(headers);<a name="line.118"></a> -<span class="sourceLineNo">119</span><a name="line.119"></a> -<span class="sourceLineNo">120</span> this.headers = Collections.unmodifiableMap(h2);<a name="line.120"></a> -<span class="sourceLineNo">121</span> this.remoteableServletUri = remoteableServletUri;<a name="line.121"></a> -<span class="sourceLineNo">122</span> this.rootUrl = rootUri;<a name="line.122"></a> -<span class="sourceLineNo">123</span> this.retryOn = retryOn;<a name="line.123"></a> -<span class="sourceLineNo">124</span> this.retries = retries;<a name="line.124"></a> -<span class="sourceLineNo">125</span> this.retryInterval = retryInterval;<a name="line.125"></a> -<span class="sourceLineNo">126</span> this.debug = debug;<a name="line.126"></a> -<span class="sourceLineNo">127</span><a name="line.127"></a> -<span class="sourceLineNo">128</span> List<RestCallInterceptor> l = new ArrayList<RestCallInterceptor>(interceptors);<a name="line.128"></a> -<span class="sourceLineNo">129</span> if (debug)<a name="line.129"></a> -<span class="sourceLineNo">130</span> l.add(RestCallLogger.DEFAULT);<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> this.interceptors = l.toArray(new RestCallInterceptor[l.size()]);<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.134"></a> -<span class="sourceLineNo">135</span> creationStack = Thread.currentThread().getStackTrace();<a name="line.135"></a> -<span class="sourceLineNo">136</span> else<a name="line.136"></a> -<span class="sourceLineNo">137</span> creationStack = null;<a name="line.137"></a> -<span class="sourceLineNo">138</span><a name="line.138"></a> -<span class="sourceLineNo">139</span> this.executorService = executorService;<a name="line.139"></a> -<span class="sourceLineNo">140</span> this.executorServiceShutdownOnClose = executorServiceShutdownOnClose;<a name="line.140"></a> +<span class="sourceLineNo">118</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.118"></a> +<span class="sourceLineNo">119</span> creationStack = Thread.currentThread().getStackTrace();<a name="line.119"></a> +<span class="sourceLineNo">120</span> else<a name="line.120"></a> +<span class="sourceLineNo">121</span> creationStack = null;<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> this.executorService = executorService;<a name="line.123"></a> +<span class="sourceLineNo">124</span> this.executorServiceShutdownOnClose = executorServiceShutdownOnClose;<a name="line.124"></a> +<span class="sourceLineNo">125</span> }<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> /**<a name="line.127"></a> +<span class="sourceLineNo">128</span> * Calls {@link CloseableHttpClient#close()} on the underlying {@link CloseableHttpClient}.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * It's good practice to call this method after the client is no longer used.<a name="line.129"></a> +<span class="sourceLineNo">130</span> *<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @throws IOException<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span> public void close() throws IOException {<a name="line.133"></a> +<span class="sourceLineNo">134</span> isClosed = true;<a name="line.134"></a> +<span class="sourceLineNo">135</span> if (httpClient != null && ! keepHttpClientOpen)<a name="line.135"></a> +<span class="sourceLineNo">136</span> httpClient.close();<a name="line.136"></a> +<span class="sourceLineNo">137</span> if (executorService != null && executorServiceShutdownOnClose)<a name="line.137"></a> +<span class="sourceLineNo">138</span> executorService.shutdown();<a name="line.138"></a> +<span class="sourceLineNo">139</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.139"></a> +<span class="sourceLineNo">140</span> closedStack = Thread.currentThread().getStackTrace();<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> * Calls {@link CloseableHttpClient#close()} on the underlying {@link CloseableHttpClient}.<a name="line.144"></a> -<span class="sourceLineNo">145</span> * It's good practice to call this method after the client is no longer used.<a name="line.145"></a> -<span class="sourceLineNo">146</span> *<a name="line.146"></a> -<span class="sourceLineNo">147</span> * @throws IOException<a name="line.147"></a> -<span class="sourceLineNo">148</span> */<a name="line.148"></a> -<span class="sourceLineNo">149</span> public void close() throws IOException {<a name="line.149"></a> -<span class="sourceLineNo">150</span> isClosed = true;<a name="line.150"></a> -<span class="sourceLineNo">151</span> if (httpClient != null && ! keepHttpClientOpen)<a name="line.151"></a> -<span class="sourceLineNo">152</span> httpClient.close();<a name="line.152"></a> -<span class="sourceLineNo">153</span> if (executorService != null && executorServiceShutdownOnClose)<a name="line.153"></a> -<span class="sourceLineNo">154</span> executorService.shutdown();<a name="line.154"></a> -<span class="sourceLineNo">155</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.155"></a> -<span class="sourceLineNo">156</span> closedStack = Thread.currentThread().getStackTrace();<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<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> * Same as {@link #close()}, but ignores any exceptions.<a name="line.160"></a> -<span class="sourceLineNo">161</span> */<a name="line.161"></a> -<span class="sourceLineNo">162</span> public void closeQuietly() {<a name="line.162"></a> -<span class="sourceLineNo">163</span> isClosed = true;<a name="line.163"></a> -<span class="sourceLineNo">164</span> try {<a name="line.164"></a> -<span class="sourceLineNo">165</span> if (httpClient != null && ! keepHttpClientOpen)<a name="line.165"></a> -<span class="sourceLineNo">166</span> httpClient.close();<a name="line.166"></a> -<span class="sourceLineNo">167</span> if (executorService != null && executorServiceShutdownOnClose)<a name="line.167"></a> -<span class="sourceLineNo">168</span> executorService.shutdown();<a name="line.168"></a> -<span class="sourceLineNo">169</span> } catch (Throwable t) {}<a name="line.169"></a> -<span class="sourceLineNo">170</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.170"></a> -<span class="sourceLineNo">171</span> closedStack = Thread.currentThread().getStackTrace();<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> * Execute the specified request.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * Subclasses can override this method to provide specialized handling.<a name="line.176"></a> -<span class="sourceLineNo">177</span> *<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @param req The HTTP request.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @return The HTTP response.<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @throws Exception<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> protected HttpResponse execute(HttpUriRequest req) throws Exception {<a name="line.182"></a> -<span class="sourceLineNo">183</span> return httpClient.execute(req);<a name="line.183"></a> -<span class="sourceLineNo">184</span> }<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Perform a <code>GET</code> request against the specified URL.<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.190"></a> -<span class="sourceLineNo">191</span> * and getting the response as a parsed object.<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @throws RestCallException If any authentication errors occurred.<a name="line.192"></a> -<span class="sourceLineNo">193</span> */<a name="line.193"></a> -<span class="sourceLineNo">194</span> public RestCall doGet(Object url) throws RestCallException {<a name="line.194"></a> -<span class="sourceLineNo">195</span> return doCall("GET", url, false);<a name="line.195"></a> -<span class="sourceLineNo">196</span> }<a name="line.196"></a> -<span class="sourceLineNo">197</span><a name="line.197"></a> -<span class="sourceLineNo">198</span> /**<a name="line.198"></a> -<span class="sourceLineNo">199</span> * Perform a <code>PUT</code> request against the specified URL.<a name="line.199"></a> -<span class="sourceLineNo">200</span> *<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @param o The object to serialize and transmit to the URL as the body of the request.<a name="line.202"></a> -<span class="sourceLineNo">203</span> * Can be of the following types:<a name="line.203"></a> -<span class="sourceLineNo">204</span> * <ul class='spaced-list'><a name="line.204"></a> -<span class="sourceLineNo">205</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.206"></a> -<span class="sourceLineNo">207</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.207"></a> -<span class="sourceLineNo">208</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * </ul><a name="line.209"></a> -<span class="sourceLineNo">210</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.210"></a> -<span class="sourceLineNo">211</span> * and getting the response as a parsed object.<a name="line.211"></a> -<span class="sourceLineNo">212</span> * @throws RestCallException If any authentication errors occurred.<a name="line.212"></a> -<span class="sourceLineNo">213</span> */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public RestCall doPut(Object url, Object o) throws RestCallException {<a name="line.214"></a> -<span class="sourceLineNo">215</span> return doCall("PUT", url, true).input(o);<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> * Perform a <code>POST</code> request against the specified URL.<a name="line.219"></a> -<span class="sourceLineNo">220</span> *<a name="line.220"></a> -<span class="sourceLineNo">221</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.221"></a> -<span class="sourceLineNo">222</span> * @param o The object to serialize and transmit to the URL as the body of the request.<a name="line.222"></a> -<span class="sourceLineNo">223</span> * Can be of the following types:<a name="line.223"></a> -<span class="sourceLineNo">224</span> * <ul class='spaced-list'><a name="line.224"></a> -<span class="sourceLineNo">225</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.225"></a> -<span class="sourceLineNo">226</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.226"></a> -<span class="sourceLineNo">227</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.227"></a> -<span class="sourceLineNo">228</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * </ul><a name="line.229"></a> -<span class="sourceLineNo">230</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.230"></a> -<span class="sourceLineNo">231</span> * and getting the response as a parsed object.<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @throws RestCallException If any authentication errors occurred.<a name="line.232"></a> -<span class="sourceLineNo">233</span> */<a name="line.233"></a> -<span class="sourceLineNo">234</span> public RestCall doPost(Object url, Object o) throws RestCallException {<a name="line.234"></a> -<span class="sourceLineNo">235</span> return doCall("POST", url, true).input(o);<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> /**<a name="line.238"></a> -<span class="sourceLineNo">239</span> * Perform a <code>DELETE</code> request against the specified URL.<a name="line.239"></a> -<span class="sourceLineNo">240</span> *<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.241"></a> -<span class="sourceLineNo">242</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.242"></a> -<span class="sourceLineNo">243</span> * and getting the response as a parsed object.<a name="line.243"></a> -<span class="sourceLineNo">244</span> * @throws RestCallException If any authentication errors occurred.<a name="line.244"></a> -<span class="sourceLineNo">245</span> */<a name="line.245"></a> -<span class="sourceLineNo">246</span> public RestCall doDelete(Object url) throws RestCallException {<a name="line.246"></a> -<span class="sourceLineNo">247</span> return doCall("DELETE", url, false);<a name="line.247"></a> -<span class="sourceLineNo">248</span> }<a name="line.248"></a> -<span class="sourceLineNo">249</span><a name="line.249"></a> -<span class="sourceLineNo">250</span> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * Perform an <code>OPTIONS</code> request against the specified URL.<a name="line.251"></a> -<span class="sourceLineNo">252</span> *<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.253"></a> -<span class="sourceLineNo">254</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.254"></a> -<span class="sourceLineNo">255</span> * and getting the response as a parsed object.<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @throws RestCallException If any authentication errors occurred.<a name="line.256"></a> -<span class="sourceLineNo">257</span> */<a name="line.257"></a> -<span class="sourceLineNo">258</span> public RestCall doOptions(Object url) throws RestCallException {<a name="line.258"></a> -<span class="sourceLineNo">259</span> return doCall("OPTIONS", url, true);<a name="line.259"></a> -<span class="sourceLineNo">260</span> }<a name="line.260"></a> -<span class="sourceLineNo">261</span><a name="line.261"></a> -<span class="sourceLineNo">262</span> /**<a name="line.262"></a> -<span class="sourceLineNo">263</span> * Perform a <code>POST</code> request with a content type of <code>application/x-www-form-urlencoded</code> against the specified URL.<a name="line.263"></a> -<span class="sourceLineNo">264</span> *<a name="line.264"></a> -<span class="sourceLineNo">265</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.265"></a> -<span class="sourceLineNo">266</span> * @param o The object to serialize and transmit to the URL as the body of the request, serialized as a form post<a name="line.266"></a> -<span class="sourceLineNo">267</span> * using the {@link UrlEncodingSerializer#DEFAULT} serializer.<a name="line.267"></a> -<span class="sourceLineNo">268</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.268"></a> -<span class="sourceLineNo">269</span> * and getting the response as a parsed object.<a name="line.269"></a> -<span class="sourceLineNo">270</span> * @throws RestCallException If any authentication errors occurred.<a name="line.270"></a> -<span class="sourceLineNo">271</span> */<a name="line.271"></a> -<span class="sourceLineNo">272</span> public RestCall doFormPost(Object url, Object o) throws RestCallException {<a name="line.272"></a> -<span class="sourceLineNo">273</span> return doCall("POST", url, true)<a name="line.273"></a> -<span class="sourceLineNo">274</span> .input(o instanceof HttpEntity ? o : new RestRequestEntity(o, urlEncodingSerializer));<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> * Performs a REST call where the entire call is specified in a simple string.<a name="line.278"></a> -<span class="sourceLineNo">279</span> * <p><a name="line.279"></a> -<span class="sourceLineNo">280</span> * This method is useful for performing callbacks when the target of a callback is passed in<a name="line.280"></a> -<span class="sourceLineNo">281</span> * on an initial request, for example to signal when a long-running process has completed.<a name="line.281"></a> -<span class="sourceLineNo">282</span> * <p><a name="line.282"></a> -<span class="sourceLineNo">283</span> * The call string can be any of the following formats:<a name="line.283"></a> -<span class="sourceLineNo">284</span> * <ul class='spaced-list'><a name="line.284"></a> -<span class="sourceLineNo">285</span> * <li><js>"[method] [url]"</js> - e.g. <js>"GET http://localhost/callback"</js><a name="line.285"></a> -<span class="sourceLineNo">286</span> * <li><js>"[method] [url] [payload]"</js> - e.g. <js>"POST http://localhost/callback some text payload"</js><a name="line.286"></a> -<span class="sourceLineNo">287</span> * <li><js>"[method] [headers] [url] [payload]"</js> - e.g. <js>"POST {'Content-Type':'text/json'} http://localhost/callback {'some':'json'}"</js><a name="line.287"></a> -<span class="sourceLineNo">288</span> * </ul><a name="line.288"></a> -<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> -<span class="sourceLineNo">290</span> * The payload will always be sent using a simple {@link StringEntity}.<a name="line.290"></a> -<span class="sourceLineNo">291</span> *<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @param callString The call string.<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.293"></a> -<span class="sourceLineNo">294</span> * and getting the response as a parsed object.<a name="line.294"></a> -<span class="sourceLineNo">295</span> * @throws RestCallException<a name="line.295"></a> -<span class="sourceLineNo">296</span> */<a name="line.296"></a> -<span class="sourceLineNo">297</span> public RestCall doCallback(String callString) throws RestCallException {<a name="line.297"></a> -<span class="sourceLineNo">298</span> String s = callString;<a name="line.298"></a> -<span class="sourceLineNo">299</span> try {<a name="line.299"></a> -<span class="sourceLineNo">300</span> RestCall rc = null;<a name="line.300"></a> -<span class="sourceLineNo">301</span> String method = null, uri = null, content = null;<a name="line.301"></a> -<span class="sourceLineNo">302</span> ObjectMap h = null;<a name="line.302"></a> -<span class="sourceLineNo">303</span> int i = s.indexOf(' ');<a name="line.303"></a> -<span class="sourceLineNo">304</span> if (i != -1) {<a name="line.304"></a> -<span class="sourceLineNo">305</span> method = s.substring(0, i).trim();<a name="line.305"></a> -<span class="sourceLineNo">306</span> s = s.substring(i).trim();<a name="line.306"></a> -<span class="sourceLineNo">307</span> if (s.length() > 0) {<a name="line.307"></a> -<span class="sourceLineNo">308</span> if (s.charAt(0) == '{') {<a name="line.308"></a> -<span class="sourceLineNo">309</span> i = s.indexOf('}');<a name="line.309"></a> -<span class="sourceLineNo">310</span> if (i != -1) {<a name="line.310"></a> -<span class="sourceLineNo">311</span> String json = s.substring(0, i+1);<a name="line.311"></a> -<span class="sourceLineNo">312</span> h = JsonParser.DEFAULT.parse(json, ObjectMap.class);<a name="line.312"></a> -<span class="sourceLineNo">313</span> s = s.substring(i+1).trim();<a name="line.313"></a> -<span class="sourceLineNo">314</span> }<a name="line.314"></a> -<span class="sourceLineNo">315</span> }<a name="line.315"></a> -<span class="sourceLineNo">316</span> if (s.length() > 0) {<a name="line.316"></a> -<span class="sourceLineNo">317</span> i = s.indexOf(' ');<a name="line.317"></a> -<span class="sourceLineNo">318</span> if (i == -1)<a name="line.318"></a> -<span class="sourceLineNo">319</span> uri = s;<a name="line.319"></a> -<span class="sourceLineNo">320</span> else {<a name="line.320"></a> -<span class="sourceLineNo">321</span> uri = s.substring(0, i).trim();<a name="line.321"></a> -<span class="sourceLineNo">322</span> s = s.substring(i).trim();<a name="line.322"></a> -<span class="sourceLineNo">323</span> if (s.length() > 0)<a name="line.323"></a> -<span class="sourceLineNo">324</span> content = s;<a name="line.324"></a> -<span class="sourceLineNo">325</span> }<a name="line.325"></a> -<span class="sourceLineNo">326</span> }<a name="line.326"></a> -<span class="sourceLineNo">327</span> }<a name="line.327"></a> -<span class="sourceLineNo">328</span> }<a name="line.328"></a> -<span class="sourceLineNo">329</span> if (method != null && uri != null) {<a name="line.329"></a> -<span class="sourceLineNo">330</span> rc = doCall(method, uri, content != null);<a name="line.330"></a> -<span class="sourceLineNo">331</span> if (content != null)<a name="line.331"></a> -<span class="sourceLineNo">332</span> rc.input(new StringEntity(content));<a name="line.332"></a> -<span class="sourceLineNo">333</span> if (h != null)<a name="line.333"></a> -<span class="sourceLineNo">334</span> for (Map.Entry<String,Object> e : h.entrySet())<a name="line.334"></a> -<span class="sourceLineNo">335</span> rc.header(e.getKey(), e.getValue());<a name="line.335"></a> -<span class="sourceLineNo">336</span> return rc;<a name="line.336"></a> -<span class="sourceLineNo">337</span> }<a name="line.337"></a> -<span class="sourceLineNo">338</span> } catch (Exception e) {<a name="line.338"></a> -<span class="sourceLineNo">339</span> throw new RestCallException(e);<a name="line.339"></a> -<span class="sourceLineNo">340</span> }<a name="line.340"></a> -<span class="sourceLineNo">341</span> throw new RestCallException("Invalid format for call string.");<a name="line.341"></a> -<span class="sourceLineNo">342</span> }<a name="line.342"></a> -<span class="sourceLineNo">343</span><a name="line.343"></a> -<span class="sourceLineNo">344</span> /**<a name="line.344"></a> -<span class="sourceLineNo">345</span> * Perform a generic REST call.<a name="line.345"></a> -<span class="sourceLineNo">346</span> *<a name="line.346"></a> -<span class="sourceLineNo">347</span> * @param method The HTTP method.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @param content The HTTP body content.<a name="line.349"></a> -<span class="sourceLineNo">350</span> * Can be of the following types:<a name="line.350"></a> -<span class="sourceLineNo">351</span> * <ul class='spaced-list'><a name="line.351"></a> -<span class="sourceLineNo">352</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.352"></a> -<span class="sourceLineNo">353</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.354"></a> -<span class="sourceLineNo">355</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.355"></a> +<span class="sourceLineNo">144</span> * Same as {@link #close()}, but ignores any exceptions.<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> public void closeQuietly() {<a name="line.146"></a> +<span class="sourceLineNo">147</span> isClosed = true;<a name="line.147"></a> +<span class="sourceLineNo">148</span> try {<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (httpClient != null && ! keepHttpClientOpen)<a name="line.149"></a> +<span class="sourceLineNo">150</span> httpClient.close();<a name="line.150"></a> +<span class="sourceLineNo">151</span> if (executorService != null && executorServiceShutdownOnClose)<a name="line.151"></a> +<span class="sourceLineNo">152</span> executorService.shutdown();<a name="line.152"></a> +<span class="sourceLineNo">153</span> } catch (Throwable t) {}<a name="line.153"></a> +<span class="sourceLineNo">154</span> if (Boolean.getBoolean("org.apache.juneau.rest.client.RestClient.trackLifecycle"))<a name="line.154"></a> +<span class="sourceLineNo">155</span> closedStack = Thread.currentThread().getStackTrace();<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> /**<a name="line.158"></a> +<span class="sourceLineNo">159</span> * Execute the specified request.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * Subclasses can override this method to provide specialized handling.<a name="line.160"></a> +<span class="sourceLineNo">161</span> *<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @param req The HTTP request.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return The HTTP response.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @throws Exception<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> protected HttpResponse execute(HttpUriRequest req) throws Exception {<a name="line.166"></a> +<span class="sourceLineNo">167</span> return httpClient.execute(req);<a name="line.167"></a> +<span class="sourceLineNo">168</span> }<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> * Perform a <code>GET</code> request against the specified URL.<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.174"></a> +<span class="sourceLineNo">175</span> * and getting the response as a parsed object.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @throws RestCallException If any authentication errors occurred.<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> public RestCall doGet(Object url) throws RestCallException {<a name="line.178"></a> +<span class="sourceLineNo">179</span> return doCall("GET", url, false);<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> /**<a name="line.182"></a> +<span class="sourceLineNo">183</span> * Perform a <code>PUT</code> request against the specified URL.<a name="line.183"></a> +<span class="sourceLineNo">184</span> *<a name="line.184"></a> +<span class="sourceLineNo">185</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * @param o The object to serialize and transmit to the URL as the body of the request.<a name="line.186"></a> +<span class="sourceLineNo">187</span> * Can be of the following types:<a name="line.187"></a> +<span class="sourceLineNo">188</span> * <ul class='spaced-list'><a name="line.188"></a> +<span class="sourceLineNo">189</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.190"></a> +<span class="sourceLineNo">191</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * </ul><a name="line.193"></a> +<span class="sourceLineNo">194</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.194"></a> +<span class="sourceLineNo">195</span> * and getting the response as a parsed object.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @throws RestCallException If any authentication errors occurred.<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public RestCall doPut(Object url, Object o) throws RestCallException {<a name="line.198"></a> +<span class="sourceLineNo">199</span> return doCall("PUT", url, true).input(o);<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> /**<a name="line.202"></a> +<span class="sourceLineNo">203</span> * Perform a <code>POST</code> request against the specified URL.<a name="line.203"></a> +<span class="sourceLineNo">204</span> *<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.205"></a> +<span class="sourceLineNo">206</span> * @param o The object to serialize and transmit to the URL as the body of the request.<a name="line.206"></a> +<span class="sourceLineNo">207</span> * Can be of the following types:<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <ul class='spaced-list'><a name="line.208"></a> +<span class="sourceLineNo">209</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.211"></a> +<span class="sourceLineNo">212</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * </ul><a name="line.213"></a> +<span class="sourceLineNo">214</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.214"></a> +<span class="sourceLineNo">215</span> * and getting the response as a parsed object.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @throws RestCallException If any authentication errors occurred.<a name="line.216"></a> +<span class="sourceLineNo">217</span> */<a name="line.217"></a> +<span class="sourceLineNo">218</span> public RestCall doPost(Object url, Object o) throws RestCallException {<a name="line.218"></a> +<span class="sourceLineNo">219</span> return doCall("POST", url, true).input(o);<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> * Same as {@link #doPost(Object, Object)} but don't specify the input yet.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <p><a name="line.224"></a> +<span class="sourceLineNo">225</span> * You must call either {@link RestCall#input(Object)} or {@link RestCall#formData(String, Object)}<a name="line.225"></a> +<span class="sourceLineNo">226</span> * to set the contents on the result object.<a name="line.226"></a> +<span class="sourceLineNo">227</span> *<a name="line.227"></a> +<span class="sourceLineNo">228</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.229"></a> +<span class="sourceLineNo">230</span> * and getting the response as a parsed object.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @throws RestCallException<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> public RestCall doPost(Object url) throws RestCallException {<a name="line.233"></a> +<span class="sourceLineNo">234</span> return doCall("POST", url, true);<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> * Perform a <code>DELETE</code> request against the specified URL.<a name="line.238"></a> +<span class="sourceLineNo">239</span> *<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.241"></a> +<span class="sourceLineNo">242</span> * and getting the response as a parsed object.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @throws RestCallException If any authentication errors occurred.<a name="line.243"></a> +<span class="sourceLineNo">244</span> */<a name="line.244"></a> +<span class="sourceLineNo">245</span> public RestCall doDelete(Object url) throws RestCallException {<a name="line.245"></a> +<span class="sourceLineNo">246</span> return doCall("DELETE", url, false);<a name="line.246"></a> +<span class="sourceLineNo">247</span> }<a name="line.247"></a> +<span class="sourceLineNo">248</span><a name="line.248"></a> +<span class="sourceLineNo">249</span> /**<a name="line.249"></a> +<span class="sourceLineNo">250</span> * Perform an <code>OPTIONS</code> request against the specified URL.<a name="line.250"></a> +<span class="sourceLineNo">251</span> *<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.252"></a> +<span class="sourceLineNo">253</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.253"></a> +<span class="sourceLineNo">254</span> * and getting the response as a parsed object.<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @throws RestCallException If any authentication errors occurred.<a name="line.255"></a> +<span class="sourceLineNo">256</span> */<a name="line.256"></a> +<span class="sourceLineNo">257</span> public RestCall doOptions(Object url) throws RestCallException {<a name="line.257"></a> +<span class="sourceLineNo">258</span> return doCall("OPTIONS", url, true);<a name="line.258"></a> +<span class="sourceLineNo">259</span> }<a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> /**<a name="line.261"></a> +<span class="sourceLineNo">262</span> * Perform a <code>POST</code> request with a content type of <code>application/x-www-form-urlencoded</code> against the specified URL.<a name="line.262"></a> +<span class="sourceLineNo">263</span> *<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @param o The object to serialize and transmit to the URL as the body of the request, serialized as a form post<a name="line.265"></a> +<span class="sourceLineNo">266</span> * using the {@link UrlEncodingSerializer#DEFAULT} serializer.<a name="line.266"></a> +<span class="sourceLineNo">267</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.267"></a> +<span class="sourceLineNo">268</span> * and getting the response as a parsed object.<a name="line.268"></a> +<span class="sourceLineNo">269</span> * @throws RestCallException If any authentication errors occurred.<a name="line.269"></a> +<span class="sourceLineNo">270</span> */<a name="line.270"></a> +<span class="sourceLineNo">271</span> public RestCall doFormPost(Object url, Object o) throws RestCallException {<a name="line.271"></a> +<span class="sourceLineNo">272</span> return doCall("POST", url, true)<a name="line.272"></a> +<span class="sourceLineNo">273</span> .input(o instanceof HttpEntity ? o : new RestRequestEntity(o, urlEncodingSerializer));<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> /**<a name="line.276"></a> +<span class="sourceLineNo">277</span> * Performs a REST call where the entire call is specified in a simple string.<a name="line.277"></a> +<span class="sourceLineNo">278</span> * <p><a name="line.278"></a> +<span class="sourceLineNo">279</span> * This method is useful for performing callbacks when the target of a callback is passed in<a name="line.279"></a> +<span class="sourceLineNo">280</span> * on an initial request, for example to signal when a long-running process has completed.<a name="line.280"></a> +<span class="sourceLineNo">281</span> * <p><a name="line.281"></a> +<span class="sourceLineNo">282</span> * The call string can be any of the following formats:<a name="line.282"></a> +<span class="sourceLineNo">283</span> * <ul class='spaced-list'><a name="line.283"></a> +<span class="sourceLineNo">284</span> * <li><js>"[method] [url]"</js> - e.g. <js>"GET http://localhost/callback"</js><a name="line.284"></a> +<span class="sourceLineNo">285</span> * <li><js>"[method] [url] [payload]"</js> - e.g. <js>"POST http://localhost/callback some text payload"</js><a name="line.285"></a> +<span class="sourceLineNo">286</span> * <li><js>"[method] [headers] [url] [payload]"</js> - e.g. <js>"POST {'Content-Type':'text/json'} http://localhost/callback {'some':'json'}"</js><a name="line.286"></a> +<span class="sourceLineNo">287</span> * </ul><a name="line.287"></a> +<span class="sourceLineNo">288</span> * <p><a name="line.288"></a> +<span class="sourceLineNo">289</span> * The payload will always be sent using a simple {@link StringEntity}.<a name="line.289"></a> +<span class="sourceLineNo">290</span> *<a name="line.290"></a> +<span class="sourceLineNo">291</span> * @param callString The call string.<a name="line.291"></a> +<span class="sourceLineNo">292</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.292"></a> +<span class="sourceLineNo">293</span> * and getting the response as a parsed object.<a name="line.293"></a> +<span class="sourceLineNo">294</span> * @throws RestCallException<a name="line.294"></a> +<span class="sourceLineNo">295</span> */<a name="line.295"></a> +<span class="sourceLineNo">296</span> public RestCall doCallback(String callString) throws RestCallException {<a name="line.296"></a> +<span class="sourceLineNo">297</span> String s = callString;<a name="line.297"></a> +<span class="sourceLineNo">298</span> try {<a name="line.298"></a> +<span class="sourceLineNo">299</span> RestCall rc = null;<a name="line.299"></a> +<span class="sourceLineNo">300</span> String method = null, uri = null, content = null;<a name="line.300"></a> +<span class="sourceLineNo">301</span> ObjectMap h = null;<a name="line.301"></a> +<span class="sourceLineNo">302</span> int i = s.indexOf(' ');<a name="line.302"></a> +<span class="sourceLineNo">303</span> if (i != -1) {<a name="line.303"></a> +<span class="sourceLineNo">304</span> method = s.substring(0, i).trim();<a name="line.304"></a> +<span class="sourceLineNo">305</span> s = s.substring(i).trim();<a name="line.305"></a> +<span class="sourceLineNo">306</span> if (s.length() > 0) {<a name="line.306"></a> +<span class="sourceLineNo">307</span> if (s.charAt(0) == '{') {<a name="line.307"></a> +<span class="sourceLineNo">308</span> i = s.indexOf('}');<a name="line.308"></a> +<span class="sourceLineNo">309</span> if (i != -1) {<a name="line.309"></a> +<span class="sourceLineNo">310</span> String json = s.substring(0, i+1);<a name="line.310"></a> +<span class="sourceLineNo">311</span> h = JsonParser.DEFAULT.parse(json, ObjectMap.class);<a name="line.311"></a> +<span class="sourceLineNo">312</span> s = s.substring(i+1).trim();<a name="line.312"></a> +<span class="sourceLineNo">313</span> }<a name="line.313"></a> +<span class="sourceLineNo">314</span> }<a name="line.314"></a> +<span class="sourceLineNo">315</span> if (s.length() > 0) {<a name="line.315"></a> +<span class="sourceLineNo">316</span> i = s.indexOf(' ');<a name="line.316"></a> +<span class="sourceLineNo">317</span> if (i == -1)<a name="line.317"></a> +<span class="sourceLineNo">318</span> uri = s;<a name="line.318"></a> +<span class="sourceLineNo">319</span> else {<a name="line.319"></a> +<span class="sourceLineNo">320</span> uri = s.substring(0, i).trim();<a name="line.320"></a> +<span class="sourceLineNo">321</span> s = s.substring(i).trim();<a name="line.321"></a> +<span class="sourceLineNo">322</span> if (s.length() > 0)<a name="line.322"></a> +<span class="sourceLineNo">323</span> content = s;<a name="line.323"></a> +<span class="sourceLineNo">324</span> }<a name="line.324"></a> +<span class="sourceLineNo">325</span> }<a name="line.325"></a> +<span class="sourceLineNo">326</span> }<a name="line.326"></a> +<span class="sourceLineNo">327</span> }<a name="line.327"></a> +<span class="sourceLineNo">328</span> if (method != null && uri != null) {<a name="line.328"></a> +<span class="sourceLineNo">329</span> rc = doCall(method, uri, content != null);<a name="line.329"></a> +<span class="sourceLineNo">330</span> if (content != null)<a name="line.330"></a> +<span class="sourceLineNo">331</span> rc.input(new StringEntity(content));<a name="line.331"></a> +<span class="sourceLineNo">332</span> if (h != null)<a name="line.332"></a> +<span class="sourceLineNo">333</span> for (Map.Entry<String,Object> e : h.entrySet())<a name="line.333"></a> +<span class="sourceLineNo">334</span> rc.header(e.getKey(), e.getValue());<a name="line.334"></a> +<span class="sourceLineNo">335</span> return rc;<a name="line.335"></a> +<span class="sourceLineNo">336</span> }<a name="line.336"></a> +<span class="sourceLineNo">337</span> } catch (Exception e) {<a name="line.337"></a> +<span class="sourceLineNo">338</span> throw new RestCallException(e);<a name="line.338"></a> +<span class="sourceLineNo">339</span> }<a name="line.339"></a> +<span class="sourceLineNo">340</span> throw new RestCallException("Invalid format for call string.");<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> /**<a name="line.343"></a> +<span class="sourceLineNo">344</span> * Perform a generic REST call.<a name="line.344"></a> +<span class="sourceLineNo">345</span> *<a name="line.345"></a> +<span class="sourceLineNo">346</span> * @param method The HTTP method.<a name="line.346"></a> +<span class="sourceLineNo">347</span> * @param url The URL of the remote REST resource. Can be any of the following: {@link String}, {@link URI}, {@link URL}.<a name="line.347"></a> +<span class="sourceLineNo">348</span> * @param content The HTTP body content.<a name="line.348"></a> +<span class="sourceLineNo">349</span> * Can be of the following types:<a name="line.349"></a> +<span class="sourceLineNo">350</span> * <ul class='spaced-list'><a name="line.350"></a> +<span class="sourceLineNo">351</span> * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource.<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource.<a name="line.352"></a> +<span class="sourceLineNo">353</span> * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}.<a name="line.353"></a> +<span class="sourceLineNo">354</span> * <li>{@link HttpEntity} - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * <li>{@link NameValuePairs} - Converted to a URL-encoded FORM post.<a name="line.355"></a> <span class="sourceLineNo">356</span> * </ul><a name="line.356"></a> <span class="sourceLineNo">357</span> * This parameter is IGNORED if {@link HttpMethod#hasContent()} is <jk>false</jk>.<a name="line.357"></a> <span class="sourceLineNo">358</span> * @return A {@link RestCall} object that can be further tailored before executing the request<a name="line.358"></a> @@ -429,120 +429,210 @@ <span class="sourceLineNo">421</span> }<a name="line.421"></a> <span class="sourceLineNo">422</span><a name="line.422"></a> <span class="sourceLineNo">423</span> /**<a name="line.423"></a> -<span class="sourceLineNo">424</span> * Create a new proxy interface for the specified remoteable service interface.<a name="line.424"></a> -<span class="sourceLineNo">425</span> *<a name="line.425"></a> -<span class="sourceLineNo">426</span> * @param interfaceClass The interface to create a proxy for.<a name="line.426"></a> -<span class="sourceLineNo">427</span> * @return The new proxy interface.<a name="line.427"></a> -<span class="sourceLineNo">428</span> * @throws RuntimeException If the Remotable service URI has not been specified on this<a name="line.428"></a> -<span class="sourceLineNo">429</span> * client by calling {@link RestClientBuilder#remoteableServletUri(String)}.<a name="line.429"></a> -<span class="sourceLineNo">430</span> */<a name="line.430"></a> -<span class="sourceLineNo">431</span> public <T> T getRemoteableProxy(final Class<T> interfaceClass) {<a name="line.431"></a> -<span class="sourceLineNo">432</span> if (remoteableServletUri == null)<a name="line.432"></a> -<span class="sourceLineNo">433</span> throw new RuntimeException("Remoteable service URI has not been specified.");<a name="line.433"></a> -<span class="sourceLineNo">434</span> return getRemoteableProxy(interfaceClass, remoteableServletUri + '/' + interfaceClass.getName());<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> * Create a new proxy interface for the specified REST PROXY interface.<a name="line.438"></a> -<span class="sourceLineNo">439</span> *<a name="line.439"></a> -<span class="sourceLineNo">440</span> * @param interfaceClass The interface to create a proxy for.<a name="line.440"></a> -<span class="sourceLineNo">441</span> * @param proxyUrl The URL of the REST method annotated with <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code>.<a name="line.441"></a> -<span class="sourceLineNo">442</span> * @return The new proxy interface.<a name="line.442"></a> -<span class="sourceLineNo">443</span> */<a name="line.443"></a> -<span class="sourceLineNo">444</span> public <T> T getRemoteableProxy(final Class<T> interfaceClass, final Object proxyUrl) {<a name="line.444"></a> -<span class="sourceLineNo">445</span> return getRemoteableProxy(interfaceClass, proxyUrl, serializer, parser);<a name="line.445"></a> -<span class="sourceLineNo">446</span> }<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> * Same as {@link #getRemoteableProxy(Class, Object)} but allows you to override the serializer and parser used.<a name="line.449"></a> -<span class="sourceLineNo">450</span> *<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param interfaceClass The interface to create a proxy for.<a name="line.451"></a> -<span class="sourceLineNo">452</span> * @param proxyUrl The URL of the REST method annotated with <code><ja>@RestMethod</ja>(name=<js>"PROXY"</js>)</code>.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * @param serializer The serializer used to serialize POJOs to the body of the HTTP request.<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param parser The parser used to parse POJOs from the body of the HTTP response.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * @return The new proxy interface.<a name="line.455"></a> -<span class="sourceLineNo">456</span> */<a name="line.456"></a> -<span class="sourceLineNo">457</span> @SuppressWarnings({ "unchecked", "hiding" })<a name="line.457"></a> -<span class="sourceLineNo">458</span> public <T> T getRemoteableProxy(final Class<T> interfaceClass, final Object proxyUrl, final Serializer serializer, final Parser parser) {<a name="line.458"></a> -<span class="sourceLineNo">459</span> try {<a name="line.459"></a> -<span class="sourceLineNo">460</span> return (T)Proxy.newProxyInstance(<a name="line.460"></a> -<span class="sourceLineNo">461</span> interfaceClass.getClassLoader(),<a name="line.461"></a> -<span class="sourceLineNo">462</span> new Class[] { interfaceClass },<a name="line.462"></a> -<span class="sourceLineNo">463</span> new InvocationHandler() {<a name="line.463"></a> -<span class="sourceLineNo">464</span><a name="line.464"></a> -<span class="sourceLineNo">465</span> final Map<Method,String> uriCache = new ConcurrentHashMap<Method,String>();<a name="line.465"></a> -<span class="sourceLineNo">466</span> final String uri = toURI(proxyUrl).toString();<a name="line.466"></a> -<span class="sourceLineNo">467</span><a name="line.467"></a> -<span class="sourceLineNo">468</span> @Override /* InvocationHandler */<a name="line.468"></a> -<span class="sourceLineNo">469</span> public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {<a name="line.469"></a> -<span class="sourceLineNo">470</span><a name="line.470"></a> -<span class="sourceLineNo">471</span> // Constructing this string each time can be time consuming, so cache it.<a name="line.471"></a> -<span class="sourceLineNo">472</span> String u = uriCache.get(method);<a name="line.472"></a> -<span class="sourceLineNo">473</span> if (u == null) {<a name="line.473"></a> -<span class="sourceLineNo">474</span> try {<a name="line.474"></a> -<span class="sourceLineNo">475</span> u = uri + '/' + URLEncoder.encode(ClassUtils.getMethodSignature(method), "utf-8");<a name="line.475"></a> -<span class="sourceLineNo">476</span> } catch (UnsupportedEncodingException e) {}<a name="line.476"></a> -<span class="sourceLineNo">477</span> uriCache.put(method, u);<a name="line.477"></a> -<span class="sourceLineNo">478</span> }<a name="line.478"></a> +<span class="sourceLineNo">424</span> * Create a new proxy interface against a REST interface.<a name="line.424"></a> +<span class="sourceLineNo">425</span> * <p><a name="line.425"></a> +<span class="sourceLineNo">426</span> * The URL to the REST interface is based on the following values:<a name="line.426"></a> +<span class="sourceLineNo">427</span> * <ul><a name="line.427"></a> +<span class="sourceLineNo">428</span> * <li>The {@link Remoteable#path() @Remoteable.path()} annotation on the interface (<code>remoteable-path</code>).<a name="line.428"></a> +<span class="sourceLineNo">429</span> * <li>The {@link RestClientBuilder#rootUrl(Object) rootUrl} on the client (<code>root-url</code>).<a name="line.429"></a> +<span class="sourceLineNo">430</span> * <li>The fully-qualified class name of the interface (<code>class-name</code>).<a name="line.430"></a> +<span class="sourceLineNo">431</span> * </ul><a name="line.431"></a> +<span class="sourceLineNo">432</span> * <p><a name="line.432"></a> +<span class="sourceLineNo">433</span> * The URL calculation is as follows:<a name="line.433"></a> +<span class="sourceLineNo">434</span> * <ul><a name="line.434"></a> +<span class="sourceLineNo">435</span> * <li><code>remoteable-path</code> - If remoteable path is absolute.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * <li><code>root-url/remoteable-path</code> - If remoteable path is relative and root-url has been specified.<a name="line.436"></a> +<span class="sourceLineNo">437</span> * <li><code>root-url/class-name</code> - If remoteable path is not specified.<a name="line.437"></a> +<span class="sourceLineNo">438</span> * </ul><a name="line.438"></a> +<span class="sourceLineNo">439</span> * <p><a name="line.439"></a> +<span class="sourceLineNo">440</span> * If the information is not available to resolve to an absolute URL, a {@link RemoteableMetadataException} is thrown.<a name="line.440"></a> +<span class="sourceLineNo">441</span> * <p><a name="line.441"></a> +<span class="sourceLineNo">442</span> * Examples:<a name="line.442"></a> +<span class="sourceLineNo">443</span> * <p class='bcode'><a name="line.443"></a> +<span class="sourceLineNo">444</span> * <jk>package</jk> org.apache.foo;<a name="line.444"></a> +<span class="sourceLineNo">445</span> *<a name="line.445"></a> +<span class="sourceLineNo">446</span> * <ja>@Remoteable</ja>(path=<js>"http://hostname/resturl/myinterface1"</js>)<a name="line.446"></a> +<span class="sourceLineNo">447</span> * <jk>public interface</jk> MyInterface1 { ... }<a name="line.447"></a> +<span class="sourceLineNo">448</span> *<a name="line.448"></a> +<span class="sourceLineNo">449</span> * <ja>@Remoteable</ja>(path=<js>"/myinterface2"</js>)<a name="line.449"></a> +<span class="sourceLineNo">450</span> * <jk>public interface</jk> MyInterface2 { ... }<a name="line.450"></a> +<span class="sourceLineNo">451</span> *<a name="line.451"></a> +<span class="sourceLineNo">452</span> * <jk>public interface</jk> MyInterface3 { ... }<a name="line.452"></a> +<span class="sourceLineNo">453</span> *<a name="line.453"></a> +<span class="sourceLineNo">454</span> * <jc>// Resolves to "http://localhost/resturl/myinterface1"</jc><a name="line.454"></a> +<span class="sourceLineNo">455</span> * MyInterface1 i1 = <jk>new</jk> RestClientBuilder()<a name="line.455"></a> +<span class="sourceLineNo">456</span> * .build()<a name="line.456"></a> +<span class="sourceLineNo">457</span> * .getRemoteableProxy(MyInterface1.<jk>class</jk>);<a name="line.457"></a> +<span class="sourceLineNo">458</span> *<a name="line.458"></a> +<span class="sourceLineNo">459</span> * <jc>// Resolves to "http://hostname/resturl/myinterface2"</jc><a name="line.459"></a> +<span class="sourceLineNo">460</span> * MyInterface2 i2 = <jk>new</jk> RestClientBuilder()<a name="line.460"></a> +<span class="sourceLineNo">461</span> * .rootUrl(<js>"http://hostname/resturl"</js>)<a name="line.461"></a> +<span class="sourceLineNo">462</span> * .build()<a name="line.462"></a> +<span class="sourceLineNo">463</span> * .getRemoteableProxy(MyInterface2.<jk>class</jk>);<a name="line.463"></a> +<span class="sourceLineNo">464</span> *<a name="line.464"></a> +<span class="sourceLineNo">465</span> * <jc>// Resolves to "http://hostname/resturl/org.apache.foo.MyInterface3"</jc><a name="line.465"></a> +<span class="sourceLineNo">466</span> * MyInterface3 i3 = <jk>new</jk> RestClientBuilder()<a name="line.466"></a> +<span class="sourceLineNo">467</span> * .rootUrl(<js>"http://hostname/resturl"</js>)<a name="line.467"></a> +<span class="sourceLineNo">468</span> * .build()<a name="line.468"></a> +<span class="sourceLineNo">469</span> * .getRemoteableProxy(MyInterface3.<jk>class</jk>);<a name="line.469"></a> +<span class="sourceLineNo">470</span> * </p><a name="line.470"></a> +<span class="sourceLineNo">471</span> *<a name="line.471"></a> +<span class="sourceLineNo">472</span> * @param interfaceClass The interface to create a proxy for.<a name="line.472"></a> +<span class="sourceLineNo">473</span> * @return The new proxy interface.<a name="line.473"></a> +<span class="sourceLineNo">474</span> * @throws RemoteableMetadataException If the REST URI cannot be determined based on the information given.<a name="line.474"></a> +<span class="sourceLineNo">475</span> */<a name="line.475"></a> +<span class="sourceLineNo">476</span> public <T> T getRemoteableProxy(final Class<T> interfaceClass) {<a name="line.476"></a> +<span class="sourceLineNo">477</span> return getRemoteableProxy(interfaceClass, null);<a name="line.477"></a> +<span class="sourceLineNo">478</span> }<a name="line.478"></a> <span class="sourceLineNo">479</span><a name="line.479"></a> -<span class="sourceLineNo">480</span> try {<a name="line.480"></a> -<span class="sourceLineNo">481</span> return doPost(u, args).serializer(serializer).parser(parser).getResponse(method.getGenericReturnType());<a name="line.481"></a> -<span class="sourceLineNo">482</span> } catch (RestCallException e) {<a name="line.482"></a> -<span class="sourceLineNo">483</span> // Try to throw original exception if possible.<a name="line.483"></a> -<span class="sourceLineNo">484</span> e.throwServerException(interfaceClass.getClassLoader());<a name="line.484"></a> -<span class="sourceLineNo">485</span> throw new RuntimeException(e);<a name="line.485"></a> -<span class="sourceLineNo">486</span> } catch (Exception e) {<a name="line.486"></a> -<span class="sourceLineNo">487</span> throw new RuntimeException(e);<a name="line.487"></a> -<span class="sourceLineNo">488</span> }<a name="line.488"></a> -<span class="sourceLineNo">489</span> }<a name="line.489"></a> -<span class="sourceLineNo">490</span> });<a name="line.490"></a> -<span class="sourceLineNo">491</span> } catch (Exception e) {<a name="line.491"></a> -<span class="sourceLineNo">492</span> throw new RuntimeException(e);<a name="line.492"></a> -<span class="sourceLineNo">493</span> }<a name="line.493"></a> -<span class="sourceLineNo">494</span> }<a name="line.494"></a> -<span class="sourceLineNo">495</span><a name="line.495"></a> -<span class="sourceLineNo">496</span> private Pattern absUrlPattern = Pattern.compile("^\\w+\\:\\/\\/.*");<a name="line.496"></a> -<span class="sourceLineNo">497</span><a name="line.497"></a> -<span class="sourceLineNo">498</span> UrlEncodingSerializer getUrlEncodingSerializer() {<a name="line.498"></a> -<span class="sourceLineNo">499</span> return urlEncodingSerializer;<a name="line.499"></a> -<span class="sourceLineNo">500</span> }<a name="line.500"></a> -<span class="sourceLineNo">501</span><a name="line.501"></a> -<span class="sourceLineNo">502</span> URI toURI(Object url) throws URISyntaxException {<a name="line.502"></a> -<span class="sourceLineNo">503</span> if (url instanceof URI)<a name="line.503"></a> -<span class="sourceLineNo">504</span> return (URI)url;<a name="line.504"></a> -<span class="sourceLineNo">505</span> if (url instanceof URL)<a name="line.505"></a> -<span class="sourceLineNo">506</span> ((URL)url).toURI();<a name="line.506"></a> -<span class="sourceLineNo">507</span> if (url instanceof URIBuilder)<a name="line.507"></a> -<span class="sourceLineNo">508</span> return ((URIBuilder)url).build();<a name="line.508"></a> -<span class="sourceLineNo">509</span> String s = url == null ? "" : url.toString();<a name="line.509"></a> -<span class="sourceLineNo">510</span> if (rootUrl != null && ! absUrlPattern.matcher(s).matches()) {<a name="line.510"></a> -<span class="sourceLineNo">511</span> if (s.isEmpty())<a name="line.511"></a> -<span class="sourceLineNo">512</span> s = rootUrl;<a name="line.512"></a> -<span class="sourceLineNo">513</span> else {<a name="line.513"></a> -<span class="sourceLineNo">514</span> StringBuilder sb = new StringBuilder(rootUrl);<a name="line.514"></a> -<span class="sourceLineNo">515</span> if (! s.startsWith("/"))<a name="line.515"></a> -<span class="sourceLineNo">516</span> sb.append('/');<a name="line.516"></a> -<span class="sourceLineNo">517</span> sb.append(s);<a name="line.517"></a> -<span class="sourceLineNo">518</span> s = sb.toString();<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> return new URI(s);<a name="line.521"></a> -<span class="sourceLineNo">522</span> }<a name="line.522"></a> -<span class="sourceLineNo">523</span><a name="line.523"></a> -<span class="sourceLineNo">524</span> @Override<a name="line.524"></a> -<span class="sourceLineNo">525</span> protected void finalize() throws Throwable {<a name="line.525"></a> -<span class="sourceLineNo">526</span> if (! isClosed && ! keepHttpClientOpen) {<a name="line.526"></a> -<span class="sourceLineNo">527</span> System.err.println("WARNING: RestClient garbage collected before it was finalized.");<a name="line.527"></a> -<span class="sourceLineNo">528</span> i
<TRUNCATED>
