feign

Class Request

java.lang.Object

feign.Request

All Implemented Interfaces:

Serializable

public final class Request
extends Object
implements Serializable

An immutable request to an http server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Request.Body Request Body
static class	Request.HttpMethod
static class	Request.Options Controls the per-request settings currently required to be implemented by all clients
static class	Request.ProtocolVersion

Method Summary

Modifier and Type	Method and Description
byte[]	body() If present, this is the replayable body to send to the server.
Charset	charset() Charset of the request.
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)
void	header(String key, Collection<String> values) Add new entries to request Headers.
void	header(String key, String value) Add new entries to request Headers.
Map<String,Collection<String>>	headers() Request Headers.
Request.HttpMethod	httpMethod() Http Method for the request.
boolean	isBinary()
int	length() Request Length.
String	method() Deprecated. @see httpMethod()
Request.ProtocolVersion	protocolVersion() Request HTTP protocol version
RequestTemplate	requestTemplate()
String	toString() Request as an HTTP/1.1 request.
String	url() URL for the request.

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()

URL for the request.

Returns:

URL as a String.

headers

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

Request Headers.

Returns:

the request headers.

header

public void header(String key,
                   String value)

Add new entries to request Headers. It overrides existing entries

Parameters:

key -

value -

header

public void header(String key,
                   Collection<String> values)

Add new entries to request Headers. It overrides existing entries

Parameters:

key -

values -

charset

public Charset charset()

Charset of the request.

Returns:

the current character set for the request, may be null for binary data.

body

public byte[] body()

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

See Also:

charset()

isBinary

public boolean isBinary()

length

public int length()

Request Length.

Returns:

size of the request body.

protocolVersion

public Request.ProtocolVersion protocolVersion()

Request HTTP protocol version

Returns:

HTTP protocol version

toString

public String toString()

Request as an HTTP/1.1 request.

Overrides:

toString in class Object

Returns:

the request.

requestTemplate

@Experimental
public RequestTemplate requestTemplate()