RequestTemplate (Feign Core 10.7.4 API)

java.lang.Object
- feign.RequestTemplate

All Implemented Interfaces:

Serializable
```
public final class RequestTemplate
extends Object
implements Serializable
```
Request Builder for an HTTP Target.
This class is a variation on a UriTemplate, where, in addition to the uri, Headers and Query information also support template expressions.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

RequestTemplate()
Create a new Request Template.

RequestTemplate(RequestTemplate toCopy)
Deprecated.
replaced by from(RequestTemplate)

Constructors
Constructor and Description
`RequestTemplate()` Create a new Request Template.
`RequestTemplate(RequestTemplate toCopy)` Deprecated. replaced by `from(RequestTemplate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RequestTemplate`	`append(CharSequence value)` Deprecated. see `uri(String, boolean)`
`byte[]`	`body()` The Request Body.
`RequestTemplate`	`body(byte[] data, Charset charset)` Sets the Body and Charset for this request.
`RequestTemplate`	`body(Request.Body body)` Deprecated. use `body(byte[], Charset)` instead.
`RequestTemplate`	`body(String bodyText)` Set the Body for this request.
`String`	`bodyTemplate()` Body Template to resolve.
`RequestTemplate`	`bodyTemplate(String bodyTemplate)` Specify the Body Template to use.
`RequestTemplate`	`bodyTemplate(String bodyTemplate, Charset charset)` Specify the Body Template to use.
`CollectionFormat`	`collectionFormat()` The Collection Format that will be used when resolving `Iterable` and `Collection` variables.
`RequestTemplate`	`collectionFormat(CollectionFormat collectionFormat)` The Collection Format to use when resolving variables that represent `Iterable`s or `Collection`s
`boolean`	`decodeSlash()` If slash / characters are not encoded when resolving.
`RequestTemplate`	`decodeSlash(boolean decodeSlash)` Set whether do encode slash / characters when resolving this template.
`Target<?>`	`feignTarget()`
`RequestTemplate`	`feignTarget(Target<?> feignTarget)`
`static RequestTemplate`	`from(RequestTemplate requestTemplate)` Create a Request Template from an existing Request Template.
`Collection<String>`	`getRequestVariables()` Retrieve all uri, header, and query template variables.
`boolean`	`hasRequestVariable(String variable)` Return if the variable exists on the uri, query, or headers, in this template.
`RequestTemplate`	`header(String name, Iterable<String> values)` Specify a Header, with the specified values.
`RequestTemplate`	`header(String name, String... values)`
`Map<String,Collection<String>>`	`headers()` Returns an immutable copy of the Headers for this request.
`RequestTemplate`	`headers(Map<String,Collection<String>> headers)` Headers for this Request.
`RequestTemplate`	`insert(int pos, CharSequence value)` Deprecated. see `target(String)`
`String`	`method()` The Request Http Method.
`RequestTemplate`	`method(Request.HttpMethod method)` Set the Http Method.
`RequestTemplate`	`method(String method)` Deprecated. see `RequestTemplate#method(HttpMethod)`
`MethodMetadata`	`methodMetadata()`
`RequestTemplate`	`methodMetadata(MethodMetadata methodMetadata)`
`String`	`path()` The Uri Path.
`Map<String,Collection<String>>`	`queries()` Return an immutable Map of all Query Parameters and their values.
`RequestTemplate`	`queries(Map<String,Collection<String>> queries)` Sets the Query Parameters.
`RequestTemplate`	`query(String name, Iterable<String> values)` Specify a Query String parameter, with the specified values.
`RequestTemplate`	`query(String name, Iterable<String> values, CollectionFormat collectionFormat)` Specify a Query String parameter, with the specified values.
`RequestTemplate`	`query(String name, String... values)`
`String`	`queryLine()` The Query String for the template.
`RequestTemplate`	`removeHeader(String name)` Clear on reader from `RequestTemplate`
`Request`	`request()` Creates a `Request` from this template.
`Request.Body`	`requestBody()` Deprecated. this abstraction is leaky and will be removed in later releases.
`Charset`	`requestCharset()` Charset of the Request Body, if known.
`RequestTemplate`	`resolve(Map<String,?> variables)` Resolve all expressions using the variable value substitutions provided.
`boolean`	`resolved()` If this template has been resolved.
`RequestTemplate`	`target(String target)` Set the target host for this request.
`String`	`toString()`
`RequestTemplate`	`uri(String uri)` Set the Uri for the request, replacing the existing uri if set.
`RequestTemplate`	`uri(String uri, boolean append)` Set the uri for the request.
`String`	`url()` The URL for the request.
`List<String>`	`variables()` List all of the template variable expressions for this template.

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

- Constructor Detail
  - RequestTemplate
```
public RequestTemplate()
```
    Create a new Request Template.
  - RequestTemplate
```
@Deprecated
public RequestTemplate(RequestTemplate toCopy)
```
    Deprecated. replaced by from(RequestTemplate)
    
    Create a Request Template from an existing Request Template.
    
    Parameters:
    
    toCopy - template.
