com.jcabi.http

Interface RequestBody

@Immutable
public interface RequestBody

Request body.

Instance of this interface is returned by Request.body(), and can be modified using one of the methods below. When modification is done, method back() returns a modified instance of Request, for example:

 new JdkRequest("http://my.example.com")
   .header("Content-Type", "application/x-www-form-urlencoded")
   .body()
   .formParam("name", "Jeff Lebowski")
   .formParam("age", "37")
   .formParam("employment", "none")
   .back() // returns a modified instance of Request
   .fetch()

Instances of this interface are immutable and thread-safe.

Since:

0.8

Version:

$Id: e762ba1756d9ae97faaef0e894c5a31659c8d6fd $

Author:

Yegor Bugayenko ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequestBody.Printable Printer of byte array.

Method Summary

Methods

Modifier and Type	Method and Description
Request	back() Get back to the request it's related to.
RequestBody	formParam(String name, Object value) Add form param.
RequestBody	formParams(Map<String,String> params) Add form params.
String	get() Get text content.
RequestBody	set(byte[] body) Set byte array content.
RequestBody	set(javax.json.JsonStructure json) Set JSON content.
RequestBody	set(String body) Set text content.

Method Detail

back

@NotNull(message="request is never NULL")
Request back()

Get back to the request it's related to.

Returns:

The request we're in

get

@NotNull(message="body can\'t be NULL")
String get()

Get text content.

Returns:

Content in UTF-8

set

@NotNull(message="body is never NULL")
RequestBody set(@NotNull(message="body can\'t be NULL")
                      String body)

Set text content.

Parameters:

body - Body content

Returns:

New alternated body

set

@NotNull(message="body is never NULL")
RequestBody set(@NotNull(message="JSON structure can\'t be NULL")
                      javax.json.JsonStructure json)

Set JSON content.

Parameters:

json - JSON object

Returns:

New alternated body

Since:

0.11

set

@NotNull(message="modified body is never NULL")
RequestBody set(@NotNull(message="body can\'t be NULL")
                      byte[] body)

Set byte array content.

Parameters:

body - Body content

Returns:

New alternated body

formParam

@NotNull(message="alternated body is never NULL")
RequestBody formParam(@NotNull(message="form param name can\'t be NULL")
                            String name,
                            @NotNull(message="form param value can\'t be NULL")
                            Object value)

Add form param.

Parameters:

name - Query param name

value - Value of the query param to set

Returns:

New alternated body

formParams

@NotNull(message="alternated body is never NULL")
RequestBody formParams(@NotNull(message="map of params can\'t be NULL")
                             Map<String,String> params)

Add form params.

Parameters:

params - Map of params

Returns:

New alternated body

Since:

0.10