程序包 cn.taketoday.web.handler.function

类 DefaultServerResponseBuilder

java.lang.Object

cn.taketoday.web.handler.function.DefaultServerResponseBuilder

所有已实现的接口:

ServerResponse.BodyBuilder, ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

class DefaultServerResponseBuilder
extends Object
implements ServerResponse.BodyBuilder

Default ServerResponse.BodyBuilder implementation.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	DefaultServerResponseBuilder.WriteFunctionResponse

从接口继承的嵌套类/接口 cn.taketoday.web.handler.function.ServerResponse.HeadersBuilder

ServerResponse.HeadersBuilder.WriteFunction

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.util.MultiValueMap<String,HttpCookie>	cookies
private final HttpHeaders	headers
private final HttpStatusCode	statusCode

构造器概要

构造器

构造器	说明
DefaultServerResponseBuilder(HttpStatusCode status)
DefaultServerResponseBuilder(ServerResponse other)

方法概要

修饰符和类型	方法	说明
ServerResponse.BodyBuilder	allow(HttpMethod... allowedMethods)	Set the set of allowed HTTP methods, as specified by the Allow header.
ServerResponse.BodyBuilder	allow(Set<HttpMethod> allowedMethods)	Set the set of allowed HTTP methods, as specified by the Allow header.
ServerResponse	body(Object body)	Set the body of the response to the given Object and return it.
<T> ServerResponse	body(T body, cn.taketoday.core.ParameterizedTypeReference<T> bodyType)	Set the body of the response to the given Object and return it.
ServerResponse	build()	Build the response entity with no body.
ServerResponse	build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)	Build the response entity with a custom write function.
ServerResponse.BodyBuilder	cacheControl(CacheControl cacheControl)	Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.
ServerResponse.BodyBuilder	contentLength(long contentLength)	Set the length of the body in bytes, as specified by the Content-Length header.
ServerResponse.BodyBuilder	contentType(MediaType contentType)	Set the media type of the body, as specified by the Content-Type header.
ServerResponse.BodyBuilder	cookie(HttpCookie cookie)	Add the given cookie to the response.
ServerResponse.BodyBuilder	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)	Manipulate this response's cookies with the given consumer.
ServerResponse.BodyBuilder	eTag(String etag)	Set the entity tag of the body, as specified by the ETag header.
ServerResponse.BodyBuilder	header(String headerName, String... headerValues)	Add the given header value(s) under the given name.
ServerResponse.BodyBuilder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this response's headers with the given consumer.
ServerResponse.BodyBuilder	lastModified(Instant lastModified)	Set the time the resource was last changed, as specified by the Last-Modified header.
ServerResponse.BodyBuilder	lastModified(ZonedDateTime lastModified)	Set the time the resource was last changed, as specified by the Last-Modified header.
ServerResponse.BodyBuilder	location(URI location)	Set the location of a resource, as specified by the Location header.
ServerResponse	render(ModelAndView modelAndView)	Render the template with the given ModelAndView.
ServerResponse	render(String name, Object... modelAttributes)	Render the template with the given name using the given modelAttributes.
ServerResponse	render(String name, Map<String,?> model)	Render the template with the given name using the given model.
ServerResponse.BodyBuilder	varyBy(String... requestHeaders)	Configure one or more request header names (e.g.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

statusCode

private final HttpStatusCode statusCode

headers

private final HttpHeaders headers

cookies

private final cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies

构造器详细资料

DefaultServerResponseBuilder

public DefaultServerResponseBuilder(ServerResponse other)

DefaultServerResponseBuilder

public DefaultServerResponseBuilder(HttpStatusCode status)

方法详细资料

header

public ServerResponse.BodyBuilder header(String headerName,
 String... headerValues)

从接口复制的说明: ServerResponse.HeadersBuilder

Add the given header value(s) under the given name.

指定者:

header 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public ServerResponse.BodyBuilder headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: ServerResponse.HeadersBuilder

Manipulate this response's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

指定者:

headers 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

cookie

public ServerResponse.BodyBuilder cookie(HttpCookie cookie)

从接口复制的说明: ServerResponse.HeadersBuilder

Add the given cookie to the response.

指定者:

cookie 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

cookie - the cookie to add

返回:

this builder

cookies

public ServerResponse.BodyBuilder cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)

从接口复制的说明: ServerResponse.HeadersBuilder

Manipulate this response's cookies with the given consumer. The cookies provided to the consumer are "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

指定者:

cookies 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

cookiesConsumer - a function that consumes the cookies

返回:

this builder

allow

public ServerResponse.BodyBuilder allow(HttpMethod... allowedMethods)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the set of allowed HTTP methods, as specified by the Allow header.

指定者:

allow 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

allowedMethods - the allowed methods

返回:

this builder

另请参阅:

• HttpHeaders.setAllow(Collection)

allow

public ServerResponse.BodyBuilder allow(Set<HttpMethod> allowedMethods)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the set of allowed HTTP methods, as specified by the Allow header.

