MutableHttpRequest (micronaut 3.4.0 API)

Type Parameters:

B - The request body type

All Superinterfaces:

AttributeHolder, HttpMessage, HttpRequest, MutableAttributeHolder, MutableHttpMessage

All Known Implementing Classes:

SimpleHttpRequest
```
public interface MutableHttpRequest
extends HttpRequest, MutableHttpMessage
```
An extended version of HttpRequest that allows mutating headers, the body etc.

Since:

1.0

Author:

Graeme Rocher

Field Summary
- Fields inherited from interface io.micronaut.http.HttpRequest
  SCHEME_HTTP, SCHEME_HTTPS

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default MutableHttpRequest<B>`	`accept(CharSequence... mediaTypes)` Sets the acceptable `MediaType` instances via the `HttpHeaders.ACCEPT` header.
`default MutableHttpRequest<B>`	`accept(MediaType... mediaTypes)` Sets the acceptable `MediaType` instances via the `HttpHeaders.ACCEPT` header.
`default MutableHttpRequest<B>`	`basicAuth(CharSequence username, CharSequence password)` Set an `HttpHeaders.AUTHORIZATION` header, with value: "Basic Base64(username:password)".
`default MutableHttpRequest<B>`	`bearerAuth(CharSequence token)` Set an `HttpHeaders.AUTHORIZATION` header, with value: "Bearer token".
`<T> MutableHttpRequest<T>`	`body(T body)` Sets the body.
`default MutableHttpRequest<B>`	`contentEncoding(CharSequence encoding)` Sets the content encoding.
`default MutableHttpRequest<B>`	`contentLength(long length)` Sets the content length.
`default MutableHttpRequest<B>`	`contentType(CharSequence contentType)` Set the response content type.
`default MutableHttpRequest<B>`	`contentType(MediaType mediaType)` Set the response content type.
`MutableHttpRequest<B>`	`cookie(Cookie cookie)` Sets the specified cookie on the request.
`default MutableHttpRequest<B>`	`cookies(Set<Cookie> cookies)` Sets the specified cookies on the request.
`MutableHttpHeaders`	`getHeaders()`
`MutableHttpParameters`	`getParameters()`
`default MutableHttpRequest<B>`	`header(CharSequence name, CharSequence value)` Set a response header.
`default MutableHttpRequest<B>`	`headers(Consumer<MutableHttpHeaders> headers)` Mutate the headers with the given consumer.
`default MutableHttpRequest<B>`	`headers(Map<CharSequence,CharSequence> namesAndValues)` Set multiple headers.
`default MutableHttpRequest<B>`	`uri(Consumer<UriBuilder> consumer)` Alters the URI of the request with the given URI builder.
`MutableHttpRequest<B>`	`uri(URI uri)` Sets the uri on the request.

Methods inherited from interface io.micronaut.http.HttpRequest
accept, create, create, DELETE, DELETE, DELETE, GET, GET, getCertificate, getCookies, getHttpVersion, getLocale, getMethod, getMethodName, getPath, getRemoteAddress, getServerAddress, getServerName, getUri, getUserPrincipal, getUserPrincipal, HEAD, HEAD, isSecure, mutate, OPTIONS, OPTIONS, PATCH, PATCH, POST, POST, PUT, PUT, setAttribute

Methods inherited from interface io.micronaut.http.HttpMessage
getAttributes, getBody, getBody, getBody, getCharacterEncoding, getContentLength, getContentType

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder
removeAttribute

Methods inherited from interface io.micronaut.core.attr.AttributeHolder
getAttribute, getAttribute

- Method Detail
 - cookie
```
MutableHttpRequest cookie(Cookie cookie)
```
 Sets the specified cookie on the request.
 
 Parameters:
 
 cookie - the Cookie to return to the client
 
 Returns:
 
 The http request
 - cookies
```
default MutableHttpRequest cookies(Set<Cookie> cookies)
```
 Sets the specified cookies on the request.
 
 Parameters:
 
 cookies - the Cookies to return to the client
 
 Returns:
 
 The http request
 - uri
```
MutableHttpRequest uri(URI uri)
```
 Sets the uri on the request.
 
 Parameters:
 
 uri - The uri to call
 
 Returns:
 
 The http request
 - body
```
<T> MutableHttpRequest<T> body(T body)
```
 Description copied from interface: MutableHttpMessage
 
 Sets the body.
 
 Specified by:
 
 body in interface MutableHttpMessage
 
 Type Parameters:
 
 T - The new body type
 
 Parameters:
 
 body - The body
 
 Returns:
 
 This message
 - getHeaders
```
MutableHttpHeaders getHeaders()
```
 Specified by:
 
 getHeaders in interface HttpMessage
 
 Specified by:
 
 getHeaders in interface MutableHttpMessage
 
 Returns:
 
 The HttpHeaders object
 - getParameters
```
MutableHttpParameters getParameters()
```
 Specified by:
 
 getParameters in interface HttpRequest
 
 Returns:
 
 The HTTP parameters contained with the URI query string
 - uri
```
@NonNull
default MutableHttpRequest uri(@NonNull
 Consumer<UriBuilder> consumer)
