RestCall (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Session
- - org.apache.juneau.BeanSession
  - - org.apache.juneau.rest.client.RestCall

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class RestCall
extends BeanSession
implements Closeable
```
Represents a connection to a remote REST resource.
Instances of this class are created by the various doX() methods on the RestClient class.
This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so...
RestClient client = new RestClient(); RestCall c = client.doPost(URL).setInput(o).setHeader(x,y); MyBean b = c.getResponse(MyBean.class);

The actual connection and request/response transaction occurs when calling one of the getResponseXXX() methods.
See Also:
- Overview > juneau-rest-client

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RestCall(RestClient client, org.apache.http.client.methods.HttpRequestBase request, URI uri)` Constructs a REST call with the specified method name.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RestCall`	`accept(Object value)` Sets the value for the `Accept` request header.
`RestCall`	`acceptCharset(Object value)` Sets the value for the `Accept-Charset` request header.
`RestCall`	`acceptEncoding(Object value)` Sets the value for the `Accept-Encoding` request header.
`RestCall`	`acceptLanguage(Object value)` Sets the value for the `Accept-Language` request header.
`RestCall`	`allowRedirectsOnPosts(boolean b)` For this call, allow automatic redirects when a 302 or 307 occurs when performing a POST.
`RestCall`	`authorization(Object value)` Sets the value for the `Authorization` request header.
`RestCall`	`byLines()` When output is piped to writers, flush the writers after every line of output.
`RestCall`	`cacheControl(Object value)` Sets the value for the `Cache-Control` request header.
`RestCall`	`captureResponse()` Stores the response text so that it can later be captured using `getCapturedResponse()`.
`RestCall`	`clientVersion(String version)` Sets the client version by setting the value for the "X-Client-Version" header.
`void`	`close()` Cleans up this HTTP call.
`RestCall`	`connect()` Connects to the REST resource.
`RestCall`	`connection(Object value)` Sets the value for the `Connection` request header.
`void`	`consumeResponse()` Deprecated.
`RestCall`	`contentLength(Object value)` Sets the value for the `Content-Length` request header.
`RestCall`	`contentType(Object value)` Sets the value for the `Content-Type` request header.
`RestCall`	`date(Object value)` Sets the value for the `Date` request header.
`RestCall`	`debug()` Sets `Debug: value` header on this request.
`int`	`execute()` Deprecated. Use `run()`.
`RestCall`	`expect(Object value)` Sets the value for the `Expect` request header.
`RestCall`	`failurePattern(String errorPattern)` Look for the specified regular expression pattern in the response output.
`RestCall`	`formData(Map<String,Object> params)` Adds form data pairs to this request to perform a URL-encoded form post.
`RestCall`	`formData(NameValuePairs nameValuePairs)` Adds form data pairs to this request to perform a URL-encoded form post.
`RestCall`	`formData(String name, Object value)` Adds a form data pair to this request to perform a URL-encoded form post.
`RestCall`	`formData(String name, Object value, boolean skipIfEmpty, HttpPartSerializer partSerializer)` Adds a form data pair to this request to perform a URL-encoded form post.
`RestCall`	`formDataIfNE(Map<String,Object> params)` Adds form data parameters to the request for any parameters that aren't null/empty.
`RestCall`	`formDataIfNE(String name, Object value)` Adds a form data pair to the request if the parameter value is not null or an empty string.
`RestCall`	`forwarded(Object value)` Sets the value for the `Forwarded` request header.
`RestCall`	`from(Object value)` Sets the value for the `From` request header.
`String`	`getCapturedResponse()` Returns the response text as a string if `captureResponse()` was called on this object.
`int`	`getContentLength()` Returns the value of the `Content-Length` header.
`InputStream`	`getInputStream()` Connects to the remote resource (if `connect()` hasn't already been called) and returns the HTTP response message body as an input stream.
`OutputStream`	`getOutputStream(String id)` Retrieves an output stream associated with an ID via `pipeTo(String, OutputStream, boolean)`
`protected Parser`	`getParser()` Returns the parser specified on the client to use for parsing HTTP response bodies.
`Reader`	`getReader()` Connects to the remote resource (if `connect()` hasn't already been called) and returns the HTTP response message body as a reader.
`org.apache.http.client.methods.HttpUriRequest`	`getRequest()` Returns access to the `HttpUriRequest` passed to `HttpClient.execute(HttpUriRequest)`.
`org.apache.http.HttpResponse`	`getResponse()` Returns access to the `HttpResponse` returned by `HttpClient.execute(HttpUriRequest)`.
`<T> T`	`getResponse(Class<T> type)` Same as `getResponse(Type, Type...)` except optimized for a non-parameterized class.
`<T> T`	`getResponse(Type type, Type... args)` Parses HTTP body into the specified object type.
`String`	`getResponseAsString()` Connects to the remote resource (if `connect()` hasn't already been called) and returns the HTTP response message body as plain text.
`Future<String>`	`getResponseAsStringFuture()` Same as `getResponse(Class)` but allows you to run the call asynchronously.
`int`	`getResponseCode()` Connects to the remote resource (if `connect()` hasn't already been called) and returns the HTTP response code.
`<T> Future<T>`	`getResponseFuture(Class<T> type)` Same as `getResponse(Class)` but allows you to run the call asynchronously.
`<T> Future<T>`	`getResponseFuture(Type type, Type... args)` Same as `getResponse(Class)` but allows you to run the call asynchronously.
`String`	`getResponseHeader(String name)` Connects to the remote resource (if `connect()` hasn't already been called) and returns the value of an HTTP header on the response.
`PojoRest`	`getResponsePojoRest()` Converts the output from the connection into an `ObjectMap` and then wraps that in a `PojoRest`.
`PojoRest`	`getResponsePojoRest(Class<?> innerType)` Parses the output from the connection into the specified type and then wraps that in a `PojoRest`.
`protected Serializer`	`getSerializer()` Returns the serializer specified on the client to use for serializing HTTP request bodies.
`Writer`	`getWriter(String id)` Retrieves a writer associated with an ID via `pipeTo(String, Writer, boolean)`
`RestCall`	`header(org.apache.http.Header header)` Shortcut for calling `getRequest().setHeader(header)`
`RestCall`	`header(String name, Object value)` Sets a header on the request.
`RestCall`	`header(String name, Object value, boolean skipIfEmpty, HttpPartSerializer partSerializer)` Sets a header on the request.
`RestCall`	`headerIfNE(String name, Object value)` Sets a header on the request if the value is not null/empty.
`RestCall`	`headers(Map<String,Object> values)` Sets headers on the request.
`RestCall`	`headersIfNE(Map<String,Object> values)` Sets headers on the request if the values are not null/empty.
`RestCall`	`host(Object value)` Sets the value for the `Host` request header.
`RestCall`	`host(String host)` Sets the URI host.
`RestCall`	`ifMatch(Object value)` Sets the value for the `If-Match` request header.
`RestCall`	`ifModifiedSince(Object value)` Sets the value for the `If-Modified-Since` request header.
`RestCall`	`ifNoneMatch(Object value)` Sets the value for the `If-None-Match` request header.
`RestCall`	`ifRange(Object value)` Sets the value for the `If-Range` request header.
`RestCall`	`ifUnmodifiedSince(Object value)` Sets the value for the `If-Unmodified-Since` request header.
`RestCall`	`ignoreErrors()` Prevent `RestCallExceptions` from being thrown when HTTP status 400+ is encountered.
`RestCall`	`input(Object input)` Sets the input for this REST call.
`RestCall`	`interceptor(RestCallInterceptor interceptor)` Add an interceptor for this call only.
`RestCall`	`logTo(Level level, Logger log)` Adds a `RestCallLogger` to the list of interceptors on this class.
`RestCall`	`maxForwards(Object value)` Sets the value for the `Max-Forwards` request header.
`RestCall`	`origin(Object value)` Sets the value for the `Origin` request header.
`RestCall`	`parser(Parser parser)` Specifies the parser to use on this call.
`RestCall`	`path(String name, Object value)` Replaces a variable of the form "{name}" in the URL path with the specified value.
`RestCall`	`path(String name, Object value, HttpPartSerializer partSerializer)` Replaces a variable of the form "{name}" in the URL path with the specified value.
`RestCall`	`pipeTo(OutputStream os)` Pipes the request output to the specified output stream when `run()` is called.
`RestCall`	`pipeTo(OutputStream os, boolean close)` Pipe output from response to the specified output stream when `run()` is called.
`RestCall`	`pipeTo(String id, OutputStream os, boolean close)` Pipe output from response to the specified output stream when `run()` is called and associate that output stream with an ID so it can be retrieved through `getOutputStream(String)`.
`RestCall`	`pipeTo(String id, Writer w, boolean close)` Pipe output from response to the specified writer when `run()` is called and associate that writer with an ID so it can be retrieved through `getWriter(String)`.
`RestCall`	`pipeTo(Writer w)` Pipes the request output to the specified writer when `run()` is called.
`RestCall`	`pipeTo(Writer w, boolean close)` Pipe output from response to the specified writer when `run()` is called.
`RestCall`	`port(int port)` Sets the URI port.
`RestCall`	`pragma(Object value)` Sets the value for the `Pragma` request header.
`RestCall`	`proxyAuthorization(Object value)` Sets the value for the `Proxy-Authorization` request header.
`RestCall`	`query(Map<String,Object> params)` Adds query parameters to the URI query.
`RestCall`	`query(String query)` Sets a custom URI query.
`RestCall`	`query(String name, Object value)` Adds a query parameter to the URI query.
`RestCall`	`query(String name, Object value, boolean skipIfEmpty, HttpPartSerializer partSerializer)` Adds a query parameter to the URI query.
`RestCall`	`queryIfNE(Map<String,Object> params)` Adds query parameters to the URI for any parameters that aren't null/empty.
`RestCall`	`queryIfNE(String name, Object value)` Adds a query parameter to the URI query if the parameter value is not null or an empty string.
`RestCall`	`range(Object value)` Sets the value for the `Range` request header.
`RestCall`	`redirectMaxAttempts(int maxAttempts)` Specify the number of redirects to follow before throwing an exception.
`RestCall`	`referer(Object value)` Sets the value for the `Referer` request header.
`RestCall`	`responsePattern(ResponsePattern responsePattern)` Adds a response pattern finder to look for regular expression matches in the response output.
`RestCall`	`retryable(int retries, long interval, RetryOn retryOn)` Make this call retryable if an error response (>=400) is received.
`int`	`run()` Method used to execute an HTTP response where you're only interested in the HTTP response code.
`Future<Integer>`	`runFuture()` Same as `run()` but allows you to run the call asynchronously.
`RestCall`	`scheme(String scheme)` Sets the URI scheme.
`RestCall`	`serializer(Serializer serializer)` Specifies the serializer to use on this call.
`RestCall`	`setConfig(org.apache.http.client.config.RequestConfig config)` Set configuration settings on this request.
`RestCall`	`successPattern(String successPattern)` Look for the specified regular expression pattern in the response output.
`RestCall`	`te(Object value)` Sets the value for the `TE` request header.
`RestCall`	`upgrade(Object value)` Sets the value for the `Upgrade` request header.
`RestCall`	`uri(Object uri)` Sets the URI for this call.
`RestCall`	`userAgent(Object value)` Sets the value for the `User-Agent` request header.
`RestCall`	`userInfo(String userInfo)` Sets the URI user info.
`RestCall`	`userInfo(String username, String password)` Sets the URI user info.
`RestCall`	`via(Object value)` Sets the value for the `Via` request header.
`RestCall`	`warning(Object value)` Sets the value for the `Warning` request header.

Methods inherited from class org.apache.juneau.BeanSession
_class, asMap, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getLocale, getMediaType, getStringBuilder, getTimeZone, isBean, isBean, isDebug, isIgnoreUnknownBeanProperties, newBean, newBean, newBeanMap, newBeanMap, newInstance, newInstance, newInstanceFromOuter, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session
addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasWarnings, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RestCall
```
protected RestCall(RestClient client,
                   org.apache.http.client.methods.HttpRequestBase request,
                   URI uri)
            throws RestCallException
```
    Constructs a REST call with the specified method name.
    
    Parameters:
    
    client - The client that created this request.
    
    request - The wrapped Apache HTTP client request object.
    
    uri - The URI for this call.
    
    Throws:
    
    RestCallException - If an exception or non-200 response code occurred during the connection attempt.
- Method Detail
  - uri
```
public RestCall uri(Object uri)
             throws RestCallException
```
    Sets the URI for this call.
    Can be any of the following types:
    - URI
    - URL
    - URIBuilder
    - Anything else converted to a string using Object.toString().
    Relative URL strings will be interpreted as relative to the root URL defined on the client.
    Parameters:
    
    uri - The URI to use for this call. This overrides the URI passed in from the client.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - scheme
```
public RestCall scheme(String scheme)
```
    Sets the URI scheme.
    
    Parameters:
    
    scheme - The new URI host.
    
    Returns:
    
    This object (for method chaining).
  - host
```
public RestCall host(String host)
```
    Sets the URI host.
    
    Parameters:
    
    host - The new URI host.
    
    Returns:
    
    This object (for method chaining).
  - port
```
public RestCall port(int port)
```
    Sets the URI port.
    
    Parameters:
    
    port - The new URI port.
    
    Returns:
    
    This object (for method chaining).
  - query
```
public RestCall query(String name,
                      Object value,
                      boolean skipIfEmpty,
                      HttpPartSerializer partSerializer)
               throws RestCallException
```
    Adds a query parameter to the URI query.
    
    Parameters:
    
    name - The parameter name. Can be null/blank/* if the value is a Map, String, NameValuePairs, or bean.
    
    value - The parameter value converted to a string using UON notation. Can also be Map, String, NameValuePairs, or bean if the name is null/blank/*. If a String and the name is null/blank/*, then calls URIBuilder.setCustomQuery(String).
    
    skipIfEmpty - Don't add the pair if the value is empty.
    
    partSerializer - The part serializer to use to convert the value to a string. If null, then the URL-encoding serializer defined on the client is used.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - query
```
public RestCall query(String name,
                      Object value)
               throws RestCallException
```
    Adds a query parameter to the URI query.
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - query
```
public RestCall query(Map<String,Object> params)
               throws RestCallException
```
    Adds query parameters to the URI query.
    
    Parameters:
    
    params - The parameters. Values are converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - queryIfNE
```
public RestCall queryIfNE(String name,
                          Object value)
                   throws RestCallException
```
    Adds a query parameter to the URI query if the parameter value is not null or an empty string.
    NE = "not empty"
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - queryIfNE
```
public RestCall queryIfNE(Map<String,Object> params)
                   throws RestCallException
```
    Adds query parameters to the URI for any parameters that aren't null/empty.
    NE = "not empty"
    
    Parameters:
    
    params - The parameters. Values are converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - query
```
public RestCall query(String query)
```
    Sets a custom URI query.
    
    Parameters:
    
    query - The new URI query string.
    
    Returns:
    
    This object (for method chaining).
  - formData
```
public RestCall formData(String name,
                         Object value,
                         boolean skipIfEmpty,
                         HttpPartSerializer partSerializer)
                  throws RestCallException
```
    Adds a form data pair to this request to perform a URL-encoded form post.
    
    Parameters:
    
    name - The parameter name. Can be null/blank/* if the value is a Map, NameValuePairs, or bean.
    
    value - The parameter value converted to a string using UON notation. Can also be Map, NameValuePairs, or bean if the name is null/blank/*.
    
    skipIfEmpty - Don't add the pair if the value is empty.
    
    partSerializer - The part serializer to use to convert the value to a string. If null, then the URL-encoding serializer defined on the client is used.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - formData
```
public RestCall formData(String name,
                         Object value)
                  throws RestCallException
```
    Adds a form data pair to this request to perform a URL-encoded form post.
    
    Parameters:
    
    name - The parameter name. Can be null/blank if the value is a Map or NameValuePairs.
    
    value - The parameter value converted to a string using UON notation. Can also be a Map or NameValuePairs.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If name was null/blank and value wasn't a Map or NameValuePairs.
  - formData
```
public RestCall formData(NameValuePairs nameValuePairs)
                  throws RestCallException
```
    Adds form data pairs to this request to perform a URL-encoded form post.
    
    Parameters:
    
    nameValuePairs - The name-value pairs of the request.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - formData
```
public RestCall formData(Map<String,Object> params)
                  throws RestCallException
```
    Adds form data pairs to this request to perform a URL-encoded form post.
    
    Parameters:
    
    params - The parameters. Values are converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If name was null/blank and value wasn't a Map or NameValuePairs.
  - formDataIfNE
```
public RestCall formDataIfNE(String name,
                             Object value)
                      throws RestCallException
```
    Adds a form data pair to the request if the parameter value is not null or an empty string.
    NE = "not empty"
    
    Parameters:
    
    name - The parameter name.
    
    value - The parameter value converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - formDataIfNE
```
public RestCall formDataIfNE(Map<String,Object> params)
                      throws RestCallException
```
    Adds form data parameters to the request for any parameters that aren't null/empty.
    NE = "not empty"
    
    Parameters:
    
    params - The parameters. Values are converted to a string using UON notation.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - path
```
public RestCall path(String name,
                     Object value,
                     HttpPartSerializer partSerializer)
              throws RestCallException
```
    Replaces a variable of the form "{name}" in the URL path with the specified value.
    
    Parameters:
    
    name - The path variable name.
    
    value - The replacement value.
    
    partSerializer - The part serializer to use to convert the value to a string. If null, then the URL-encoding serializer defined on the client is used.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If variable could not be found in path.
  - path
```
public RestCall path(String name,
                     Object value)
              throws RestCallException
```
    Replaces a variable of the form "{name}" in the URL path with the specified value.
    
    Parameters:
    
    name - The path variable name.
    
    value - The replacement value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If variable could not be found in path.
  - userInfo
```
public RestCall userInfo(String userInfo)
```
    Sets the URI user info.
    
    Parameters:
    
    userInfo - The new URI user info.
    
    Returns:
    
    This object (for method chaining).
  - userInfo
```
public RestCall userInfo(String username,
                         String password)
```
    Sets the URI user info.
    
    Parameters:
    
    username - The new URI username.
    
    password - The new URI password.
    
    Returns:
    
    This object (for method chaining).
  - input
```
public RestCall input(Object input)
               throws RestCallException
```
    Sets the input for this REST call.
    Parameters:
    input - The input to be sent to the REST resource (only valid for PUT and POST) requests.
    Can be of the following types:
    
    Reader - Raw contents of Reader will be serialized to remote resource.
    InputStream - Raw contents of InputStream will be serialized to remote resource.
    Object - POJO to be converted to text using the Serializer registered with the RestClient.
    HttpEntity - Bypass Juneau serialization and pass HttpEntity directly to HttpClient.
    NameValuePairs - Converted to a URL-encoded FORM post.
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If a retry was attempted, but the entity was not repeatable.
  - serializer
```
public RestCall serializer(Serializer serializer)
```
    Specifies the serializer to use on this call.
    Overrides the serializer specified on the RestClient.
    
    Parameters:
    
    serializer - The serializer used to serialize POJOs to the body of the HTTP request.
    
    Returns:
    
    This object (for method chaining).
  - parser
```
public RestCall parser(Parser parser)
```
    Specifies the parser to use on this call.
    Overrides the parser specified on the RestClient.
    
    Parameters:
    
    parser - The parser used to parse POJOs from the body of the HTTP response.
    
    Returns:
    
    This object (for method chaining).
  - header
```
public RestCall header(String name,
                       Object value,
                       boolean skipIfEmpty,
                       HttpPartSerializer partSerializer)
                throws RestCallException
```
    Sets a header on the request.
    
    Parameters:
    
    name - The header name. The name can be null/empty if the value is a Map.
    
    value - The header value.
    
    skipIfEmpty - Don't add the header if the name is null/empty.
    
    partSerializer - The part serializer to use to convert the value to a string. If null, then the URL-encoding serializer defined on the client is used.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - header
```
public RestCall header(String name,
                       Object value)
                throws RestCallException
```
    Sets a header on the request.
    
    Parameters:
    
    name - The header name. The name can be null/empty if the value is a Map.
    
    value - The header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - headers
```
public RestCall headers(Map<String,Object> values)
                 throws RestCallException
```
    Sets headers on the request.
    
    Parameters:
    
    values - The header values.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - headerIfNE
```
public RestCall headerIfNE(String name,
                           Object value)
                    throws RestCallException
```
    Sets a header on the request if the value is not null/empty.
    NE = "not empty"
    
    Parameters:
    
    name - The header name. The name can be null/empty if the value is a Map.
    
    value - The header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - headersIfNE
```
public RestCall headersIfNE(Map<String,Object> values)
                     throws RestCallException
```
    Sets headers on the request if the values are not null/empty.
    NE = "not empty"
    
    Parameters:
    
    values - The header values.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - accept
```
public RestCall accept(Object value)
                throws RestCallException
```
    Sets the value for the Accept request header.
    This overrides the media type specified on the parser, but is overridden by calling header("Accept", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - acceptCharset
```
public RestCall acceptCharset(Object value)
                       throws RestCallException
```
    Sets the value for the Accept-Charset request header.
    This is a shortcut for calling header("Accept-Charset", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - acceptEncoding
```
public RestCall acceptEncoding(Object value)
                        throws RestCallException
```
    Sets the value for the Accept-Encoding request header.
    This is a shortcut for calling header("Accept-Encoding", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - acceptLanguage
```
public RestCall acceptLanguage(Object value)
                        throws RestCallException
```
    Sets the value for the Accept-Language request header.
    This is a shortcut for calling header("Accept-Language", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - authorization
```
public RestCall authorization(Object value)
                       throws RestCallException
```
    Sets the value for the Authorization request header.
    This is a shortcut for calling header("Authorization", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - cacheControl
```
public RestCall cacheControl(Object value)
                      throws RestCallException
```
    Sets the value for the Cache-Control request header.
    This is a shortcut for calling header("Cache-Control", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - connection
```
public RestCall connection(Object value)
                    throws RestCallException
```
    Sets the value for the Connection request header.
    This is a shortcut for calling header("Connection", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - contentLength
```
public RestCall contentLength(Object value)
                       throws RestCallException
```
    Sets the value for the Content-Length request header.
    This is a shortcut for calling header("Content-Length", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - contentType
```
public RestCall contentType(Object value)
                     throws RestCallException
```
    Sets the value for the Content-Type request header.
    This overrides the media type specified on the serializer, but is overridden by calling header("Content-Type", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - date
```
public RestCall date(Object value)
              throws RestCallException
```
    Sets the value for the Date request header.
    This is a shortcut for calling header("Date", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - expect
```
public RestCall expect(Object value)
                throws RestCallException
```
    Sets the value for the Expect request header.
    This is a shortcut for calling header("Expect", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - forwarded
```
public RestCall forwarded(Object value)
                   throws RestCallException
```
    Sets the value for the Forwarded request header.
    This is a shortcut for calling header("Forwarded", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - from
```
public RestCall from(Object value)
              throws RestCallException
```
    Sets the value for the From request header.
    This is a shortcut for calling header("From", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - host
```
public RestCall host(Object value)
              throws RestCallException
```
    Sets the value for the Host request header.
    This is a shortcut for calling header("Host", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - ifMatch
```
public RestCall ifMatch(Object value)
                 throws RestCallException
```
    Sets the value for the If-Match request header.
    This is a shortcut for calling header("If-Match", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - ifModifiedSince
```
public RestCall ifModifiedSince(Object value)
                         throws RestCallException
```
    Sets the value for the If-Modified-Since request header.
    This is a shortcut for calling header("If-Modified-Since", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - ifNoneMatch
```
public RestCall ifNoneMatch(Object value)
                     throws RestCallException
```
    Sets the value for the If-None-Match request header.
    This is a shortcut for calling header("If-None-Match", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - ifRange
```
public RestCall ifRange(Object value)
                 throws RestCallException
```
    Sets the value for the If-Range request header.
    This is a shortcut for calling header("If-Range", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - ifUnmodifiedSince
```
public RestCall ifUnmodifiedSince(Object value)
                           throws RestCallException
```
    Sets the value for the If-Unmodified-Since request header.
    This is a shortcut for calling header("If-Unmodified-Since", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - maxForwards
```
public RestCall maxForwards(Object value)
                     throws RestCallException
```
    Sets the value for the Max-Forwards request header.
    This is a shortcut for calling header("Max-Forwards", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - origin
```
public RestCall origin(Object value)
                throws RestCallException
```
    Sets the value for the Origin request header.
    This is a shortcut for calling header("Origin", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - pragma
```
public RestCall pragma(Object value)
                throws RestCallException
```
    Sets the value for the Pragma request header.
    This is a shortcut for calling header("Pragma", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - proxyAuthorization
```
public RestCall proxyAuthorization(Object value)
                            throws RestCallException
```
    Sets the value for the Proxy-Authorization request header.
    This is a shortcut for calling header("Proxy-Authorization", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - range
```
public RestCall range(Object value)
               throws RestCallException
```
    Sets the value for the Range request header.
    This is a shortcut for calling header("Range", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - referer
```
public RestCall referer(Object value)
                 throws RestCallException
```
    Sets the value for the Referer request header.
    This is a shortcut for calling header("Referer", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - te
```
public RestCall te(Object value)
            throws RestCallException
```
    Sets the value for the TE request header.
    This is a shortcut for calling header("TE", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - userAgent
```
public RestCall userAgent(Object value)
                   throws RestCallException
```
    Sets the value for the User-Agent request header.
    This is a shortcut for calling header("User-Agent", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - upgrade
```
public RestCall upgrade(Object value)
                 throws RestCallException
```
    Sets the value for the Upgrade request header.
    This is a shortcut for calling header("Upgrade", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - via
```
public RestCall via(Object value)
             throws RestCallException
```
    Sets the value for the Via request header.
    This is a shortcut for calling header("Via", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - warning
```
public RestCall warning(Object value)
                 throws RestCallException
```
    Sets the value for the Warning request header.
    This is a shortcut for calling header("Warning", value);
    
    Parameters:
    
    value - The new header value.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - clientVersion
```
public RestCall clientVersion(String version)
                       throws RestCallException
```
    Sets the client version by setting the value for the "X-Client-Version" header.
    
    Parameters:
    
    version - The version string (e.g. "1.2.3")
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException
  - retryable
```
public RestCall retryable(int retries,
                          long interval,
                          RetryOn retryOn)
                   throws RestCallException
```
    Make this call retryable if an error response (>=400) is received.
    
    Parameters:
    
    retries - The number of retries to attempt.
    
    interval - The time in milliseconds between attempts.
    
    retryOn - Optional object used for determining whether a retry should be attempted. If null, uses RetryOn.DEFAULT.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If current entity is not repeatable.
  - allowRedirectsOnPosts
```
public RestCall allowRedirectsOnPosts(boolean b)
```
    For this call, allow automatic redirects when a 302 or 307 occurs when performing a POST.
    Note that this can be inefficient since the POST body needs to be serialized twice. The preferred approach if possible is to use the LaxRedirectStrategy strategy on the underlying HTTP client. However, this method is provided if you don't have access to the underlying client.
    
    Parameters:
    
    b - Redirect flag.
    
    Returns:
    
    This object (for method chaining).
  - redirectMaxAttempts
```
public RestCall redirectMaxAttempts(int maxAttempts)
```
    Specify the number of redirects to follow before throwing an exception.
    
    Parameters:
    
    maxAttempts - Allow a redirect to occur this number of times.
    
    Returns:
    
    This object (for method chaining).
  - interceptor
```
public RestCall interceptor(RestCallInterceptor interceptor)
```
    Add an interceptor for this call only.
    
    Parameters:
    
    interceptor - The interceptor to add to this call.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(Writer w)
```
    Pipes the request output to the specified writer when run() is called.
    The writer is not closed.
    This method can be called multiple times to pipe to multiple writers.
    
    Parameters:
    
    w - The writer to pipe the output to.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(Writer w,
                       boolean close)
```
    Pipe output from response to the specified writer when run() is called.
    This method can be called multiple times to pipe to multiple writers.
    
    Parameters:
    
    w - The writer to write the output to.
    
    close - Close the writer when close() is called.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(String id,
                       Writer w,
                       boolean close)
```
    Pipe output from response to the specified writer when run() is called and associate that writer with an ID so it can be retrieved through getWriter(String).
    This method can be called multiple times to pipe to multiple writers.
    
    Parameters:
    
    id - A string identifier that can be used to retrieve the writer using getWriter(String)
    
    w - The writer to write the output to.
    
    close - Close the writer when close() is called.
    
    Returns:
    
    This object (for method chaining).
  - getWriter
```
public Writer getWriter(String id)
```
    Retrieves a writer associated with an ID via pipeTo(String, Writer, boolean)
    
    Parameters:
    
    id - A string identifier that can be used to retrieve the writer using getWriter(String)
    
    Returns:
    
    The writer, or null if no writer is associated with that ID.
  - byLines
```
public RestCall byLines()
```
    When output is piped to writers, flush the writers after every line of output.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(OutputStream os)
```
    Pipes the request output to the specified output stream when run() is called.
    The output stream is not closed.
    This method can be called multiple times to pipe to multiple output streams.
    
    Parameters:
    
    os - The output stream to pipe the output to.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(OutputStream os,
                       boolean close)
```
    Pipe output from response to the specified output stream when run() is called.
    This method can be called multiple times to pipe to multiple output stream.
    
    Parameters:
    
    os - The output stream to write the output to.
    
    close - Close the output stream when close() is called.
    
    Returns:
    
    This object (for method chaining).
  - pipeTo
```
public RestCall pipeTo(String id,
                       OutputStream os,
                       boolean close)
```
    Pipe output from response to the specified output stream when run() is called and associate that output stream with an ID so it can be retrieved through getOutputStream(String).
    This method can be called multiple times to pipe to multiple output stream.
    
    Parameters:
    
    id - A string identifier that can be used to retrieve the output stream using getOutputStream(String)
    
    os - The output stream to write the output to.
    
    close - Close the output stream when close() is called.
    
    Returns:
    
    This object (for method chaining).
  - getOutputStream
```
public OutputStream getOutputStream(String id)
```
    Retrieves an output stream associated with an ID via pipeTo(String, OutputStream, boolean)
    
    Parameters:
    
    id - A string identifier that can be used to retrieve the writer using getWriter(String)
    
    Returns:
    
    The writer, or null if no writer is associated with that ID.
  - ignoreErrors
```
public RestCall ignoreErrors()
```
    Prevent RestCallExceptions from being thrown when HTTP status 400+ is encountered.
    
    Returns:
    
    This object (for method chaining).
  - captureResponse
```
public RestCall captureResponse()
```
    Stores the response text so that it can later be captured using getCapturedResponse().
    This method should only be called once. Multiple calls to this method are ignored.
    
    Returns:
    
    This object (for method chaining).
  - failurePattern
```
public RestCall failurePattern(String errorPattern)
```
    Look for the specified regular expression pattern in the response output.
    Causes a RestCallException to be thrown if the specified pattern is found in the output.
    This method uses getCapturedResponse() to read the response text and so does not affect the other output methods such as getResponseAsString().
    Example:
    
    // Throw a RestCallException if FAILURE or ERROR is found in the output. restClient.doGet(URL) .failurePattern("FAILURE|ERROR") .run();
    
    Parameters:
    
    errorPattern - A regular expression to look for in the response output.
    
    Returns:
    
    This object (for method chaining).
  - successPattern
```
public RestCall successPattern(String successPattern)
```
    Look for the specified regular expression pattern in the response output.
    Causes a RestCallException to be thrown if the specified pattern is not found in the output.
    This method uses getCapturedResponse() to read the response text and so does not affect the other output methods such as getResponseAsString().
    Example:
    
    // Throw a RestCallException if SUCCESS is not found in the output. restClient.doGet(URL) .successPattern("SUCCESS") .run();
    
    Parameters:
    
    successPattern - A regular expression to look for in the response output.
    
    Returns:
    
    This object (for method chaining).
  - responsePattern
```
public RestCall responsePattern(ResponsePattern responsePattern)
```
    Adds a response pattern finder to look for regular expression matches in the response output.
    This method can be called multiple times to add multiple response pattern finders.
    ResponsePatterns use the getCapturedResponse() to read the response text and so does not affect the other output methods such as getResponseAsString().
    
    Parameters:
    
    responsePattern - The response pattern finder.
    
    Returns:
    
    This object (for method chaining).
  - setConfig
```
public RestCall setConfig(org.apache.http.client.config.RequestConfig config)
```
    Set configuration settings on this request.
    Use RequestConfig.custom() to create configuration parameters for the request.
    
    Parameters:
    
    config - The new configuration settings for this request.
    
    Returns:
    
    This object (for method chaining).
  - execute
```
@Deprecated
public int execute()
                        throws RestCallException
```
    Deprecated. Use run().
    
    Returns:
    
    The HTTP response code.
    
    Throws:
    
    RestCallException
  - run
```
public int run()
        throws RestCallException
```
    Method used to execute an HTTP response where you're only interested in the HTTP response code.
    The response entity is discarded unless one of the pipe methods have been specified to pipe the output to an output stream or writer.
    Example:
    
    try { RestClient client = new RestClient(); int rc = client.doGet(url).execute(); // Succeeded! } catch (RestCallException e) { // Failed! }
    
    Returns:
    
    The HTTP status code.
    
    Throws:
    
    RestCallException - If an exception or non-200 response code occurred during the connection attempt.
  - runFuture
```
public Future<Integer> runFuture()
                          throws RestCallException
```
    Same as run() but allows you to run the call asynchronously.
    
    Returns:
    
    The HTTP status code.
    
    Throws:
    
    RestCallException - If the executor service was not defined.
    
    See Also:
    
    for defining the executor service for creating {@link Future Futures}.
  - connect
```
public RestCall connect()
                 throws RestCallException
```
    Connects to the REST resource.
    If this is a PUT or POST, also sends the input to the remote resource.
    
    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 getReader()/getResponse(Class)/pipeTo(Writer) methods directly which automatically call this method already.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException - If an exception or 400+ HTTP status code occurred during the connection attempt.
  - getReader
```
public Reader getReader()
                 throws IOException
```
    Connects to the remote resource (if connect() hasn't already been called) and returns the HTTP response message body as a reader.
    If an Encoder has been registered with the RestClient, then the underlying input stream will be wrapped in the encoded stream (e.g. a GZIPInputStream).
    If present, automatically handles the charset value in the Content-Type response header.
    IMPORTANT: It is your responsibility to close this reader once you have finished with it.
    
    Returns:
    
    The HTTP response message body reader. null if response was successful but didn't contain a body (e.g. HTTP 204).
    
    Throws:
    
    IOException - If an exception occurred while streaming was already occurring.
  - getCapturedResponse
```
public String getCapturedResponse()
```
    Returns the response text as a string if captureResponse() was called on this object.
    Note that while similar to getResponseAsString(), this method can be called multiple times to retrieve the response text multiple times.
    Note that this method returns null if you have not called one of the methods that cause the response to be processed. (e.g. run(), getResponse(), getResponseAsString().
    
    Returns:
    
    The captured response, or null if captureResponse() has not been called.
    
    Throws:
    
    IllegalStateException - If trying to call this method before the response is consumed.
  - getParser
```
protected Parser getParser()
                    throws RestCallException
```
    Returns the parser specified on the client to use for parsing HTTP response bodies.
    
    Returns:
    
    The parser.
    
    Throws:
    
    RestCallException - If no parser was defined on the client.
  - getSerializer
```
protected Serializer getSerializer()
                            throws RestCallException
```
    Returns the serializer specified on the client to use for serializing HTTP request bodies.
    
    Returns:
    
    The serializer.
    
    Throws:
    
    RestCallException - If no serializer was defined on the client.
  - getContentLength
```
public int getContentLength()
                     throws IOException
```
    Returns the value of the Content-Length header.
    
    Returns:
    
    The value of the Content-Length header, or -1 if header is not present.
    
    Throws:
    
    IOException
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Connects to the remote resource (if connect() hasn't already been called) and returns the HTTP response message body as an input stream.
    If an Encoder has been registered with the RestClient, then the underlying input stream will be wrapped in the encoded stream (e.g. a GZIPInputStream).
    IMPORTANT: It is your responsibility to close this reader once you have finished with it.
    
    Returns:
    
    The HTTP response message body input stream. null if response was successful but didn't contain a body (e.g. HTTP 204).
    
    Throws:
    
    IOException - If an exception occurred while streaming was already occurring.
    
    IllegalStateException - If an attempt is made to read the response more than once.
  - getResponseAsString
```
public String getResponseAsString()
                           throws IOException
```
    Connects to the remote resource (if connect() hasn't already been called) and returns the HTTP response message body as plain text.
    The response entity is discarded unless one of the pipe methods have been specified to pipe the output to an output stream or writer.
    
    Returns:
    
    The response as a string.
    
    Throws:
    
    RestCallException - If an exception or non-200 response code occurred during the connection attempt.
    
    IOException - If an exception occurred while streaming was already occurring.
  - getResponseHeader
```
public String getResponseHeader(String name)
                         throws IOException
```
    Connects to the remote resource (if connect() hasn't already been called) and returns the value of an HTTP header on the response.
    Useful if you're only interested in a particular header value from the response and not the body of the response.
    The response entity is discarded unless one of the pipe methods have been specified to pipe the output to an output stream or writer.
    
    Parameters:
    
    name - The header name.
    
    Returns:
    
    The response header as a string, or null if the header was not found.
    
    Throws:
    
    RestCallException - If an exception or non-200 response code occurred during the connection attempt.
    
    IOException - If an exception occurred while streaming was already occurring.
  - getResponseCode
```
public int getResponseCode()
                    throws IOException
```
    Connects to the remote resource (if connect() hasn't already been called) and returns the HTTP response code.
    Useful if you're only interested in the status code and not the body of the response.
    The response entity is discarded unless one of the pipe methods have been specified to pipe the output to an output stream or writer.
    
    Returns:
    
    The response code.
    
    Throws:
    
    RestCallException - If an exception or non-200 response code occurred during the connection attempt.
    
    IOException - If an exception occurred while streaming was already occurring.
  - getResponseAsStringFuture
```
public Future<String> getResponseAsStringFuture()
                                         throws RestCallException
```
    Same as getResponse(Class) but allows you to run the call asynchronously.
    
    Returns:
    
    The response as a string.
    
    Throws:
    
    RestCallException - If the executor service was not defined.
    
    See Also:
    
    for defining the executor service for creating {@link Future Futures}.
  - getResponse
```
public <T> T getResponse(Class<T> type)
                  throws IOException,
                         ParseException
```
    Same as getResponse(Type, Type...) except optimized for a non-parameterized class.
    This is the preferred parse method for simple types since you don't need to cast the results.
    Examples:
    
    // Parse into a string. String s = restClient.doGet(url).getResponse(String.class); // Parse into a bean. MyBean b = restClient.doGet(url).getResponse(MyBean.class); // Parse into a bean array. MyBean[] ba = restClient.doGet(url).getResponse(MyBean[].class); // Parse into a linked-list of objects. List l = restClient.doGet(url).getResponse(LinkedList.class); // Parse into a map of object keys/values. Map m = restClient.doGet(url).getResponse(TreeMap.class);
    
    Notes:
    - You can also specify any of the following types:
      
      HttpResponse - Returns the raw HttpResponse returned by the inner HttpClient.
      Reader - Returns access to the raw reader of the response.
      InputStream - Returns access to the raw input stream of the response.
    Type Parameters:
    
    T - The class type of the object being created. See getResponse(Type, Type...) for details.
    
    Parameters:
    
    type - The object type to create.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    ParseException - If the input contains a syntax error or is malformed, or is not valid for the specified type.
    
    IOException - If a connection error occurred.
  - getResponseFuture
```
public <T> Future<T> getResponseFuture(Class<T> type)
                                throws RestCallException
```
    Same as getResponse(Class) but allows you to run the call asynchronously.
    
    Type Parameters:
    
    T - The class type of the object being created. See getResponse(Type, Type...) for details.
    
    Parameters:
    
    type - The object type to create.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    RestCallException - If the executor service was not defined.
    
    See Also:
    
    for defining the executor service for creating {@link Future Futures}.
  - getResponse
```
public <T> T getResponse(Type type,
                         Type... args)
                  throws IOException,
                         ParseException
```
    Parses HTTP body into the specified object type.
    The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
    Examples:
    
    // Parse into a linked-list of strings. List l = restClient.doGet(url).getResponse(LinkedList.class, String.class); // Parse into a linked-list of beans. List l = restClient.doGet(url).getResponse(LinkedList.class, MyBean.class); // Parse into a linked-list of linked-lists of strings. List l = restClient.doGet(url).getResponse(LinkedList.class, LinkedList.class, String.class); // Parse into a map of string keys/values. Map m = restClient.doGet(url).getResponse(TreeMap.class, String.class, String.class); // Parse into a map containing string keys and values of lists containing beans. Map m = restClient.doGet(url).getResponse(TreeMap.class, String.class, List.class, MyBean.class);
    
    Collection classes are assumed to be followed by zero or one objects indicating the element type.
    Map classes are assumed to be followed by zero or two meta objects indicating the key and value types.
    The array can be arbitrarily long to indicate arbitrarily complex data structures.
    Notes:
    - Use the getResponse(Class) method instead if you don't need a parameterized map/collection.
    - You can also specify any of the following types:
      
      HttpResponse - Returns the raw HttpResponse returned by the inner HttpClient.
      Reader - Returns access to the raw reader of the response.
      InputStream - Returns access to the raw input stream of the response.
    Type Parameters:
    
    T - The class type of the object to create.
    
    Parameters:
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    ParseException - If the input contains a syntax error or is malformed, or is not valid for the specified type.
    
    IOException - If a connection error occurred.
    
    See Also:
    
    for argument syntax for maps and collections.
  - getResponseFuture
```
public <T> Future<T> getResponseFuture(Type type,
                                       Type... args)
                                throws RestCallException
```
    Same as getResponse(Class) but allows you to run the call asynchronously.
    
    Type Parameters:
    
    T - The class type of the object being created. See getResponse(Type, Type...) for details.
    
    Parameters:
    
    type - The object type to create.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    
    args - The type arguments of the class if it's a collection or map.
    Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
    Ignored if the main type is not a map or collection.
    
    Returns:
    
    The parsed object.
    
    Throws:
    
    RestCallException - If the executor service was not defined.
    
    See Also:
    
    for defining the executor service for creating {@link Future Futures}.
  - getResponsePojoRest
```
public PojoRest getResponsePojoRest(Class<?> innerType)
                             throws IOException,
                                    ParseException
```
    Parses the output from the connection into the specified type and then wraps that in a PojoRest.
    Useful if you want to quickly retrieve a single value from inside of a larger JSON document.
    
    Parameters:
    
    innerType - The class type of the POJO being wrapped.
    
    Returns:
    
    The parsed output wrapped in a PojoRest.
    
    Throws:
    
    IOException - If a connection error occurred.
    
    ParseException - If the input contains a syntax error or is malformed for the Content-Type header.
  - getResponsePojoRest
```
public PojoRest getResponsePojoRest()
                             throws IOException,
                                    ParseException
```
    Converts the output from the connection into an ObjectMap and then wraps that in a PojoRest.
    Useful if you want to quickly retrieve a single value from inside of a larger JSON document.
    
    Returns:
    
    The parsed output wrapped in a PojoRest.
    
    Throws:
    
    IOException - If a connection error occurred.
    
    ParseException - If the input contains a syntax error or is malformed for the Content-Type header.
  - getRequest
```
public org.apache.http.client.methods.HttpUriRequest getRequest()
```
    Returns access to the HttpUriRequest passed to HttpClient.execute(HttpUriRequest).
    
    Returns:
    
    The HttpUriRequest object.
  - getResponse
```
public org.apache.http.HttpResponse getResponse()
                                         throws IOException
```
    Returns access to the HttpResponse returned by HttpClient.execute(HttpUriRequest).
    Returns null if connect() has not yet been called.
    
    Returns:
    
    The HTTP response object.
    
    Throws:
    
    IOException
  - header
```
public RestCall header(org.apache.http.Header header)
```
    Shortcut for calling getRequest().setHeader(header)
    
    Parameters:
    
    header - The header to set on the request.
    
    Returns:
    
    This object (for method chaining).
  - consumeResponse
```
@Deprecated
public void consumeResponse()
```
    Deprecated.
    
    Use close()
  - close
```
public void close()
           throws RestCallException
```
    Cleans up this HTTP call.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    RestCallException - Can be thrown by one of the RestCallInterceptor.onClose(RestCall) calls.
  - logTo
```
public RestCall logTo(Level level,
                      Logger log)
```
    Adds a RestCallLogger to the list of interceptors on this class.
    
    Parameters:
    
    level - The log level to log events at.
    
    log - The logger.
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public RestCall debug()
               throws RestCallException
```
    Sets Debug: value header on this request.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    RestCallException

Class RestCall

See Also:

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.BeanSession

Methods inherited from class org.apache.juneau.Session

Methods inherited from class java.lang.Object

Constructor Detail

RestCall

Method Detail

uri

scheme

host

port

query

query

query

queryIfNE

queryIfNE

query

formData

formData

formData

formData

formDataIfNE

formDataIfNE

path

path

userInfo

userInfo

input

serializer

parser

header

header

headers

headerIfNE

headersIfNE

accept

acceptCharset

acceptEncoding

acceptLanguage

authorization

cacheControl

connection

contentLength

contentType

date

expect

forwarded

from

host

ifMatch

ifModifiedSince

ifNoneMatch

ifRange

ifUnmodifiedSince

maxForwards

origin

pragma

proxyAuthorization

range

referer

te

userAgent

upgrade

via

warning

clientVersion

retryable

allowRedirectsOnPosts

redirectMaxAttempts

interceptor

pipeTo

pipeTo

pipeTo

getWriter

byLines

pipeTo

pipeTo