AbstractServerHttpResponse

java.lang.Object
- org.springframework.http.server.reactive.AbstractServerHttpResponse

All Implemented Interfaces:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse

Direct Known Subclasses:

AbstractListenerServerHttpResponse, MockServerHttpResponse, ReactorServerHttpResponse, RxNettyServerHttpResponse
```
public abstract class AbstractServerHttpResponse
extends java.lang.Object
implements ServerHttpResponse
```
Base class for ServerHttpResponse implementations.

Since:

5.0

Author:

Rossen Stoyanchev, Sebastien Deleuze

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`AbstractServerHttpResponse.State` COMMITTING -> COMMITTED is the period after doCommit is called but before the response status and headers have been applied to the underlying response during which time pre-commit actions can still make changes to the response status and headers.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<java.util.function.Supplier<? extends <any>>>`	`commitActions`
`private MultiValueMap<java.lang.String,ResponseCookie>`	`cookies`
`private DataBufferFactory`	`dataBufferFactory`
`private HttpHeaders`	`headers`
`private Log`	`logger`
`private java.util.concurrent.atomic.AtomicReference<AbstractServerHttpResponse.State>`	`state`
`private HttpStatus`	`statusCode`
`private java.util.function.Function<java.lang.String,java.lang.String>`	`urlEncoder`

Constructor Summary

Constructors
Constructor and Description

AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)

Constructors
Constructor and Description
`AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`applyCookies()` Implement this method to add cookies from `getHeaders()` to the underlying response.
`protected abstract void`	`applyHeaders()` Implement this method to apply header changes from `getHeaders()` to the underlying response.
`protected abstract void`	`applyStatusCode()` Implement this method to write the status code to the underlying response.
`void`	`beforeCommit(java.util.function.Supplier<? extends <any>> action)` Register an action to apply just before the HttpOutputMessage is committed.
`DataBufferFactory`	`bufferFactory()` Return a `DataBufferFactory` that can be used to create the body.
`protected <any>`	`doCommit()` A variant of `doCommit(Supplier)` for a response without no body.
`protected <any>`	`doCommit(java.util.function.Supplier<? extends <any>> writeAction)` Apply `beforeCommit` actions, apply the response status and headers/cookies, and write the response body.
`java.lang.String`	`encodeUrl(java.lang.String url)` A mechanism for URL rewriting that applications and libraries such as HTML template libraries to use consistently for all URLs emitted by the application.
`MultiValueMap<java.lang.String,ResponseCookie>`	`getCookies()` Return a mutable map with the cookies to send to the server.
`HttpHeaders`	`getHeaders()` Return the headers of this message.
`HttpStatus`	`getStatusCode()` Return the HTTP status code or `null` if not set.
`boolean`	`isCommitted()` Whether the HttpOutputMessage is committed.
`void`	`registerUrlEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder)` Register a URL rewriting function for use with `ServerHttpResponse.encodeUrl(java.lang.String)`.
`<any>`	`setComplete()` Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via `HttpMessage.getHeaders()` to the underlying HTTP message (if not applied already).
`boolean`	`setStatusCode(HttpStatus statusCode)` Set the HTTP status code of the response.
`<any>`	`writeAndFlushWith(<any> body)` Use the given `Publisher` of `Publishers` to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each `Publisher<DataBuffer>`.
`protected abstract <any>`	`writeAndFlushWithInternal(<any> body)` Implement this method to write to the underlying the response, and flush after each `Publisher<DataBuffer>`.
`<any>`	`writeWith(<any> body)` Use the given `Publisher` to write the body of the message to the underlying HTTP layer.
`protected abstract <any>`	`writeWithInternal(<any> body)` Implement this method to write to the underlying the response.

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

- Field Detail
  - logger
```
private final Log logger
```
  - dataBufferFactory
```
private final DataBufferFactory dataBufferFactory
```
  - statusCode
```
private HttpStatus statusCode
```
  - headers
```
private final HttpHeaders headers
```
  - cookies
```
private final MultiValueMap<java.lang.String,ResponseCookie> cookies
```
  - urlEncoder
```
private java.util.function.Function<java.lang.String,java.lang.String> urlEncoder
```
  - state
```
private final java.util.concurrent.atomic.AtomicReference<AbstractServerHttpResponse.State> state
```
  - commitActions
```
private final java.util.List<java.util.function.Supplier<? extends <any>>> commitActions
```
- Constructor Detail
  - AbstractServerHttpResponse
```
public AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)
```
- Method Detail
  - bufferFactory
