Modifier and Type	Class and Description
private class	ServletServerHttpResponse.ServletResponseHttpHeaders Extends HttpHeaders with the ability to look up headers already present in the underlying HttpServletResponse.

Modifier and Type	Field and Description
private boolean	bodyUsed
private final HttpHeaders	headers
private boolean	headersWritten
private HttpHeaders	readOnlyHeaders
private final HttpServletResponse	servletResponse

Access	Constructor and Description
public	ServletServerHttpResponse(HttpServletResponse the servlet response servletResponse) Construct a new instance of the ServletServerHttpResponse based on the given `HttpServletResponse`.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.springframework.http.server.ServerHttpResponse.close. Close this response, freeing any resources created.
public void	flush() Implements org.springframework.http.server.ServerHttpResponse.flush. Ensure that the headers and the content of the response are written out.
public OutputStream	getBody() Implements org.springframework.http.HttpOutputMessage.getBody. Return the body of the message as an output stream.
public HttpHeaders	getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Return the headers of this message.
public HttpServletResponse	getServletResponse() Return the `HttpServletResponse` this object is based on.
public void	setStatusCode(HttpStatusCode the HTTP status as an HttpStatus enum value status) Implements org.springframework.http.server.ServerHttpResponse.setStatusCode. Set the HTTP status code of the response.
private void	writeHeaders()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bodyUsed	back to summary
private boolean bodyUsed

headers	back to summary
private final HttpHeaders headers

headersWritten	back to summary
private boolean headersWritten

readOnlyHeaders	back to summary
private HttpHeaders readOnlyHeaders Annotations @Nullable

servletResponse	back to summary
private final HttpServletResponse servletResponse

ServletServerHttpResponse	back to summary
public ServletServerHttpResponse(HttpServletResponse servletResponse) Construct a new instance of the ServletServerHttpResponse based on the given `HttpServletResponse`. Parameters servletResponse:HttpServletResponse the servlet response

Method Detail

close	back to summary
public void close() Implements org.springframework.http.server.ServerHttpResponse.close. Doc from org.springframework.http.server.ServerHttpResponse.close. Close this response, freeing any resources created. Annotations @Override

back to summary

public void close()

Implements org.springframework.http.server.ServerHttpResponse.close.

Doc from org.springframework.http.server.ServerHttpResponse.close.

Close this response, freeing any resources created.

Annotations

@Override

flush	back to summary
public void flush() throws IOException Implements org.springframework.http.server.ServerHttpResponse.flush. Doc from org.springframework.http.server.ServerHttpResponse.flush. 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. Annotations @Override Exceptions IOException: Doc from java.io.Flushable.flush. If an I/O error occurs

flush

back to summary

public void flush() throws IOException

Implements org.springframework.http.server.ServerHttpResponse.flush.

Doc from org.springframework.http.server.ServerHttpResponse.flush.

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.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Flushable.flush.

If an I/O error occurs

getBody back to summary

getBody	back to summary
public OutputStream getBody() throws IOException Implements org.springframework.http.HttpOutputMessage.getBody. Doc from org.springframework.http.HttpOutputMessage.getBody. Return the body of the message as an output stream. Returns:OutputStream the output stream body (never `null`) Annotations @Override Exceptions IOException: in case of I/O errors

public OutputStream getBody() throws IOException

Implements org.springframework.http.HttpOutputMessage.getBody.

Doc from org.springframework.http.HttpOutputMessage.getBody.

Return the body of the message as an output stream.

Returns:OutputStream

the output stream body (never null)

Annotations

@Override

Exceptions

IOException:: in case of I/O errors

getHeaders back to summary

getHeaders	back to summary
public HttpHeaders getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Doc from org.springframework.http.HttpMessage.getHeaders. Return the headers of this message. Returns:HttpHeaders a corresponding HttpHeaders object (never `null`) Annotations @Override

public HttpHeaders getHeaders()

Implements org.springframework.http.HttpMessage.getHeaders.

Doc from org.springframework.http.HttpMessage.getHeaders.

Return the headers of this message.

Returns:HttpHeaders

a corresponding HttpHeaders object (never null)

Annotations

@Override

getServletResponse	back to summary
public HttpServletResponse getServletResponse() Return the `HttpServletResponse` this object is based on.

setStatusCode	back to summary
public void setStatusCode(HttpStatusCode status) Implements org.springframework.http.server.ServerHttpResponse.setStatusCode. Doc from org.springframework.http.server.ServerHttpResponse.setStatusCode. Set the HTTP status code of the response. Parameters status:HttpStatusCode the HTTP status as an HttpStatus enum value Annotations @Override

setStatusCode

back to summary

public void setStatusCode(HttpStatusCode status)

Implements org.springframework.http.server.ServerHttpResponse.setStatusCode.

Doc from org.springframework.http.server.ServerHttpResponse.setStatusCode.

Set the HTTP status code of the response.

Parameters

status:HttpStatusCode: the HTTP status as an HttpStatus enum value

Annotations

@Override

