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

Methods

Modifier and Type	Method and Description
RequestSpec	body(Action<? super RequestSpec.Body> action) Executes the given action with the request body.
RequestSpec.Body	getBody() The body of the request, used for specifying the body content.
MutableHeaders	getHeaders()
HttpUrlSpec	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	url(Action<? super HttpUrlSpec> action)

Method Detail

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

getUrl

HttpUrlSpec getUrl()

url

RequestSpec url(Action<? super HttpUrlSpec> action)
                throws Exception

Throws:

Exception

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