Package org.springframework.http.server
Class DelegatingServerHttpResponse
java.lang.Object
org.springframework.http.server.DelegatingServerHttpResponse
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
,HttpMessage
,HttpOutputMessage
,ServerHttpResponse
Implementation of
ServerHttpResponse
that delegates all calls to a
given target ServerHttpResponse
.- Since:
- 5.3.2
- Author:
- Arjen Poutsma
-
Constructor Summary
ConstructorDescriptionCreate a newDelegatingServerHttpResponse
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close this response, freeing any resources created.void
flush()
Ensure that the headers and the content of the response are written out.getBody()
Return the body of the message as an output stream.Returns the target response that this response delegates to.Return the headers of this message.void
setStatusCode
(HttpStatusCode status) Set the HTTP status code of the response.
-
Constructor Details
-
DelegatingServerHttpResponse
Create a newDelegatingServerHttpResponse
.- Parameters:
delegate
- the response to delegate to
-
-
Method Details
-
getDelegate
Returns the target response that this response delegates to.- Returns:
- the delegate
-
setStatusCode
Description copied from interface:ServerHttpResponse
Set the HTTP status code of the response.- Specified by:
setStatusCode
in interfaceServerHttpResponse
- Parameters:
status
- the HTTP status as an HttpStatus enum value
-
flush
Description copied from interface:ServerHttpResponse
Ensure that the headers and the content of the response are written out.After the first flush, headers can no longer be changed. Only further content writing and content flushing is possible.
- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in interfaceServerHttpResponse
- Throws:
IOException
-
close
public void close()Description copied from interface:ServerHttpResponse
Close this response, freeing any resources created.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceServerHttpResponse
-
getBody
Description copied from interface:HttpOutputMessage
Return the body of the message as an output stream.- Specified by:
getBody
in interfaceHttpOutputMessage
- Returns:
- the output stream body (never
null
) - Throws:
IOException
- in case of I/O errors
-
getHeaders
Description copied from interface:HttpMessage
Return the headers of this message.- Specified by:
getHeaders
in interfaceHttpMessage
- Returns:
- a corresponding HttpHeaders object (never
null
)
-