RequestTemplate (Feign Core 10.0.1 API)

java.lang.Object
- feign.RequestTemplate

All Implemented Interfaces:

Serializable
```
public final class RequestTemplate
extends Object
implements Serializable
```
Builds a request to an http target. Not thread safe.

relationship to JAXRS 2.0

A combination of javax.ws.rs.client.WebTarget and javax.ws.rs.client.Invocation.Builder, ensuring you can modify any part of the request. However, this object is mutable, so needs to be guarded with the copy constructor.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RequestTemplate()

RequestTemplate(RequestTemplate toCopy)

Constructors
Constructor and Description
`RequestTemplate()`
`RequestTemplate(RequestTemplate toCopy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestTemplate`	`append(CharSequence value)`
`byte[]`	`body()`
`RequestTemplate`	`body(byte[] bodyData, Charset charset)` replaces the `Util.CONTENT_LENGTH` header.
`RequestTemplate`	`body(String bodyText)` replaces the `Util.CONTENT_LENGTH` header.
`String`	`bodyTemplate()`
`RequestTemplate`	`bodyTemplate(String bodyTemplate)` populated by `Body`
`Charset`	`charset()` The character set with which the body is encoded, or null if unknown or not applicable.
`CollectionFormat`	`collectionFormat()`
`RequestTemplate`	`collectionFormat(CollectionFormat collectionFormat)`
`boolean`	`decodeSlash()`
`RequestTemplate`	`decodeSlash(boolean decodeSlash)`
`static String`	`expand(String template, Map<String,?> variables)` Expands a `template`, such as `username`, using the `variables` supplied.
`RequestTemplate`	`header(String name, Iterable<String> values)`
`RequestTemplate`	`header(String name, String... values)` Replaces headers with the specified `configKey` with the `values` supplied.
`Map<String,Collection<String>>`	`headers()` Returns an immutable copy of the current headers.
`RequestTemplate`	`headers(Map<String,Collection<String>> headers)` Replaces all existing headers with the newly supplied headers.
`RequestTemplate`	`insert(int pos, CharSequence value)`
`String`	`method()`
`RequestTemplate`	`method(String method)`
`Map<String,Collection<String>>`	`queries()` Returns an immutable copy of the url decoded queries.
`RequestTemplate`	`queries(Map<String,Collection<String>> queries)` Replaces all existing queries with the newly supplied url decoded queries.
`RequestTemplate`	`query(boolean encoded, String name, Iterable<String> values)`
`RequestTemplate`	`query(boolean encoded, String name, String... values)` Replaces queries with the specified `name` with the `values` supplied.
`RequestTemplate`	`query(String name, Iterable<String> values)` Shortcut for `query(false, String, Iterable<String>)`
`RequestTemplate`	`query(String name, String... values)` Shortcut for `query(false, String, String...)`
`String`	`queryLine()`
`void`	`replaceQueryValues(Map<String,?> unencoded)` `replaceQueryValues(Map, Map)`, which assumes no parameter is encoded
`Request`	`request()`
`RequestTemplate`	`resolve(Map<String,?> unencoded)` `resolve(Map, Map)`, which assumes no parameter is encoded
`String`	`toString()`
`String`	`url()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RequestTemplate
```
public RequestTemplate()
```
  - RequestTemplate
```
public RequestTemplate(RequestTemplate toCopy)
```
- Method Detail
  - expand
```
public static String expand(String template,
                            Map<String,?> variables)
```
    Expands a template, such as username, using the variables supplied. Any unresolved parameters will remain.
    Note that if you'd like curly braces literally in the template, urlencode them first.
    
    Parameters:
    
    template - URI template that can be in level 1 RFC6570 form.
    
    variables - to the URI template
    
    Returns:
    
    expanded template, leaving any unresolved parameters literal
  - resolve
```
public RequestTemplate resolve(Map<String,?> unencoded)
```
    resolve(Map, Map), which assumes no parameter is encoded
  - request
```
public Request request()
```
  - method
```
public RequestTemplate method(String method)
```
  - method
```
public String method()
```
  - decodeSlash
```
public RequestTemplate decodeSlash(boolean decodeSlash)
```
  - decodeSlash
```
public boolean decodeSlash()
```
  - collectionFormat
```
public RequestTemplate collectionFormat(CollectionFormat collectionFormat)
```
  - collectionFormat
```
public CollectionFormat collectionFormat()
```
  - append
```
public RequestTemplate append(CharSequence value)
```
  - insert
```
public RequestTemplate insert(int pos,
                              CharSequence value)
```
  - url
```
public String url()
```
  - query
```
public RequestTemplate query(boolean encoded,
                             String name,
                             String... values)