- Method Detail
  - from
```
public static RequestTemplate from(RequestTemplate requestTemplate)
```
    Create a Request Template from an existing Request Template.
    
    Parameters:
    
    requestTemplate - to copy from.
    
    Returns:
    
    a new Request Template.
  - resolve
```
public RequestTemplate resolve(Map<String,?> variables)
```
    Resolve all expressions using the variable value substitutions provided. Variable values will be pct-encoded, if they are not already.
    
    Parameters:
    
    variables - containing the variable values to use when resolving expressions.
    
    Returns:
    
    a new Request Template with all of the variables resolved.
  - request
```
public Request request()
```
    Creates a Request from this template. The template must be resolved before calling this method, or an IllegalStateException will be thrown.
    
    Returns:
    
    a new Request instance.
    
    Throws:
    
    IllegalStateException - if this template has not been resolved.
  - method
```
@Deprecated
public RequestTemplate method(String method)
```
    Deprecated. see RequestTemplate#method(HttpMethod)
    
    Set the Http Method.
    
    Parameters:
    
    method - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - method
```
public RequestTemplate method(Request.HttpMethod method)
```
    Set the Http Method.
    
    Parameters:
    
    method - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - method
```
public String method()
```
    The Request Http Method.
    
    Returns:
    
    Http Method.
  - decodeSlash
```
public RequestTemplate decodeSlash(boolean decodeSlash)
```
    Set whether do encode slash / characters when resolving this template.
    
    Parameters:
    
    decodeSlash - if slash literals should not be encoded.
    
    Returns:
    
    a RequestTemplate for chaining.
  - decodeSlash
```
public boolean decodeSlash()
```
    If slash / characters are not encoded when resolving.
    
    Returns:
    
    true if slash literals are not encoded, false otherwise.
  - collectionFormat
```
public RequestTemplate collectionFormat(CollectionFormat collectionFormat)
```
    The Collection Format to use when resolving variables that represent Iterables or Collections
    
    Parameters:
    
    collectionFormat - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - collectionFormat
```
public CollectionFormat collectionFormat()
```
    The Collection Format that will be used when resolving Iterable and Collection variables.
    
    Returns:
    
    the collection format set
  - append
```
@Deprecated
public RequestTemplate append(CharSequence value)
```
    Deprecated. see uri(String, boolean)
    
    Append the value to the template.
    This method is poorly named and is used primarily to store the relative uri for the request. It has been replaced by uri(String) and will be removed in a future release.
    
    Parameters:
    
    value - to append.
    
    Returns:
    
    a RequestTemplate for chaining.
  - insert
```
@Deprecated
public RequestTemplate insert(int pos,
                                          CharSequence value)
```
    Deprecated. see target(String)
    
    Insert the value at the specified point in the template uri.
    This method is poorly named has undocumented behavior. When the value contains a fully qualified http request url, the value is always inserted at the beginning of the uri.
    
    Due to this, use of this method is not recommended and remains for backward compatibility. It has been replaced by target(String) and will be removed in a future release.
    
    Parameters:
    
    pos - in the uri to place the value.
    
    value - to insert.
    
    Returns:
    
    a RequestTemplate for chaining.
  - uri
```
public RequestTemplate uri(String uri)
```
    Set the Uri for the request, replacing the existing uri if set.
    
    Parameters:
    
    uri - to use, must be a relative uri.
    
    Returns:
    
    a RequestTemplate for chaining.
  - uri
```
public RequestTemplate uri(String uri,
                           boolean append)
```
    Set the uri for the request.
    
    Parameters:
    
    uri - to use, must be a relative uri.
    
    append - if the uri should be appended, if the uri is already set.
    
    Returns:
    
    a RequestTemplate for chaining.
  - target
```
public RequestTemplate target(String target)
```
    Set the target host for this request.
    
    Parameters:
    
    target - host for this request. Must be an absolute target.
    
    Returns:
    
    a RequestTemplate for chaining.
  - url
```
public String url()
```
    The URL for the request. If the template has not been resolved, the url will represent a uri template.
    
    Returns:
    
    the url
  - path
```
public String path()
```
    The Uri Path.
    
    Returns:
    
    the uri path.
  - variables
```
public List<String> variables()
```
    List all of the template variable expressions for this template.
    
    Returns:
    
    a list of template variable names
  - query
```
public RequestTemplate query(String name,
                             String... values)
```
    See Also:
    
    query(String, Iterable)
  - query
```
public RequestTemplate query(String name,
                             Iterable<String> values)
```
    Specify a Query String parameter, with the specified values. Values can be literals or template expressions.
    
    Parameters:
    
    name - of the parameter.
    
    values - for this parameter.
    
    Returns:
    
    a RequestTemplate for chaining.
  - query
```
public RequestTemplate query(String name,
                             Iterable<String> values,
                             CollectionFormat collectionFormat)
```
    Specify a Query String parameter, with the specified values. Values can be literals or template expressions.
    
    Parameters:
    
    name - of the parameter.
    
    values - for this parameter.
    
    collectionFormat - to use when resolving collection based expressions.
    
    Returns:
    
    a Request Template for chaining.
  - queries
