org.springframework.web.reactive.function.server

Interface ServerRequest.Builder

  • Enclosing interface:
    ServerRequest


    public static interface ServerRequest.Builder
    Defines a builder for a request.
    Since:
    5.1
    • Method Detail

      • uri

        ServerRequest.Builder uri(java.net.URI uri)
        Set the URI of the request.
        Parameters:
        uri - the new URI
        Returns:
        this builder
      • header

        ServerRequest.Builder header(java.lang.String headerName,
                                     java.lang.String... headerValues)
        Add the given header value(s) under the given name.
        Parameters:
        headerName - the header name
        headerValues - the header value(s)
        Returns:
        this builder
        See Also:
        HttpHeaders.add(String, String)
      • headers

        ServerRequest.Builder headers(java.util.function.Consumer<HttpHeaders> headersConsumer)
        Manipulate this request'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.

        Parameters:
        headersConsumer - a function that consumes the HttpHeaders
        Returns:
        this builder
      • cookie

        ServerRequest.Builder cookie(java.lang.String name,
                                     java.lang.String... values)
        Add a cookie with the given name and value(s).
        Parameters:
        name - the cookie name
        values - the cookie value(s)
        Returns:
        this builder
      • cookies

        ServerRequest.Builder cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,HttpCookie>> cookiesConsumer)
        Manipulate this request's cookies with the given consumer.

        The map provided to the consumer is "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

        Parameters:
        cookiesConsumer - a function that consumes the cookies map
        Returns:
        this builder
      • body

        ServerRequest.Builder body(reactor.core.publisher.Flux<DataBuffer> body)
        Set the body of the request.

        Calling this methods will release the existing body of the builder.

        Parameters:
        body - the new body
        Returns:
        this builder
      • body

        ServerRequest.Builder body(java.lang.String body)
        Set the body of the request to the UTF-8 encoded bytes of the given string.

        Calling this methods will release the existing body of the builder.

        Parameters:
        body - the new body
        Returns:
        this builder
      • attribute

        ServerRequest.Builder attribute(java.lang.String name,
                                        java.lang.Object value)
        Add an attribute with the given name and value.
        Parameters:
        name - the attribute name
        value - the attribute value
        Returns:
        this builder
      • attributes

        ServerRequest.Builder attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)
        Manipulate this request's attributes with the given consumer.

        The map provided to the consumer is "live", so that the consumer can be used to overwrite existing attributes, remove attributes, or use any of the other Map methods.

        Parameters:
        attributesConsumer - a function that consumes the attributes map
        Returns:
        this builder
      • build

        ServerRequest build()
        Build the request.
        Returns:
        the built request