ratpack.http.client

Interface RequestSpec

public interface RequestSpec

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RequestSpec.Body The request body.

Method Summary

Modifier and Type	Method and Description
default RequestSpec	basicAuth(String username, String password) Adds the appropriate header for HTTP Basic authentication with the given username and password.
RequestSpec	body(Action<? super RequestSpec.Body> action) Executes the given action with the request body.
RequestSpec	decompressResponse(boolean shouldDecompress) Enables automatic decompression of the response.
RequestSpec.Body	getBody() The body of the request, used for specifying the body content.
MutableHeaders	getHeaders()
URI	getUrl()
RequestSpec	headers(Action<? super MutableHeaders> action) This method can be used to compose changes to the headers.
RequestSpec	method(String method) Set the HTTP verb to use.
RequestSpec	readTimeout(Duration duration)
default RequestSpec	readTimeoutSeconds(int seconds)
RequestSpec	redirects(int maxRedirects)
default RequestSpec	sslContext(Factory<SSLContext> factory) Factory method to create SSLContext used for client and server SSL authentication.
RequestSpec	sslContext(SSLContext sslContext) Sets the SSLContext used for client and server SSL authentication.

Method Detail

redirects

RequestSpec redirects(int maxRedirects)

Parameters:

maxRedirects - Sets the maximum number of redirects to follow

Returns:

The RequestSpec

sslContext

RequestSpec sslContext(SSLContext sslContext)

Sets the SSLContext used for client and server SSL authentication.

Parameters:

sslContext - SSL context with keystore as well as trust store

Returns:

the RequestSpec

sslContext

default RequestSpec sslContext(Factory<SSLContext> factory)
                        throws Exception

Factory method to create SSLContext used for client and server SSL authentication.

Parameters:

factory - provides a factory that will create SSLContext instance

Returns:

the RequestSpec

Throws:

Exception - this can be thrown from the action

getHeaders

MutableHeaders getHeaders()

Returns:

MutableHeaders that can be used to configure the headers that will be used for the request.

headers

RequestSpec headers(Action<? super MutableHeaders> action)
             throws Exception

This method can be used to compose changes to the headers.

Parameters:

action - Provide an action that will act on MutableHeaders.

Returns:

The RequestSpec

Throws:

Exception - This can be thrown from the action supplied.

method

RequestSpec method(String method)

Set the HTTP verb to use.

Parameters:

method - which HTTP verb to use

Returns:

this

decompressResponse

RequestSpec decompressResponse(boolean shouldDecompress)

Enables automatic decompression of the response.

Parameters:

shouldDecompress - whether to enable decompression

Returns:

this

getUrl

URI getUrl()

readTimeoutSeconds

default RequestSpec readTimeoutSeconds(int seconds)

readTimeout

RequestSpec readTimeout(Duration duration)

getBody

RequestSpec.Body getBody()

The body of the request, used for specifying the body content.

Returns:

the (writable) body of the request

body

RequestSpec body(Action<? super RequestSpec.Body> action)
          throws Exception

Executes the given action with the request body.

This method is a “fluent API” alternative to getBody().

Parameters:

action - configuration of the request body

Returns:

this

Throws:

Exception - any thrown by action

basicAuth

default RequestSpec basicAuth(String username,
                              String password)

Adds the appropriate header for HTTP Basic authentication with the given username and password.

This will replace any previous value set for the "Authorization" header.

Parameters:

username - the username

password - the password

Returns:

this