```
public RequestTemplate queries(Map<String,Collection<String>> queries)
```
    Sets the Query Parameters.
    
    Parameters:
    
    queries - to use for this request.
    
    Returns:
    
    a RequestTemplate for chaining.
  - queries
```
public Map<String,Collection<String>> queries()
```
    Return an immutable Map of all Query Parameters and their values.
    
    Returns:
    
    registered Query Parameters.
  - header
```
public RequestTemplate header(String name,
                              String... values)
```
    See Also:
    
    header(String, Iterable)
  - header
```
public RequestTemplate header(String name,
                              Iterable<String> values)
```
    Specify a Header, with the specified values. Values can be literals or template expressions.
    
    Parameters:
    
    name - of the header.
    
    values - for this header.
    
    Returns:
    
    a RequestTemplate for chaining.
  - removeHeader
```
public RequestTemplate removeHeader(String name)
```
    Clear on reader from RequestTemplate
    
    Parameters:
    
    name - of the header.
    
    Returns:
    
    a RequestTemplate for chaining.
  - headers
```
public RequestTemplate headers(Map<String,Collection<String>> headers)
```
    Headers for this Request.
    
    Parameters:
    
    headers - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - headers
```
public Map<String,Collection<String>> headers()
```
    Returns an immutable copy of the Headers for this request.
    
    Returns:
    
    the currently applied headers.
  - body
```
public RequestTemplate body(byte[] data,
                            Charset charset)
```
    Sets the Body and Charset for this request.
    
    Parameters:
    
    data - to send, can be null.
    
    charset - of the encoded data.
    
    Returns:
    
    a RequestTemplate for chaining.
  - body
```
public RequestTemplate body(String bodyText)
```
    Set the Body for this request. Charset is assumed to be UTF_8. Data must be encoded.
    
    Parameters:
    
    bodyText - to send.
    
    Returns:
    
    a RequestTemplate for chaining.
  - body
```
@Deprecated
public RequestTemplate body(Request.Body body)
```
    Deprecated. use body(byte[], Charset) instead.
    
    Set the Body for this request.
    
    Parameters:
    
    body - to send.
    
    Returns:
    
    a RequestTemplate for chaining.
  - requestCharset
```
public Charset requestCharset()
```
    Charset of the Request Body, if known.
    
    Returns:
    
    the currently applied Charset.
  - body
```
public byte[] body()
```
    The Request Body.
    
    Returns:
    
    the request body.
  - requestBody
```
@Deprecated
public Request.Body requestBody()
```
    Deprecated. this abstraction is leaky and will be removed in later releases.
    
    The Request.Body internal object.
    
    Returns:
    
    the internal Request.Body.
  - bodyTemplate
```
public RequestTemplate bodyTemplate(String bodyTemplate)
```
    Specify the Body Template to use. Can contain literals and expressions.
    
    Parameters:
    
    bodyTemplate - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - bodyTemplate
```
public RequestTemplate bodyTemplate(String bodyTemplate,
                                    Charset charset)
```
    Specify the Body Template to use. Can contain literals and expressions.
    
    Parameters:
    
    bodyTemplate - to use.
    
    Returns:
    
    a RequestTemplate for chaining.
  - bodyTemplate
```
public String bodyTemplate()
```
    Body Template to resolve.
    
    Returns:
    
    the unresolved body template.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hasRequestVariable
```
public boolean hasRequestVariable(String variable)
```
    Return if the variable exists on the uri, query, or headers, in this template.
    
    Parameters:
    
    variable - to look for.
    
    Returns:
    
    true if the variable exists, false otherwise.
  - getRequestVariables
```
public Collection<String> getRequestVariables()
```
    Retrieve all uri, header, and query template variables.
    
    Returns:
    
    a List of all the variable names.
  - resolved
```
public boolean resolved()
```
    If this template has been resolved.
    
    Returns:
    
    true if the template has been resolved, false otherwise.
  - queryLine
```
public String queryLine()
```
    The Query String for the template. Expressions are not resolved.
    
    Returns:
    
    the Query String.
  - methodMetadata
```
@Experimental
public RequestTemplate methodMetadata(MethodMetadata methodMetadata)
```
  - feignTarget
```
@Experimental
public RequestTemplate feignTarget(Target<?> feignTarget)
```
  - methodMetadata
```
@Experimental
public MethodMetadata methodMetadata()
```
  - feignTarget
```
@Experimental
public Target<?> feignTarget()
```

Class RequestTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestTemplate

RequestTemplate

Method Detail

from

resolve

request

method

method

method

decodeSlash

decodeSlash

collectionFormat

collectionFormat

append

insert

uri

uri

target

url

path

variables

query

query

query

queries

queries

header

header

removeHeader

headers

headers

body

body

body

requestCharset

body

requestBody

bodyTemplate

bodyTemplate

bodyTemplate

toString

hasRequestVariable

getRequestVariables

resolved

queryLine

methodMetadata

feignTarget

methodMetadata

feignTarget