```
 Alters the URI of the request with the given URI builder.
 
 Parameters:
 
 consumer - A consumer that accepts the URI
 
 Returns:
 
 The modified request
 - accept
```
default MutableHttpRequest accept(MediaType... mediaTypes)
```
 Sets the acceptable MediaType instances via the HttpHeaders.ACCEPT header.
 
 Parameters:
 
 mediaTypes - The media types
 
 Returns:
 
 This request
 - accept
```
default MutableHttpRequest accept(CharSequence... mediaTypes)
```
 Sets the acceptable MediaType instances via the HttpHeaders.ACCEPT header.
 
 Parameters:
 
 mediaTypes - The media types
 
 Returns:
 
 This request
 - headers
```
default MutableHttpRequest headers(Consumer<MutableHttpHeaders> headers)
```
 Description copied from interface: MutableHttpMessage
 
 Mutate the headers with the given consumer.
 
 Specified by:
 
 headers in interface MutableHttpMessage
 
 Parameters:
 
 headers - The headers
 
 Returns:
 
 This response
 - header
```
default MutableHttpRequest header(CharSequence name,
 CharSequence value)
```
 Description copied from interface: MutableHttpMessage
 
 Set a response header.
 
 Specified by:
 
 header in interface MutableHttpMessage
 
 Parameters:
 
 name - The name of the header
 
 value - The value of the header
 
 Returns:
 
 This response
 - basicAuth
```
default MutableHttpRequest basicAuth(CharSequence username,
 CharSequence password)
```
 Description copied from interface: MutableHttpMessage
 
 Set an HttpHeaders.AUTHORIZATION header, with value: "Basic Base64(username:password)".
 
 Specified by:
 
 basicAuth in interface MutableHttpMessage
 
 Parameters:
 
 username - The username part of the credentials
 
 password - The password part of the credentials
 
 Returns:
 
 This response
 - bearerAuth
```
default MutableHttpRequest bearerAuth(CharSequence token)
```
 Description copied from interface: MutableHttpMessage
 
 Set an HttpHeaders.AUTHORIZATION header, with value: "Bearer token".
 
 Specified by:
 
 bearerAuth in interface MutableHttpMessage
 
 Parameters:
 
 token - The token
 
 Returns:
 
 This response
 - headers
```
default MutableHttpRequest headers(Map<CharSequence,CharSequence> namesAndValues)
```
 Description copied from interface: MutableHttpMessage
 
 Set multiple headers.
 
 Specified by:
 
 headers in interface MutableHttpMessage
 
 Parameters:
 
 namesAndValues - The names and values
 
 Returns:
 
 This response
 - contentLength
```
default MutableHttpRequest contentLength(long length)
```
 Description copied from interface: MutableHttpMessage
 
 Sets the content length.
 
 Specified by:
 
 contentLength in interface MutableHttpMessage
 
 Parameters:
 
 length - The length
 
 Returns:
 
 This response
 - contentType
```
default MutableHttpRequest contentType(CharSequence contentType)
```
 Description copied from interface: MutableHttpMessage
 
 Set the response content type.
 
 Specified by:
 
 contentType in interface MutableHttpMessage
 
 Parameters:
 
 contentType - The content type
 
 Returns:
 
 This response
 - contentType
```
default MutableHttpRequest contentType(MediaType mediaType)
```
 Description copied from interface: MutableHttpMessage
 
 Set the response content type.
 
 Specified by:
 
 contentType in interface MutableHttpMessage
 
 Parameters:
 
 mediaType - The media type
 
 Returns:
 
 This response
 - contentEncoding
```
default MutableHttpRequest contentEncoding(CharSequence encoding)
```
 Description copied from interface: MutableHttpMessage
 
 Sets the content encoding.
 
 Specified by:
 
 contentEncoding in interface MutableHttpMessage
 
 Parameters:
 
 encoding - The encoding to use
 
 Returns:
 
 This message

Interface MutableHttpRequest<B>

Field Summary

Fields inherited from interface io.micronaut.http.HttpRequest

Method Summary

Methods inherited from interface io.micronaut.http.HttpRequest

Methods inherited from interface io.micronaut.http.HttpMessage

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

Method Detail

cookie

cookies

uri

body

getHeaders

getParameters

uri

accept

accept

headers

header

basicAuth

bearerAuth

headers

contentLength

contentType

contentType

contentEncoding