```
public final DataBufferFactory bufferFactory()
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Return a DataBufferFactory that can be used to create the body.
    
    Specified by:
    
    bufferFactory in interface ReactiveHttpOutputMessage
    
    Returns:
    
    a buffer factory
    
    See Also:
    
    #writeWith(Publisher)
  - setStatusCode
```
public boolean setStatusCode(HttpStatus statusCode)
```
    Description copied from interface: ServerHttpResponse
    
    Set the HTTP status code of the response.
    
    Specified by:
    
    setStatusCode in interface ServerHttpResponse
    
    Parameters:
    
    statusCode - the HTTP status as an HttpStatus enum value
    
    Returns:
    
    false if the status code has not been set because the HTTP response is already committed, true if it has been set correctly.
  - getStatusCode
```
public HttpStatus getStatusCode()
```
    Description copied from interface: ServerHttpResponse
    
    Return the HTTP status code or null if not set.
    
    Specified by:
    
    getStatusCode in interface ServerHttpResponse
  - getHeaders
```
public HttpHeaders getHeaders()
```
    Description copied from interface: HttpMessage
    
    Return the headers of this message.
    
    Specified by:
    
    getHeaders in interface HttpMessage
    
    Returns:
    
    a corresponding HttpHeaders object (never null)
  - getCookies
```
public MultiValueMap<java.lang.String,ResponseCookie> getCookies()
```
    Description copied from interface: ServerHttpResponse
    
    Return a mutable map with the cookies to send to the server.
    
    Specified by:
    
    getCookies in interface ServerHttpResponse
  - encodeUrl
```
public java.lang.String encodeUrl(java.lang.String url)
```
    Description copied from interface: ServerHttpResponse
    
    A mechanism for URL rewriting that applications and libraries such as HTML template libraries to use consistently for all URLs emitted by the application. Doing so enables the registration of URL encoders via ServerHttpResponse.registerUrlEncoder(java.util.function.Function<java.lang.String, java.lang.String>) that can insert an id for authentication, a nonce for CSRF protection, a version for a static resource, etc.
    
    Specified by:
    
    encodeUrl in interface ServerHttpResponse
    
    Parameters:
    
    url - the URL to encode
    
    Returns:
    
    the encoded URL or the same
  - registerUrlEncoder
```
public void registerUrlEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder)
```
    Description copied from interface: ServerHttpResponse
    
    Register a URL rewriting function for use with ServerHttpResponse.encodeUrl(java.lang.String). The function must return an encoded URL or the same URL.
    
    Specified by:
    
    registerUrlEncoder in interface ServerHttpResponse
    
    Parameters:
    
    encoder - a URL encoding function to use
  - beforeCommit
```
public void beforeCommit(java.util.function.Supplier<? extends <any>> action)
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Register an action to apply just before the HttpOutputMessage is committed.
    
    Specified by:
    
    beforeCommit in interface ReactiveHttpOutputMessage
    
    Parameters:
    
    action - the action to apply
  - isCommitted
```
public boolean isCommitted()
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Whether the HttpOutputMessage is committed.
    
    Specified by:
    
    isCommitted in interface ReactiveHttpOutputMessage
  - writeWith
```
public final <any> writeWith(<any> body)
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Use the given Publisher to write the body of the message to the underlying HTTP layer.
    
    Specified by:
    
    writeWith in interface ReactiveHttpOutputMessage
    
    Parameters:
    
    body - the body content publisher
    
    Returns:
    
    a Mono that indicates completion or error
  - writeAndFlushWith
```
public final <any> writeAndFlushWith(<any> body)
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.
    
    Specified by:
    
    writeAndFlushWith in interface ReactiveHttpOutputMessage
    
    Parameters:
    
    body - the body content publisher
    
    Returns:
    
    a Mono that indicates completion or error
  - setComplete
```
public <any> setComplete()
```
    Description copied from interface: ReactiveHttpOutputMessage
    
    Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).
    This method should be automatically invoked at the end of message processing so typically applications should not have to invoke it. If invoked multiple times it should have no side effects.
    
    Specified by:
    
    setComplete in interface ReactiveHttpOutputMessage
    
    Returns:
    
    a Mono that indicates completion or error
  - doCommit
```
protected <any> doCommit()
```
    A variant of doCommit(Supplier) for a response without no body.
    
    Returns:
    
    a completion publisher
  - doCommit
```
protected <any> doCommit(java.util.function.Supplier<? extends <any>> writeAction)
```
    Apply beforeCommit actions, apply the response status and headers/cookies, and write the response body.
    
    Parameters:
    
    writeAction - the action to write the response body or null
    
    Returns:
    
    a completion publisher
  - writeWithInternal
```
protected abstract <any> writeWithInternal(<any> body)
```
    Implement this method to write to the underlying the response.
    
    Parameters:
    
    body - the publisher to write with
  - writeAndFlushWithInternal
```
protected abstract <any> writeAndFlushWithInternal(<any> body)
```
    Implement this method to write to the underlying the response, and flush after each Publisher<DataBuffer>.
    
    Parameters:
    
    body - the publisher to write and flush with
  - applyStatusCode
```
protected abstract void applyStatusCode()
```
    Implement this method to write the status code to the underlying response. This method is called once only.
  - applyHeaders
```
protected abstract void applyHeaders()
```
    Implement this method to apply header changes from getHeaders() to the underlying response. This method is called once only.
  - applyCookies
```
protected abstract void applyCookies()
```
    Implement this method to add cookies from getHeaders() to the underlying response. This method is called once only.

Class AbstractServerHttpResponse

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

dataBufferFactory

statusCode

headers

cookies

urlEncoder

state

commitActions

Constructor Detail

AbstractServerHttpResponse

Method Detail

bufferFactory

setStatusCode

getStatusCode

getHeaders

getCookies

encodeUrl

registerUrlEncoder

beforeCommit

isCommitted

writeWith

writeAndFlushWith

setComplete

doCommit

doCommit

writeWithInternal

writeAndFlushWithInternal

applyStatusCode

applyHeaders

applyCookies