指定者:

allow 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

allowedMethods - the allowed methods

返回:

this builder

另请参阅:

• HttpHeaders.setAllow(Collection)

contentLength

public ServerResponse.BodyBuilder contentLength(long contentLength)

从接口复制的说明: ServerResponse.BodyBuilder

Set the length of the body in bytes, as specified by the Content-Length header.

指定者:

contentLength 在接口中 ServerResponse.BodyBuilder

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

contentType

public ServerResponse.BodyBuilder contentType(MediaType contentType)

从接口复制的说明: ServerResponse.BodyBuilder

Set the media type of the body, as specified by the Content-Type header.

指定者:

contentType 在接口中 ServerResponse.BodyBuilder

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

eTag

public ServerResponse.BodyBuilder eTag(String etag)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the entity tag of the body, as specified by the ETag header.

指定者:

eTag 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

etag - the new entity tag

返回:

this builder

另请参阅:

• HttpHeaders.setETag(String)

lastModified

public ServerResponse.BodyBuilder lastModified(ZonedDateTime lastModified)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the time the resource was last changed, as specified by the Last-Modified header.

指定者:

lastModified 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

lastModified - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(long)

lastModified

public ServerResponse.BodyBuilder lastModified(Instant lastModified)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the time the resource was last changed, as specified by the Last-Modified header.

指定者:

lastModified 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

lastModified - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(long)

location

public ServerResponse.BodyBuilder location(URI location)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the location of a resource, as specified by the Location header.

指定者:

location 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

location - the location

返回:

this builder

另请参阅:

• HttpHeaders.setLocation(URI)

cacheControl

public ServerResponse.BodyBuilder cacheControl(CacheControl cacheControl)

从接口复制的说明: ServerResponse.HeadersBuilder

Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.

A CacheControl instance can be built like CacheControl.maxAge(3600).cachePublic().noTransform().

指定者:

cacheControl 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

cacheControl - a builder for cache-related HTTP response headers

返回:

this builder

另请参阅:

• RFC-7234 Section 5.2

varyBy

public ServerResponse.BodyBuilder varyBy(String... requestHeaders)

从接口复制的说明: ServerResponse.HeadersBuilder

Configure one or more request header names (e.g. "Accept-Language") to add to the "Vary" response header to inform clients that the response is subject to content negotiation and variances based on the value of the given request headers. The configured request header names are added only if not already present in the response "Vary" header.

指定者:

varyBy 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

requestHeaders - request header names

返回:

this builder

build

public ServerResponse build()

从接口复制的说明: ServerResponse.HeadersBuilder

Build the response entity with no body.

指定者:

build 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

build

public ServerResponse build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)

从接口复制的说明: ServerResponse.HeadersBuilder

Build the response entity with a custom write function.

指定者:

build 在接口中 ServerResponse.HeadersBuilder<ServerResponse.BodyBuilder>

参数:

writeFunction - the function used to write to the HttpServletResponse

body

public ServerResponse body(Object body)

从接口复制的说明: ServerResponse.BodyBuilder

Set the body of the response to the given Object and return it.

Asynchronous response bodies are supported by providing a CompletionStage or Publisher as body (or any asynchronous producer of a single entity that can be adapted via the ReactiveAdapterRegistry).

指定者:

body 在接口中 ServerResponse.BodyBuilder

参数:

body - the body of the response

返回:

the built response

body

public <T> ServerResponse body(T body,
 cn.taketoday.core.ParameterizedTypeReference<T> bodyType)

从接口复制的说明: ServerResponse.BodyBuilder

Set the body of the response to the given Object and return it. The parameter bodyType is used to capture the generic type.

指定者:

body 在接口中 ServerResponse.BodyBuilder

参数:

body - the body of the response

bodyType - the type of the body, used to capture the generic type

返回:

the built response

render

public ServerResponse render(String name,
 Object... modelAttributes)

从接口复制的说明: ServerResponse.BodyBuilder

Render the template with the given name using the given modelAttributes. The model attributes are mapped under a generated name.

Note: Empty Collections are not added to the model when using this method because we cannot correctly determine the true convention name.

指定者:

render 在接口中 ServerResponse.BodyBuilder

参数:

name - the name of the template to be rendered

modelAttributes - the modelAttributes used to render the template

返回:

the built response

render

public ServerResponse render(String name,
 Map<String,?> model)

从接口复制的说明: ServerResponse.BodyBuilder

Render the template with the given name using the given model.

指定者:

render 在接口中 ServerResponse.BodyBuilder

参数:

name - the name of the template to be rendered

model - the model used to render the template

返回:

the built response

render

public ServerResponse render(ModelAndView modelAndView)

从接口复制的说明: ServerResponse.BodyBuilder

Render the template with the given ModelAndView.

指定者:

render 在接口中 ServerResponse.BodyBuilder

参数:

modelAndView - the model and view used to render the template

返回:

the built response