You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2016/08/08 18:30:41 UTC
[14/51] [partial] incubator-juneau-website git commit: Add missing
javadocs
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/112b098d/content/api-documentation/org/apache/juneau/client/RestCall.html
----------------------------------------------------------------------
diff --git a/content/api-documentation/org/apache/juneau/client/RestCall.html b/content/api-documentation/org/apache/juneau/client/RestCall.html
new file mode 100644
index 0000000..58d1e4a
--- /dev/null
+++ b/content/api-documentation/org/apache/juneau/client/RestCall.html
@@ -0,0 +1,1454 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>RestCall (Juneau)</title>
+<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style">
+<script type="text/javascript" src="../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="RestCall (Juneau)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":42,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/RestCall.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/juneau/client/ResponsePattern.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/juneau/client/RestCall.html" target="_top">Frames</a></li>
+<li><a href="RestCall.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.juneau.client</div>
+<h2 title="Class RestCall" class="title">Class RestCall</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.juneau.client.RestCall</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public final class <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.57">RestCall</a>
+extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
+<div class="block">Represents a connection to a remote REST resource.
+ <p>
+ Instances of this class are created by the various <code>doX()</code> methods on the <a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><code>RestClient</code></a> class.
+ <p>
+ This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so...
+
+ <p class='bcode'>
+ RestClient client = <jk>new</jk> RestClient();
+ RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y);
+ MyBean b = c.getResponse(MyBean.<jk>class</jk>);
+ </p>
+ <p>
+ The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods.
+
+ <h6 class='topic'>Additional Information</h6>
+ <ul>
+ <li><a class='doclink' href='package-summary.html#RestClient'>org.apache.juneau.client > REST client API</a> for more information and code examples.
+ </ul></div>
+<dl>
+<dt><span class="simpleTagLabel">Author:</span></dt>
+<dd>James Bognar (james.bognar@salesforce.com)</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier</th>
+<th class="colLast" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected </code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#RestCall-org.apache.juneau.client.RestClient-org.apache.http.client.methods.HttpRequestBase-">RestCall</a></span>(<a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client">RestClient</a> client,
+ org.apache.http.client.methods.HttpRequestBase request)</code>
+<div class="block">Constructs a REST call with the specified method name.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#addInterceptor-org.apache.juneau.client.RestCallInterceptor-">addInterceptor</a></span>(<a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a> interceptor)</code>
+<div class="block">Add an interceptor for this call only.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#addResponsePattern-org.apache.juneau.client.ResponsePattern-">addResponsePattern</a></span>(<a href="../../../../org/apache/juneau/client/ResponsePattern.html" title="class in org.apache.juneau.client">ResponsePattern</a> responsePattern)</code>
+<div class="block">Adds a response pattern finder to look for regular expression matches in the response output.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#allowRedirectsOnPosts-boolean-">allowRedirectsOnPosts</a></span>(boolean b)</code>
+<div class="block">For this call, allow automatic redirects when a 302 or 307 occurs when
+ performing a POST.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#byLines--">byLines</a></span>()</code>
+<div class="block">When output is piped to writers, flush the writers after every line of output.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#captureResponse--">captureResponse</a></span>()</code>
+<div class="block">Stores the response text so that it can later be captured using <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>getCapturedResponse()</code></a>.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#close--">close</a></span>()</code>
+<div class="block">Cleans up this HTTP call.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#connect--">connect</a></span>()</code>
+<div class="block">Connects to the REST resource.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#consumeResponse--">consumeResponse</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#execute--">execute</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a>.</span></div>
+</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#failurePattern-java.lang.String-">failurePattern</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> errorPattern)</code>
+<div class="block">Look for the specified regular expression pattern in the response output.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--">getCapturedResponse</a></span>()</code>
+<div class="block">Returns the response text as a string if <a href="../../../../org/apache/juneau/client/RestCall.html#captureResponse--"><code>captureResponse()</code></a> was called on this object.</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getContentLength--">getContentLength</a></span>()</code>
+<div class="block">Returns the value of the <code>Content-Length</code> header.</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getInputStream--">getInputStream</a></span>()</code>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as an input stream.</div>
+</td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getOutputStream-java.lang.String-">getOutputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code>
+<div class="block">Retrieves an output stream associated with an ID via <a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.OutputStream-boolean-"><code>pipeTo(String, OutputStream, boolean)</code></a></div>
+</td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getParser--">getParser</a></span>()</code>
+<div class="block">Returns the parser specified on the client to use for parsing HTTP response bodies.</div>
+</td>
+</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getReader--">getReader</a></span>()</code>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as a reader.</div>
+</td>
+</tr>
+<tr id="i16" class="altColor">
+<td class="colFirst"><code>org.apache.http.client.methods.HttpUriRequest</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getRequest--">getRequest</a></span>()</code>
+<div class="block">Returns access to the <code>HttpUriRequest</code> passed to <code>HttpClient.execute(HttpUriRequest)</code>.</div>
+</td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>org.apache.http.HttpResponse</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponse--">getResponse</a></span>()</code>
+<div class="block">Returns access to the <code>HttpResponse</code> returned by <code>HttpClient.execute(HttpUriRequest)</code>.</div>
+</td>
+</tr>
+<tr id="i18" class="altColor">
+<td class="colFirst"><code><T> T</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponse-java.lang.Class-">getResponse</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)</code>
+<div class="block">Converts the output from the connection into an object of the specified class using the registered <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a>.</div>
+</td>
+</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--">getResponseAsString</a></span>()</code>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as plain text.</div>
+</td>
+</tr>
+<tr id="i20" class="altColor">
+<td class="colFirst"><code><E,T extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><E>><br>T</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponseCollection-java.lang.Class-java.lang.Class-">getResponseCollection</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> collectionClass,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> entryClass)</code>
+<div class="block">Convenience method when you want to parse into a Collection<E> object.</div>
+</td>
+</tr>
+<tr id="i21" class="rowColor">
+<td class="colFirst"><code><K,V,T extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><K,V>><br>T</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponseMap-java.lang.Class-java.lang.Class-java.lang.Class-">getResponseMap</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapClass,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><K> keyClass,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><V> valueClass)</code>
+<div class="block">Convenience method when you want to parse into a Map<K,V> object.</div>
+</td>
+</tr>
+<tr id="i22" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils">PojoRest</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponsePojoRest--">getResponsePojoRest</a></span>()</code>
+<div class="block">Converts the output from the connection into an <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a> and then wraps that in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.</div>
+</td>
+</tr>
+<tr id="i23" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils">PojoRest</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getResponsePojoRest-java.lang.Class-">getResponsePojoRest</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> innerType)</code>
+<div class="block">Parses the output from the connection into the specified type and then wraps that in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.</div>
+</td>
+</tr>
+<tr id="i24" class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getSerializer--">getSerializer</a></span>()</code>
+<div class="block">Returns the serializer specified on the client to use for serializing HTTP request bodies.</div>
+</td>
+</tr>
+<tr id="i25" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-">getWriter</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code>
+<div class="block">Retrieves a writer associated with an ID via <a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.Writer-boolean-"><code>pipeTo(String, Writer, boolean)</code></a></div>
+</td>
+</tr>
+<tr id="i26" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#ignoreErrors--">ignoreErrors</a></span>()</code>
+<div class="block">Prevent <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallExceptions</code></a> from being thrown when HTTP status 400+ is encountered.</div>
+</td>
+</tr>
+<tr id="i27" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#logTo-java.util.logging.Level-java.util.logging.Logger-">logTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html?is-external=true" title="class or interface in java.util.logging">Level</a> level,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> log)</code>
+<div class="block">Adds a <a href="../../../../org/apache/juneau/client/RestCallLogger.html" title="class in org.apache.juneau.client"><code>RestCallLogger</code></a> to the list of interceptors on this class.</div>
+</td>
+</tr>
+<tr id="i28" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.io.OutputStream-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os)</code>
+<div class="block">Pipes the request output to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.</div>
+</td>
+</tr>
+<tr id="i29" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.io.OutputStream-boolean-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os,
+ boolean close)</code>
+<div class="block">Pipe output from response to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.</div>
+</td>
+</tr>
+<tr id="i30" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.OutputStream-boolean-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os,
+ boolean close)</code>
+<div class="block">Pipe output from response to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called and associate
+ that output stream with an ID so it can be retrieved through <a href="../../../../org/apache/juneau/client/RestCall.html#getOutputStream-java.lang.String-"><code>getOutputStream(String)</code></a>.</div>
+</td>
+</tr>
+<tr id="i31" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.Writer-boolean-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w,
+ boolean close)</code>
+<div class="block">Pipe output from response to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called and associate
+ that writer with an ID so it can be retrieved through <a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-"><code>getWriter(String)</code></a>.</div>
+</td>
+</tr>
+<tr id="i32" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.io.Writer-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w)</code>
+<div class="block">Pipes the request output to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.</div>
+</td>
+</tr>
+<tr id="i33" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.io.Writer-boolean-">pipeTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w,
+ boolean close)</code>
+<div class="block">Pipe output from response to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.</div>
+</td>
+</tr>
+<tr id="i34" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#run--">run</a></span>()</code>
+<div class="block">Method used to execute an HTTP response where you're only interested in the HTTP response code.</div>
+</td>
+</tr>
+<tr id="i35" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setConfig-org.apache.http.client.config.RequestConfig-">setConfig</a></span>(org.apache.http.client.config.RequestConfig config)</code>
+<div class="block">Set configuration settings on this request.</div>
+</td>
+</tr>
+<tr id="i36" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setHeader-org.apache.http.Header-">setHeader</a></span>(org.apache.http.Header header)</code>
+<div class="block">Shortcut for calling <code>getRequest().setHeader(header)</code></div>
+</td>
+</tr>
+<tr id="i37" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setHeader-java.lang.String-java.lang.Object-">setHeader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
+<div class="block">Convenience method for setting a header value on the request.</div>
+</td>
+</tr>
+<tr id="i38" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setInput-java.lang.Object-">setInput</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> input)</code>
+<div class="block">Sets the input for this REST call.</div>
+</td>
+</tr>
+<tr id="i39" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setRedirectMaxAttempts-int-">setRedirectMaxAttempts</a></span>(int maxAttempts)</code>
+<div class="block">Specify the number of redirects to follow before throwing an exception.</div>
+</td>
+</tr>
+<tr id="i40" class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#setRetryable-int-long-org.apache.juneau.client.RetryOn-">setRetryable</a></span>(int retries,
+ long interval,
+ <a href="../../../../org/apache/juneau/client/RetryOn.html" title="interface in org.apache.juneau.client">RetryOn</a> retryOn)</code>
+<div class="block">Make this call retryable if an error response (>=400) is received.</div>
+</td>
+</tr>
+<tr id="i41" class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/client/RestCall.html#successPattern-java.lang.String-">successPattern</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> successPattern)</code>
+<div class="block">Look for the specified regular expression pattern in the response output.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="RestCall-org.apache.juneau.client.RestClient-org.apache.http.client.methods.HttpRequestBase-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>RestCall</h4>
+<pre>protected <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.86">RestCall</a>(<a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client">RestClient</a> client,
+ org.apache.http.client.methods.HttpRequestBase request)
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Constructs a REST call with the specified method name.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>client</code> - The client that created this request.</dd>
+<dd><code>request</code> - The wrapped Apache HTTP client request object.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If an exception or non-200 response code occurred during the connection attempt.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="setInput-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setInput</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.107">setInput</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> input)
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Sets the input for this REST call.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>input</code> - The input to be sent to the REST resource (only valid for PUT and POST) requests. <br>
+ Can be of the following types:
+ <ul class='spaced-list'>
+ <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> - Raw contents of <code>Reader</code> will be serialized to remote resource.
+ <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> - Raw contents of <code>InputStream</code> will be serialized to remote resource.
+ <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> - POJO to be converted to text using the <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> registered with the <a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><code>RestClient</code></a>.
+ <li><code>HttpEntity</code> - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
+ </ul></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If a retry was attempted, but the entity was not repeatable.</dd>
+</dl>
+</li>
+</ul>
+<a name="setHeader-java.lang.String-java.lang.Object-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setHeader</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.126">setHeader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre>
+<div class="block">Convenience method for setting a header value on the request.
+ <p>
+ Equivalent to calling <code>restCall.getRequest().setHeader(name, value.toString())</code>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>name</code> - The header name.</dd>
+<dd><code>value</code> - The header value.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="setRetryable-int-long-org.apache.juneau.client.RetryOn-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setRetryable</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.141">setRetryable</a>(int retries,
+ long interval,
+ <a href="../../../../org/apache/juneau/client/RetryOn.html" title="interface in org.apache.juneau.client">RetryOn</a> retryOn)
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Make this call retryable if an error response (>=400) is received.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>retries</code> - The number of retries to attempt.</dd>
+<dd><code>interval</code> - The time in milliseconds between attempts.</dd>
+<dd><code>retryOn</code> - Optional object used for determining whether a retry should be attempted.
+ If <jk>null</jk>, uses <a href="../../../../org/apache/juneau/client/RetryOn.html#DEFAULT"><code>RetryOn.DEFAULT</code></a>.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If current entity is not repeatable.</dd>
+</dl>
+</li>
+</ul>
+<a name="allowRedirectsOnPosts-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>allowRedirectsOnPosts</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.167">allowRedirectsOnPosts</a>(boolean b)</pre>
+<div class="block">For this call, allow automatic redirects when a 302 or 307 occurs when
+ performing a POST.
+ <p>
+ Note that this can be inefficient since the POST body needs to be serialized
+ twice.
+ The preferred approach if possible is to use the <code>LaxRedirectStrategy</code> strategy
+ on the underlying HTTP client. However, this method is provided if you don't
+ have access to the underlying client.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>b</code> - Redirect flag.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="setRedirectMaxAttempts-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setRedirectMaxAttempts</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.178">setRedirectMaxAttempts</a>(int maxAttempts)</pre>
+<div class="block">Specify the number of redirects to follow before throwing an exception.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>maxAttempts</code> - Allow a redirect to occur this number of times.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="addInterceptor-org.apache.juneau.client.RestCallInterceptor-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addInterceptor</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.189">addInterceptor</a>(<a href="../../../../org/apache/juneau/client/RestCallInterceptor.html" title="class in org.apache.juneau.client">RestCallInterceptor</a> interceptor)</pre>
+<div class="block">Add an interceptor for this call only.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>interceptor</code> - The interceptor to add to this call.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.io.Writer-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.205">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w)</pre>
+<div class="block">Pipes the request output to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.
+ <p>
+ The writer is not closed.
+ <p>
+ This method can be called multiple times to pipe to multiple writers.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>w</code> - The writer to pipe the output to.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.io.Writer-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.218">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w,
+ boolean close)</pre>
+<div class="block">Pipe output from response to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.
+ <p>
+ This method can be called multiple times to pipe to multiple writers.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>w</code> - The writer to write the output to.</dd>
+<dd><code>close</code> - Close the writer when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>close()</code></a> is called.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.lang.String-java.io.Writer-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.233">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> w,
+ boolean close)</pre>
+<div class="block">Pipe output from response to the specified writer when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called and associate
+ that writer with an ID so it can be retrieved through <a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-"><code>getWriter(String)</code></a>.
+ <p>
+ This method can be called multiple times to pipe to multiple writers.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - A string identifier that can be used to retrieve the writer using <a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-"><code>getWriter(String)</code></a></dd>
+<dd><code>w</code> - The writer to write the output to.</dd>
+<dd><code>close</code> - Close the writer when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>close()</code></a> is called.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="getWriter-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getWriter</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.244">getWriter</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre>
+<div class="block">Retrieves a writer associated with an ID via <a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.Writer-boolean-"><code>pipeTo(String, Writer, boolean)</code></a></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - A string identifier that can be used to retrieve the writer using <a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-"><code>getWriter(String)</code></a></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The writer, or <jk>null</jk> if no writer is associated with that ID.</dd>
+</dl>
+</li>
+</ul>
+<a name="byLines--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>byLines</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.253">byLines</a>()</pre>
+<div class="block">When output is piped to writers, flush the writers after every line of output.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.io.OutputStream-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.268">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os)</pre>
+<div class="block">Pipes the request output to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.
+ <p>
+ The output stream is not closed.
+ <p>
+ This method can be called multiple times to pipe to multiple output streams.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>os</code> - The output stream to pipe the output to.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.io.OutputStream-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.281">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os,
+ boolean close)</pre>
+<div class="block">Pipe output from response to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called.
+ <p>
+ This method can be called multiple times to pipe to multiple output stream.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>os</code> - The output stream to write the output to.</dd>
+<dd><code>close</code> - Close the output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>close()</code></a> is called.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="pipeTo-java.lang.String-java.io.OutputStream-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>pipeTo</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.296">pipeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> os,
+ boolean close)</pre>
+<div class="block">Pipe output from response to the specified output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a> is called and associate
+ that output stream with an ID so it can be retrieved through <a href="../../../../org/apache/juneau/client/RestCall.html#getOutputStream-java.lang.String-"><code>getOutputStream(String)</code></a>.
+ <p>
+ This method can be called multiple times to pipe to multiple output stream.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - A string identifier that can be used to retrieve the output stream using <a href="../../../../org/apache/juneau/client/RestCall.html#getOutputStream-java.lang.String-"><code>getOutputStream(String)</code></a></dd>
+<dd><code>os</code> - The output stream to write the output to.</dd>
+<dd><code>close</code> - Close the output stream when <a href="../../../../org/apache/juneau/client/RestCall.html#close--"><code>close()</code></a> is called.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="getOutputStream-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOutputStream</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.307">getOutputStream</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</pre>
+<div class="block">Retrieves an output stream associated with an ID via <a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.lang.String-java.io.OutputStream-boolean-"><code>pipeTo(String, OutputStream, boolean)</code></a></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>id</code> - A string identifier that can be used to retrieve the writer using <a href="../../../../org/apache/juneau/client/RestCall.html#getWriter-java.lang.String-"><code>getWriter(String)</code></a></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The writer, or <jk>null</jk> if no writer is associated with that ID.</dd>
+</dl>
+</li>
+</ul>
+<a name="ignoreErrors--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ignoreErrors</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.315">ignoreErrors</a>()</pre>
+<div class="block">Prevent <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallExceptions</code></a> from being thrown when HTTP status 400+ is encountered.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="captureResponse--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>captureResponse</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.327">captureResponse</a>()</pre>
+<div class="block">Stores the response text so that it can later be captured using <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>getCapturedResponse()</code></a>.
+ <p>
+ This method should only be called once. Multiple calls to this method are ignored.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="failurePattern-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>failurePattern</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.359">failurePattern</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> errorPattern)</pre>
+<div class="block">Look for the specified regular expression pattern in the response output.
+ <p>
+ Causes a <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallException</code></a> to be thrown if the specified pattern is found in the output.
+ <p>
+ This method uses <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>getCapturedResponse()</code></a> to read the response text and so does not affect the other output
+ methods such as <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>getResponseAsString()</code></a>.
+
+ <dl>
+ <dt>Example:</dt>
+ <dd>
+ <p class='bcode'>
+ <jc>// Throw a RestCallException if FAILURE or ERROR is found in the output.</jc>
+ restClient.doGet(<jsf>URL</jsf>)
+ .failurePattern(<js>"FAILURE|ERROR"</js>)
+ .run();
+ </p>
+ </dd>
+ </dl></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>errorPattern</code> - A regular expression to look for in the response output.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="successPattern-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>successPattern</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.394">successPattern</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> successPattern)</pre>
+<div class="block">Look for the specified regular expression pattern in the response output.
+ <p>
+ Causes a <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client"><code>RestCallException</code></a> to be thrown if the specified pattern is not found in the output.
+ <p>
+ This method uses <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>getCapturedResponse()</code></a> to read the response text and so does not affect the other output
+ methods such as <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>getResponseAsString()</code></a>.
+
+ <dl>
+ <dt>Example:</dt>
+ <dd>
+ <p class='bcode'>
+ <jc>// Throw a RestCallException if SUCCESS is not found in the output.</jc>
+ restClient.doGet(<jsf>URL</jsf>)
+ .successPattern(<js>"SUCCESS"</js>)
+ .run();
+ </p>
+ </dd>
+ </dl></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>successPattern</code> - A regular expression to look for in the response output.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="addResponsePattern-org.apache.juneau.client.ResponsePattern-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addResponsePattern</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.417">addResponsePattern</a>(<a href="../../../../org/apache/juneau/client/ResponsePattern.html" title="class in org.apache.juneau.client">ResponsePattern</a> responsePattern)</pre>
+<div class="block">Adds a response pattern finder to look for regular expression matches in the response output.
+ <p>
+ This method can be called multiple times to add multiple response pattern finders.
+ <p>
+ <a href="../../../../org/apache/juneau/client/ResponsePattern.html" title="class in org.apache.juneau.client"><code>ResponsePatterns</code></a> use the <a href="../../../../org/apache/juneau/client/RestCall.html#getCapturedResponse--"><code>getCapturedResponse()</code></a> to read the response text and so does not affect the other output
+ methods such as <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>getResponseAsString()</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>responsePattern</code> - The response pattern finder.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="setConfig-org.apache.http.client.config.RequestConfig-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setConfig</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.438">setConfig</a>(org.apache.http.client.config.RequestConfig config)</pre>
+<div class="block">Set configuration settings on this request.
+ <p>
+ Use <code>RequestConfig.custom()</code> to create configuration parameters for the request.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>config</code> - The new configuration settings for this request.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+</dl>
+</li>
+</ul>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public int <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.449">execute</a>()
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a>.</span></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The HTTP response code.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="run--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>run</h4>
+<pre>public int <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.477">run</a>()
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Method used to execute an HTTP response where you're only interested in the HTTP response code.
+ <p>
+ The response entity is discarded unless one of the pipe methods have been specified to pipe the
+ output to an output stream or writer.
+
+ <dl>
+ <dt>Example:</dt>
+ <dd>
+ <p class='bcode'>
+ <jk>try</jk> {
+ RestClient client = <jk>new</jk> RestClient();
+ <jk>int</jk> rc = client.doGet(url).execute();
+ <jc>// Succeeded!</jc>
+ } <jk>catch</jk> (RestCallException e) {
+ <jc>// Failed!</jc>
+ }
+ </p>
+ </dd>
+ </dl></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If an exception or non-200 response code occurred during the connection attempt.</dd>
+</dl>
+</li>
+</ul>
+<a name="connect--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>connect</h4>
+<pre>public <a href="../../../../org/apache/juneau/client/RestCall.html" title="class in org.apache.juneau.client">RestCall</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.510">connect</a>()
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Connects to the REST resource.
+ <p>
+ If this is a <code>PUT</code> or <code>POST</code>, also sends the input to the remote resource.<br>
+ <p>
+ Typically, you would only call this method if you're not interested in retrieving the body of the HTTP response.
+ Otherwise, you're better off just calling one of the <a href="../../../../org/apache/juneau/client/RestCall.html#getReader--"><code>getReader()</code></a>/<a href="../../../../org/apache/juneau/client/RestCall.html#getResponse-java.lang.Class-"><code>getResponse(Class)</code></a>/<a href="../../../../org/apache/juneau/client/RestCall.html#pipeTo-java.io.Writer-"><code>pipeTo(Writer)</code></a>
+ methods directly which automatically call this method already.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>This object (for method chaining).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If an exception or <code>400+</code> HTTP status code occurred during the connection attempt.</dd>
+</dl>
+</li>
+</ul>
+<a name="getReader--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getReader</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.604">getReader</a>()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as a reader.
+ <p>
+ If an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> has been registered with the <a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><code>RestClient</code></a>, then the underlying input stream
+ will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ <p>
+ If present, automatically handles the <code>charset</code> value in the <code>Content-Type</code> response header.
+ <p>
+ <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The HTTP response message body reader. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an exception occurred while streaming was already occurring.</dd>
+</dl>
+</li>
+</ul>
+<a name="getCapturedResponse--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCapturedResponse</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.645">getCapturedResponse</a>()</pre>
+<div class="block">Returns the response text as a string if <a href="../../../../org/apache/juneau/client/RestCall.html#captureResponse--"><code>captureResponse()</code></a> was called on this object.
+ <p>
+ Note that while similar to <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>getResponseAsString()</code></a>, this method can be called multiple times
+ to retrieve the response text multiple times.
+ <p>
+ Note that this method returns <jk>null</jk> if you have not called one of the methods that cause
+ the response to be processed. (e.g. <a href="../../../../org/apache/juneau/client/RestCall.html#run--"><code>run()</code></a>, <a href="../../../../org/apache/juneau/client/RestCall.html#getResponse--"><code>getResponse()</code></a>, <a href="../../../../org/apache/juneau/client/RestCall.html#getResponseAsString--"><code>getResponseAsString()</code></a>.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The captured response, or <jk>null</jk> if <a href="../../../../org/apache/juneau/client/RestCall.html#captureResponse--"><code>captureResponse()</code></a> has not been called.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If trying to call this method before the response is consumed.</dd>
+</dl>
+</li>
+</ul>
+<a name="getParser--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getParser</h4>
+<pre>protected <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.659">getParser</a>()
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Returns the parser specified on the client to use for parsing HTTP response bodies.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The parser.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If no parser was defined on the client.</dd>
+</dl>
+</li>
+</ul>
+<a name="getSerializer--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSerializer</h4>
+<pre>protected <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.671">getSerializer</a>()
+ throws <a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></pre>
+<div class="block">Returns the serializer specified on the client to use for serializing HTTP request bodies.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The serializer.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If no serializer was defined on the client.</dd>
+</dl>
+</li>
+</ul>
+<a name="getContentLength--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getContentLength</h4>
+<pre>public int <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.683">getContentLength</a>()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Returns the value of the <code>Content-Length</code> header.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The value of the <code>Content-Length</code> header, or <code>-1</code> if header is not present.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="getInputStream--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInputStream</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.706">getInputStream</a>()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as an input stream.
+ <p>
+ If an <a href="../../../../org/apache/juneau/encoders/Encoder.html" title="class in org.apache.juneau.encoders"><code>Encoder</code></a> has been registered with the <a href="../../../../org/apache/juneau/client/RestClient.html" title="class in org.apache.juneau.client"><code>RestClient</code></a>, then the underlying input stream
+ will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>).
+ <p>
+ <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The HTTP response message body input stream. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204).</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an exception occurred while streaming was already occurring.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If an attempt is made to read the response more than once.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResponseAsString--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponseAsString</h4>
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.732">getResponseAsString</a>()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as plain text.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The response as a string.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/client/RestCallException.html" title="class in org.apache.juneau.client">RestCallException</a></code> - If an exception or non-200 response code occurred during the connection attempt.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an exception occurred while streaming was already occurring.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResponse-java.lang.Class-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponse</h4>
+<pre>public <T> T <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.754">getResponse</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> type)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
+ <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre>
+<div class="block">Converts the output from the connection into an object of the specified class using the registered <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Type Parameters:</span></dt>
+<dd><code>T</code> - The class to convert the input to.</dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>type</code> - The class to convert the input to.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The parsed output.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a connection error occurred.</dd>
+<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code> - If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResponsePojoRest-java.lang.Class-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponsePojoRest</h4>
+<pre>public <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils">PojoRest</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.771">getResponsePojoRest</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> innerType)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
+ <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre>
+<div class="block">Parses the output from the connection into the specified type and then wraps that in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.
+ <p>
+ Useful if you want to quickly retrieve a single value from inside of a larger JSON document.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>innerType</code> - The class type of the POJO being wrapped.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The parsed output wapped in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a connection error occurred.</dd>
+<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code> - If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResponsePojoRest--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponsePojoRest</h4>
+<pre>public <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils">PojoRest</a> <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.784">getResponsePojoRest</a>()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
+ <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></pre>
+<div class="block">Converts the output from the connection into an <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau"><code>ObjectMap</code></a> and then wraps that in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.
+ <p>
+ Useful if you want to quickly retrieve a single value from inside of a larger JSON document.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The parsed output wapped in a <a href="../../../../org/apache/juneau/utils/PojoRest.html" title="class in org.apache.juneau.utils"><code>PojoRest</code></a>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a connection error occurred.</dd>
+<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code> - If the input contains a syntax error or is malformed for the <code>Content-Type</code> header.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResponseMap-java.lang.Class-java.lang.Class-java.lang.Class-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponseMap</h4>
+<pre>public final <K,V,T extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><K,V>> T <a href="../../../../src-html/org/apache/juneau/client/RestCall.html#line.815">getResponseMap</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapClass,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><K> keyClass,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><V> valueClass)
+ throws <a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a>,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Convenience method when you want to parse into a Map<K,V> object.
+
+ <dl>
+ <dt>Example:</dt>
+ <dd>
+ <p class='bcode'>
+ Map<String,MyBean> m = client.doGet(url).getResponseMap(LinkedHashMap.<jk>class</jk>, String.<jk>class</jk>, MyBean.<jk>class</jk>);
+ </p>
+ <p>
+ A simpler approach is often to just extend the map class you want and just use the normal <a href="../../../../org/apache/juneau/client/RestCall.html#getResponse-java.lang.Class-"><code>getResponse(Class)</code></a> method:
+ </p>
+ <p class='bcode'>
+ <jk>public static class</jk> MyMap <jk>extends</jk> LinkedHashMap<String,MyBean> {}
+
+ Map<String,MyBean> m = client.doGet(url).getResponse(MyMap.<jk>class</jk>);
+ </p>
+ </dd>
+ </dl></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>mapClass</code> - The map class to use (e.g. <code>TreeMap</code>)</dd>
+<dd><code>keyClass</code> - The class type of the keys (e.g. <code>String</code>)</dd>
+<dd><code>valueClass</code> - The class type of the values (e.g. <code>MyBean</code>)</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The response parsed as a map.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser">ParseException</a></code></dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="getResponseCollection-java.lang.Class-java.lang.Class-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResponseCollection</h4>
+<pre>public final <E,T extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><E>> T <a href="../../../../src-html/org/apache/juneau/cli
<TRUNCATED>