writeHeaders	back to summary
private void writeHeaders()

org.springframework.http.server back to summary

private Class ServletServerHttpResponse.ServletResponseHttpHeaders

Class Inheritance

extends HttpHeaders

java.lang.Object
org.springframework.http.HttpHeaders
org.springframework.http.server.ServletServerHttpResponse.ServletResponseHttpHeaders

Extends HttpHeaders with the ability to look up headers already present in the underlying HttpServletResponse.

The intent is merely to expose what is available through the HttpServletResponse i.e. the ability to look up specific header values by name. All other map-related operations (e.g. iteration, removal, etc) apply only to values added directly through HttpHeaders methods.

Since: 4.0.3

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.springframework.http.HttpHeaders.serialVersionUID.

Constructor Summary

Access	Constructor and Description
private	ServletResponseHttpHeaders()

Method Summary

Modifier and Type	Method and Description
public boolean	containsKey(Object key whose presence in this map is to be tested key) Overrides org.springframework.http.HttpHeaders.containsKey. Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public List<String>	get(Object the key whose associated value is to be returned key) Overrides org.springframework.http.HttpHeaders.get. Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public String	getFirst(String the header name headerName) Overrides org.springframework.http.HttpHeaders.getFirst. Implements org.springframework.util.MultiValueMap.getFirst. Return the first header value for the given header name, if any.

Inherited from org.springframework.http.HttpHeaders:: add addAll addAll clear clearContentHeaders containsValue encodeBasicAuth entrySet equals forEach formatHeaders getAccept getAcceptCharset getAcceptLanguage getAcceptLanguageAsLocales getAcceptPatch getAccessControlAllowCredentials getAccessControlAllowHeaders getAccessControlAllowMethods getAccessControlAllowOrigin getAccessControlExposeHeaders getAccessControlMaxAge getAccessControlRequestHeaders getAccessControlRequestMethod getAllow getCacheControl getConnection getContentDisposition getContentLanguage getContentLength getContentType getDate getETag getETagValuesAsList getExpires getFieldValues getFirstDate getFirstZonedDateTime getHost getIfMatch getIfModifiedSince getIfNoneMatch getIfUnmodifiedSince getLastModified getLocation getOrEmpty getOrigin getPragma getRange getUpgrade getValuesAsList getVary hashCode isEmpty keySet put putAll putIfAbsent readOnlyHttpHeaders readOnlyHttpHeaders remove set setAccept setAcceptCharset setAcceptLanguage setAcceptLanguageAsLocales setAcceptPatch setAccessControlAllowCredentials setAccessControlAllowHeaders setAccessControlAllowMethods setAccessControlAllowOrigin setAccessControlExposeHeaders setAccessControlMaxAge setAccessControlMaxAge setAccessControlRequestHeaders setAccessControlRequestMethod setAll setAllow setBasicAuth setBasicAuth setBasicAuth setBearerAuth setCacheControl setCacheControl setConnection setConnection setContentDisposition setContentDispositionFormData setContentLanguage setContentLength setContentType setDate setDate setDate setDate setETag setExpires setExpires setExpires setHost setIfMatch setIfMatch setIfModifiedSince setIfModifiedSince setIfModifiedSince setIfNoneMatch setIfNoneMatch setIfUnmodifiedSince setIfUnmodifiedSince setIfUnmodifiedSince setInstant setLastModified setLastModified setLastModified setLocation setOrigin setPragma setRange setUpgrade setVary setZonedDateTime size toCommaDelimitedString toSingleValueMap toString values writableHttpHeaders

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.springframework.http.HttpHeaders.serialVersionUID.

Constructor Detail

ServletResponseHttpHeaders	back to summary
private ServletResponseHttpHeaders()

Method Detail

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides org.springframework.http.HttpHeaders.containsKey. Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(Object key)

Overrides org.springframework.http.HttpHeaders.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

get back to summary

get	back to summary
public List<String> get(Object key) Overrides org.springframework.http.HttpHeaders.get. Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:List<String> the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public List<String> get(Object key)

Overrides org.springframework.http.HttpHeaders.get.

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:List<String>

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

getFirst back to summary

getFirst	back to summary
public String getFirst(String headerName) Overrides org.springframework.http.HttpHeaders.getFirst. Implements org.springframework.util.MultiValueMap.getFirst. Doc from org.springframework.http.HttpHeaders.getFirst. Return the first header value for the given header name, if any. Parameters headerName:String the header name Returns:String the first header value, or `null` if none Annotations @Override @Nullable

public String getFirst(String headerName)

Overrides org.springframework.http.HttpHeaders.getFirst.

Implements org.springframework.util.MultiValueMap.getFirst.

Doc from org.springframework.http.HttpHeaders.getFirst.

Return the first header value for the given header name, if any.

Parameters

headerName:String: the header name

Returns:String

the first header value, or null if none

Annotations

@Override
@Nullable

public Class ServletServerHttpResponse

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ServletServerHttpResponse.ServletResponseHttpHeaders

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail