RestServerDriver (REST Server Driver 1.1.27 API)

java.lang.Object
- com.github.restdriver.serverdriver.RestServerDriver

```
public final class RestServerDriver
extends Object
```
Provides static methods for performing HTTP requests against a resource.

Author:

mjg

Field Summary

Fields
Modifier and Type Field and Description

static long DEFAULT_CONNECTION_TIMEOUT

static long DEFAULT_SOCKET_TIMEOUT

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_CONNECTION_TIMEOUT`
`static long`	`DEFAULT_SOCKET_TIMEOUT`

Method Summary

Methods
Modifier and Type	Method and Description
`static ByteArrayRequestBody`	`body(byte[] content, String contentType)` Make a RequestBody from a byte array.
`static ByteArrayRequestBody`	`body(InputStream content, String contentType)` Make a RequestBody from an `InputStream`.
`static ByteArrayRequestBody`	`body(Reader content, String contentType)` Make a RequestBody from a `Reader`.
`static RequestBody`	`body(String content, String contentType)` Make a RequestBody for PUT or POST.
`static Response`	`delete(Object url, AnyRequestModifier... modifiers)` Send an HTTP delete.
`static Response`	`deleteOf(Object url, AnyRequestModifier... modifiers)` Synonym for `delete(Object, AnyRequestModifier...)`.
`static Response`	`deleting(Object url, AnyRequestModifier... modifiers)` Synonym for `delete(Object, AnyRequestModifier...)`.
`static Response`	`doDeleteOf(Object url, AnyRequestModifier... modifiers)` Synonym for `delete(Object, AnyRequestModifier...)`.
`static Response`	`doGetOf(Object url, AnyRequestModifier... modifiers)` Synonym for `get(Object, AnyRequestModifier...)`.
`static Response`	`doHeadOf(Object url, AnyRequestModifier... modifiers)` Synonym for `head(Object, AnyRequestModifier...)`.
`static Response`	`doPostOf(Object url, AnyRequestModifier... modifiers)` Synonym for `post(Object, AnyRequestModifier...)`.
`static Response`	`doPutOf(Object url, AnyRequestModifier... modifiers)` Synonym for `put(Object, AnyRequestModifier...)`.
`static Response`	`get(Object url, AnyRequestModifier... modifiers)` Perform an HTTP GET on a resource.
`static Response`	`getOf(Object url, AnyRequestModifier... modifiers)` Synonym for `get(Object, AnyRequestModifier...)`.
`static Response`	`getting(Object url, AnyRequestModifier... modifiers)` Synonym for `get(Object, AnyRequestModifier...)`.
`static Response`	`head(Object url, AnyRequestModifier... modifiers)` Perform an HTTP HEAD on a resource.
`static Header`	`header(String nameAndValue)` Make a Header.
`static Header`	`header(String name, String value)` Make a Header.
`static Response`	`headOf(Object url, AnyRequestModifier... modifiers)` Synonym for `head(Object, AnyRequestModifier...)`.
`static NoOpRequestProxy`	`notUsingProxy()` Do not use a proxy.
`static Response`	`options(Object url)` Perform an HTTP OPTIONS on a resource.
`static Response`	`optionsOf(Object url)` Synonym for `options(Object)`.
`static Response`	`post(Object url, AnyRequestModifier... modifiers)` Perform an HTTP POST to the given URL.
`static Response`	`posting(Object url, AnyRequestModifier... modifiers)` Synonym for `post(Object, AnyRequestModifier...)`.
`static Response`	`postOf(Object url, AnyRequestModifier... modifiers)` Synonym for `post(Object, AnyRequestModifier...)`.
`static Response`	`put(Object url, AnyRequestModifier... modifiers)` Perform an HTTP PUT to the given URL.
`static Response`	`putOf(Object url, AnyRequestModifier... modifiers)` Synonym for `put(Object, AnyRequestModifier...)`.
`static Response`	`putting(Object url, AnyRequestModifier... modifiers)` Synonym for `put(Object, AnyRequestModifier...)`.
`static Url`	`url(String base)` Creates a new `Url` object.
`static RequestProxy`	`usingProxy(String proxyHost, int proxyPort)` Use a user-specified proxy.
`static AnyRequestModifier`	`usingSystemProxy()` Use the system proxy.
`static BasicAuth`	`withBasicAuth(String username, String password)` Use HTTP basic authentication.
`static AnyRequestModifier`	`withConnectionTimeout(int timeout, TimeUnit timeUnit)` Specify a connection timeout.
`static AnyRequestModifier`	`withSocketTimeout(int timeout, TimeUnit timeUnit)` Specify a socket timeout.
`static AnyRequestModifier`	`withTimeout(int timeout, TimeUnit timeUnit)` Use a single timeout value for both connection and socket timeouts.

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

- Field Detail
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final long DEFAULT_CONNECTION_TIMEOUT
```
    See Also:
    Constant Field Values
  - DEFAULT_SOCKET_TIMEOUT
