feign

Class Request

java.lang.Object

feign.Request

public final class Request
extends Object

An immutable request to an http server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Body
static class	Request.HttpMethod
static class	Request.Options

Method Summary

Modifier and Type	Method and Description
byte[]	body() Deprecated. use requestBody() instead
Charset	charset() Deprecated. use requestBody() instead
static Request	create(Request.HttpMethod httpMethod, String url, Map<String,Collection<String>> headers, byte[] body, Charset charset) Deprecated.
static Request	create(Request.HttpMethod httpMethod, String url, Map<String,Collection<String>> headers, byte[] body, Charset charset, RequestTemplate requestTemplate) Builds a Request.
static Request	create(Request.HttpMethod httpMethod, String url, Map<String,Collection<String>> headers, Request.Body body, RequestTemplate requestTemplate) Builds a Request.
static Request	create(String method, String url, Map<String,Collection<String>> headers, byte[] body, Charset charset) Deprecated. create(HttpMethod, String, Map, byte[], Charset)
Map<String,Collection<String>>	headers()
Request.HttpMethod	httpMethod() Http Method for the request.
String	method() Deprecated. @see httpMethod()
Request.Body	requestBody()
RequestTemplate	requestTemplate()
String	toString()
String	url()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

@Deprecated
public static Request create(String method,
                                         String url,
                                         Map<String,Collection<String>> headers,
                                         byte[] body,
                                         Charset charset)

Deprecated. create(HttpMethod, String, Map, byte[], Charset)

No parameters can be null except body and charset. All parameters must be effectively immutable, via safe copies, not mutating or otherwise.

create

@Deprecated
public static Request create(Request.HttpMethod httpMethod,
                                         String url,
                                         Map<String,Collection<String>> headers,
                                         byte[] body,
                                         Charset charset)

Deprecated.

Builds a Request. All parameters must be effectively immutable, via safe copies.

Parameters:

httpMethod - for the request.

url - for the request.

headers - to include.

body - of the request, can be null

charset - of the request, can be null

Returns:

a Request

create

public static Request create(Request.HttpMethod httpMethod,
                             String url,
                             Map<String,Collection<String>> headers,
                             byte[] body,
                             Charset charset,
                             RequestTemplate requestTemplate)

Builds a Request. All parameters must be effectively immutable, via safe copies.

Parameters:

httpMethod - for the request.

url - for the request.

headers - to include.

body - of the request, can be null

charset - of the request, can be null

Returns:

a Request

create

public static Request create(Request.HttpMethod httpMethod,
                             String url,
                             Map<String,Collection<String>> headers,
                             Request.Body body,
                             RequestTemplate requestTemplate)

Builds a Request. All parameters must be effectively immutable, via safe copies.

Parameters:

httpMethod - for the request.

url - for the request.

headers - to include.

body - of the request, can be null

Returns:

a Request

method

@Deprecated
public String method()

Deprecated. @see httpMethod()

Http Method for this request.

Returns:

the HttpMethod string

httpMethod

public Request.HttpMethod httpMethod()

Http Method for the request.

Returns:

the HttpMethod.

url

public String url()

headers

public Map<String,Collection<String>> headers()

charset

@Deprecated
public Charset charset()

Deprecated. use requestBody() instead

The character set with which the body is encoded, or null if unknown or not applicable. When this is present, you can use new String(req.body(), req.charset()) to access the body as a String.

body

@Deprecated
public byte[] body()

Deprecated. use requestBody() instead

If present, this is the replayable body to send to the server. In some cases, this may be interpretable as text.

See Also:

charset()

requestBody

public Request.Body requestBody()

toString

public String toString()

Overrides:

toString in class Object

requestTemplate

@Experimental
public RequestTemplate requestTemplate()