```
    Replaces queries with the specified name with the values supplied.
    Values can be passed in decoded or in url-encoded form depending on the value of the encoded parameter.
    When the value is null, all queries with the configKey are removed.
    
    relationship to JAXRS 2.0
    
    Like WebTarget.query, except the values can be templatized.
    ex.
```
 template.query("Signature", "{signature}");
 
```
    Note: behavior of RequestTemplate is not consistent if a query parameter with unsafe characters is passed as both encoded and unencoded, although no validation is performed.
    ex.
```
 template.query(true, "param[]", "value");
 template.query(false, "param[]", "value");
 
```
    Parameters:
    
    encoded - whether name and values are already url-encoded
    
    name - the name of the query
    
    values - can be a single null to imply removing all values. Else no values are expected to be null.
    
    See Also:
    
    queries()
  - query
```
public RequestTemplate query(boolean encoded,
                             String name,
                             Iterable<String> values)
```
  - query
```
public RequestTemplate query(String name,
                             String... values)
```
    Shortcut for query(false, String, String...)
    
    See Also:
    
    query(boolean, String, String...)
  - query
```
public RequestTemplate query(String name,
                             Iterable<String> values)
```
    Shortcut for query(false, String, Iterable<String>)
    
    See Also:
    
    query(boolean, String, String...)
  - queries
```
public RequestTemplate queries(Map<String,Collection<String>> queries)
```
    Replaces all existing queries with the newly supplied url decoded queries.
    
    relationship to JAXRS 2.0
    
    Like WebTarget.queries, except the values can be templatized.
    ex.
```
 template.queries(ImmutableMultimap.of("Signature", "{signature}"));
 
```
    Parameters:
    
    queries - if null, remove all queries. else value to replace all queries with.
    
    See Also:
    
    queries()
  - queries
```
public Map<String,Collection<String>> queries()
```
    Returns an immutable copy of the url decoded queries.
    
    See Also:
    
    Request.url()
  - header
```
public RequestTemplate header(String name,
                              String... values)
```
    Replaces headers with the specified configKey with the values supplied.
    When the value is null, all headers with the configKey are removed.
    
    relationship to JAXRS 2.0
    
    Like WebTarget.queries and javax.ws.rs.client.Invocation.Builder.header, except the values can be templatized.
    ex.
```
 template.query("X-Application-Version", "{version}");
 
```
    Parameters:
    
    name - the name of the header
    
    values - can be a single null to imply removing all values. Else no values are expected to be null.
    
    See Also:
    
    headers()
  - header
```
public RequestTemplate header(String name,
                              Iterable<String> values)
```
  - headers
```
public RequestTemplate headers(Map<String,Collection<String>> headers)
```
    Replaces all existing headers with the newly supplied headers.
    
    relationship to JAXRS 2.0
    
    Like Invocation.Builder.headers(MultivaluedMap), except the values can be templatized.
    ex.
```
 template.headers(mapOf("X-Application-Version", asList("{version}")));
 
```
    Parameters:
    
    headers - if null, remove all headers. else value to replace all headers with.
    
    See Also:
    
    headers()
  - headers
```
public Map<String,Collection<String>> headers()
```
    Returns an immutable copy of the current headers.
    
    See Also:
    
    Request.headers()
  - body
```
public RequestTemplate body(byte[] bodyData,
                            Charset charset)
```
    replaces the Util.CONTENT_LENGTH header.
    Usually populated by an Encoder.
    
    See Also:
    
    Request.body()
  - body
```
public RequestTemplate body(String bodyText)
```
    replaces the Util.CONTENT_LENGTH header.
    Usually populated by an Encoder.
    
    See Also:
    
    Request.body()
  - charset
```
public Charset charset()
```
    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
```
public byte[] body()
```
    See Also:
    
    Request.body()
  - bodyTemplate
```
public RequestTemplate bodyTemplate(String bodyTemplate)
```
    populated by Body
    
    See Also:
    
    Request.body()
  - bodyTemplate
```
public String bodyTemplate()
```
    See Also:
    
    Request.body(), expand(String, Map)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - replaceQueryValues
```
public void replaceQueryValues(Map<String,?> unencoded)
```
    replaceQueryValues(Map, Map), which assumes no parameter is encoded
  - queryLine
```
public String queryLine()
```

Class RequestTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestTemplate

RequestTemplate

Method Detail

expand

resolve

request

method

method

decodeSlash

decodeSlash

collectionFormat

collectionFormat

append

insert

url

query

query

query

query

queries

queries

header

header

headers

headers

body

body

charset

body

bodyTemplate

bodyTemplate

toString

replaceQueryValues

queryLine