```
public static final long DEFAULT_SOCKET_TIMEOUT
```
    See Also:
    Constant Field Values
- Method Detail
  - header
```
public static Header header(String name,
            String value)
```
    Make a Header.
    
    Parameters:
    name - The name for the header
    value - The value for the header
    
    Returns:
    The new header instance
  - header
```
public static Header header(String nameAndValue)
```
    Make a Header.
    
    Parameters:
    nameAndValue - The name and value of the header in the form "name: value"
    
    Returns:
    The new header instance
  - body
```
public static RequestBody body(String content,
               String contentType)
```
    Make a RequestBody for PUT or POST.
    
    Parameters:
    content - Request body content as String.
    contentType - content-type eg text/plain.
    
    Returns:
    The new request body instance.
  - body
```
public static ByteArrayRequestBody body(byte[] content,
                        String contentType)
```
    Make a RequestBody from a byte array.
    
    Parameters:
    content - Request body content as a byte array.
    contentType - Content-Type eg application/pdf.
    
    Returns:
    The new request body instance.
  - body
```
public static ByteArrayRequestBody body(InputStream content,
                        String contentType)
```
    Make a RequestBody from an InputStream.
    
    Parameters:
    content - Request body content as an InputStream.
    contentType - Content-Type eg application/pdf.
    
    Returns:
    The new request body instance.
  - body
```
public static ByteArrayRequestBody body(Reader content,
                        String contentType)
```
    Make a RequestBody from a Reader.
    
    Parameters:
    content - Request body content as a Reader.
    contentType - Content-Type eg application/pdf.
    
    Returns:
    The new request body instance.
  - withBasicAuth
```
public static BasicAuth withBasicAuth(String username,
                      String password)
```
    Use HTTP basic authentication.
    
    Parameters:
    username - The username.
    password - The password.
    
    Returns:
    The new BasicAuth instance.
  - usingProxy
```
public static RequestProxy usingProxy(String proxyHost,
                      int proxyPort)
```
    Use a user-specified proxy.
    
    Parameters:
    proxyHost - The host.
    proxyPort - The port.
    
    Returns:
    The new RequestProxy instance.
  - notUsingProxy
```
public static NoOpRequestProxy notUsingProxy()
```
    Do not use a proxy. This is the default anyway, but allowed for clarity.
    
    Returns:
    The new NoOpRequestProxy instance.
  - usingSystemProxy
```
public static AnyRequestModifier usingSystemProxy()
```
    Use the system proxy. These can be set with -Dhttp.proxyHost and -Dhttp.proxyPort. This does not respect environment variables like HTTP_PROXY & friends.
    
    Returns:
    The RequestProxy instance.
  - withTimeout
```
public static AnyRequestModifier withTimeout(int timeout,
                             TimeUnit timeUnit)
```
    Use a single timeout value for both connection and socket timeouts.
    
    Parameters:
    timeout - The timeout duration to use.
    timeUnit - The unit of the timeout.
    
    Returns:
    The RequestTimeout instance.
  - withConnectionTimeout
```
public static AnyRequestModifier withConnectionTimeout(int timeout,
                                       TimeUnit timeUnit)
```
    Specify a connection timeout.
    
    Parameters:
    timeout - The timeout duration to use.
    timeUnit - The unit of the timeout.
    
    Returns:
    The RequestConnectionTimeout instance.
  - withSocketTimeout
```
public static AnyRequestModifier withSocketTimeout(int timeout,
                                   TimeUnit timeUnit)
```
    Specify a socket timeout.
    
    Parameters:
    timeout - The timeout duration to use.
    timeUnit - The unit of the timeout.
    
    Returns:
    The RequestSocketTimeout instance.
  - url
