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

接口 ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>

类型参数:
B - the builder subclass
所有已知子接口:
ServerResponse.BodyBuilder
所有已知实现类:
DefaultServerResponseBuilder
封闭接口:
ServerResponse
public static interface ServerResponse.HeadersBuilder<B extends ServerResponse.HeadersBuilder<B>>
Defines a builder that adds headers to the response.

  • 方法详细资料

    • header

      B header(String headerName, String... headerValues)
      Add the given header value(s) under the given name.
      参数:
      headerName - the header name
      headerValues - the header value(s)
      返回:
      this builder
      另请参阅:

    • headers

      B headers(Consumer<HttpHeaders> headersConsumer)
      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.
      参数:
      headersConsumer - a function that consumes the HttpHeaders
      返回:
      this builder

    • cookie

      B cookie(HttpCookie cookie)
      Add the given cookie to the response.
      参数:
      cookie - the cookie to add
      返回:
      this builder

    • cookies

      B cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)
      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.
      参数:
      cookiesConsumer - a function that consumes the cookies
      返回:
      this builder

    • allow

      B allow(HttpMethod... allowedMethods)
      Set the set of allowed HTTP methods, as specified by the Allow header.
      参数:
      allowedMethods - the allowed methods
      返回:
      this builder
      另请参阅:

    • allow

      B allow(Set<HttpMethod> allowedMethods)
      Set the set of allowed HTTP methods, as specified by the Allow header.
      参数:
      allowedMethods - the allowed methods
      返回:
      this builder
      另请参阅:

    • eTag

      B eTag(String eTag)
      Set the entity tag of the body, as specified by the ETag header.
      参数:
      eTag - the new entity tag
      返回:
      this builder
      另请参阅:

    • lastModified

      B lastModified(ZonedDateTime lastModified)
      Set the time the resource was last changed, as specified by the Last-Modified header.
      参数:
      lastModified - the last modified date
      返回:
      this builder
      另请参阅:

    • lastModified

      B lastModified(Instant lastModified)
      Set the time the resource was last changed, as specified by the Last-Modified header.
      参数:
      lastModified - the last modified date
      返回:
      this builder
      另请参阅:

    • location

      B location(URI location)
      Set the location of a resource, as specified by the Location header.
      参数:
      location - the location
      返回:
      this builder
      另请参阅:

    • cacheControl

      B cacheControl(CacheControl cacheControl)
      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 - a builder for cache-related HTTP response headers
      返回:
      this builder
      另请参阅:

    • varyBy

      B varyBy(String... requestHeaders)
      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.
      参数:
      requestHeaders - request header names
      返回:
      this builder

    • build

      ServerResponse build()
      Build the response entity with no body.

    • build

      ServerResponse build(ServerResponse.HeadersBuilder.WriteFunction writeFunction)
      Build the response entity with a custom write function.
      参数:
      writeFunction - the function used to write to the HttpServletResponse