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

接口 EntityResponse.Builder<T>

类型参数:
T - the entity type
所有已知实现类:
DefaultEntityResponseBuilder
封闭接口:
EntityResponse<T>
public static interface EntityResponse.Builder<T>
Defines a builder for EntityResponse.

  • 方法详细资料

    • header

      EntityResponse.Builder<T> 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

      EntityResponse.Builder<T> 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

    • status

      EntityResponse.Builder<T> status(HttpStatusCode status)
      Set the HTTP status.
      参数:
      status - the response status
      返回:
      this builder

    • status

      EntityResponse.Builder<T> status(int status)
      Set the HTTP status.
      参数:
      status - the response status
      返回:
      this builder

    • cookie

      EntityResponse.Builder<T> cookie(HttpCookie cookie)
      Add the given cookie to the response.
      参数:
      cookie - the cookie to add
      返回:
      this builder

    • cookies

      EntityResponse.Builder<T> 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

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

    • allow

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

    • eTag

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

    • lastModified

      EntityResponse.Builder<T> lastModified(ZonedDateTime lastModified)
      Set the time the resource was last changed, as specified by the Last-Modified header.

      The date should be specified as the number of milliseconds since January 1, 1970 GMT.

      参数:
      lastModified - the last modified date
      返回:
      this builder
      另请参阅:

    • lastModified

      EntityResponse.Builder<T> lastModified(Instant lastModified)
      Set the time the resource was last changed, as specified by the Last-Modified header.

      The date should be specified as the number of milliseconds since January 1, 1970 GMT.

      参数:
      lastModified - the last modified date
      返回:
      this builder
      另请参阅:

    • location

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

    • cacheControl

      EntityResponse.Builder<T> 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

      EntityResponse.Builder<T> 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

    • contentLength

      EntityResponse.Builder<T> contentLength(long contentLength)
      Set the length of the body in bytes, as specified by the Content-Length header.
      参数:
      contentLength - the content length
      返回:
      this builder
      另请参阅:

    • contentType

      EntityResponse.Builder<T> contentType(MediaType contentType)
      Set the media type of the body, as specified by the Content-Type header.
      参数:
      contentType - the content type
      返回:
      this builder
      另请参阅:

    • build

      EntityResponse<T> build()
      Build the response.
      返回:
      the built response