```
public static Url url(String base)
```
    Creates a new Url object.
    
    Parameters:
    base - The base, like "http://localhost"
    
    Returns:
    The Url object
  - options
```
public static Response options(Object url)
```
    Perform an HTTP OPTIONS on a resource.
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    
    Returns:
    A Response encapsulating the server's reply.
  - optionsOf
```
public static Response optionsOf(Object url)
```
    Synonym for options(Object).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    
    Returns:
    A Response encapsulating the server's reply.
  - get
```
public static Response get(Object url,
           AnyRequestModifier... modifiers)
```
    Perform an HTTP GET on a resource.
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - getOf
```
public static Response getOf(Object url,
             AnyRequestModifier... modifiers)
```
    Synonym for get(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - doGetOf
```
public static Response doGetOf(Object url,
               AnyRequestModifier... modifiers)
```
    Synonym for get(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - getting
```
public static Response getting(Object url,
               AnyRequestModifier... modifiers)
```
    Synonym for get(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - post
```
public static Response post(Object url,
            AnyRequestModifier... modifiers)
```
    Perform an HTTP POST to the given URL.
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - postOf
```
public static Response postOf(Object url,
              AnyRequestModifier... modifiers)
```
    Synonym for post(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - doPostOf
```
public static Response doPostOf(Object url,
                AnyRequestModifier... modifiers)
```
    Synonym for post(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - posting
```
public static Response posting(Object url,
               AnyRequestModifier... modifiers)
```
    Synonym for post(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - put
```
public static Response put(Object url,
           AnyRequestModifier... modifiers)
```
    Perform an HTTP PUT to the given URL.
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - putOf
```
public static Response putOf(Object url,
             AnyRequestModifier... modifiers)
```
    Synonym for put(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - doPutOf
```
public static Response doPutOf(Object url,
               AnyRequestModifier... modifiers)
```
    Synonym for put(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - putting
```
public static Response putting(Object url,
               AnyRequestModifier... modifiers)
```
    Synonym for put(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL. Any object may be passed, we will call .toString() on it.
    modifiers - The modifiers to be applied to the request.
    
    Returns:
    Response encapsulating the server's reply
  - delete
```
public static Response delete(Object url,
              AnyRequestModifier... modifiers)
```
    Send an HTTP delete.
    
    Parameters:
    url - The resource to delete
    modifiers - Any http headers
    
    Returns:
    Response encapsulating the server's reply
  - deleteOf
```
public static Response deleteOf(Object url,
                AnyRequestModifier... modifiers)
```
    Synonym for delete(Object, AnyRequestModifier...).
    
    Parameters:
    url - The resource to delete
    modifiers - Any http headers
    
    Returns:
    Response encapsulating the server's reply
  - doDeleteOf
```
public static Response doDeleteOf(Object url,
                  AnyRequestModifier... modifiers)
```
    Synonym for delete(Object, AnyRequestModifier...).
    
    Parameters:
    url - The resource to delete
    modifiers - Any http headers
    
    Returns:
    Response encapsulating the server's reply
  - deleting
```
public static Response deleting(Object url,
                AnyRequestModifier... modifiers)
```
    Synonym for delete(Object, AnyRequestModifier...).
    
    Parameters:
    url - The resource to delete
    modifiers - Any http headers
    
    Returns:
    Response encapsulating the server's reply
  - head
```
public static Response head(Object url,
            AnyRequestModifier... modifiers)
```
    Perform an HTTP HEAD on a resource.
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - headOf
```
public static Response headOf(Object url,
              AnyRequestModifier... modifiers)
```
    Synonym for head(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.
  - doHeadOf
```
public static Response doHeadOf(Object url,
                AnyRequestModifier... modifiers)
```
    Synonym for head(Object, AnyRequestModifier...).
    
    Parameters:
    url - The URL of a resource. Accepts any Object and calls .toString() on it.
    modifiers - Optional HTTP headers to put on the request.
    
    Returns:
    A Response encapsulating the server's reply.

Class RestServerDriver

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_SOCKET_TIMEOUT

Method Detail

header

header

body

body

body

body

withBasicAuth

usingProxy

notUsingProxy

usingSystemProxy

withTimeout

withConnectionTimeout

withSocketTimeout

url

options

optionsOf

get

getOf

doGetOf

getting

post

postOf

doPostOf

posting

put

putOf

doPutOf

putting

delete

deleteOf

doDeleteOf

deleting

head

headOf

doHeadOf