org.springframework.http.server.reactive

Class ServerHttpResponseDecorator

  • java.lang.Object
    • org.springframework.http.server.reactive.ServerHttpResponseDecorator
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addCookie(ResponseCookie cookie)
      Add the given ResponseCookie.
      void beforeCommit(java.util.function.Supplier<? extends reactor.core.publisher.Mono<java.lang.Void>> action)
      Register an action to apply just before the HttpOutputMessage is committed.
      DataBufferFactory bufferFactory()
      Return a DataBufferFactory that can be used to create the body.
      MultiValueMap<java.lang.String,ResponseCookie> getCookies()
      Return a mutable map with the cookies to send to the server.
      ServerHttpResponse getDelegate() 
      HttpHeaders getHeaders()
      Return the headers of this message.
      HttpStatus getStatusCode()
      Return the HTTP status code or null if not set.
      boolean isCommitted()
      Whether the HttpOutputMessage is committed.
      reactor.core.publisher.Mono<java.lang.Void> setComplete()
      Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).
      boolean setStatusCode(HttpStatus status)
      Set the HTTP status code of the response.
      java.lang.String toString() 
      reactor.core.publisher.Mono<java.lang.Void> writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body)
      Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.
      reactor.core.publisher.Mono<java.lang.Void> writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body)
      Use the given Publisher to write the body of the message to the underlying HTTP layer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ServerHttpResponseDecorator

        public ServerHttpResponseDecorator(ServerHttpResponse delegate)
    • Method Detail

      • setStatusCode

        public boolean setStatusCode(@Nullable
                                     HttpStatus status)
        Description copied from interface: ServerHttpResponse
        Set the HTTP status code of the response.
        Specified by:
        setStatusCode in interface ServerHttpResponse
        Parameters:
        status - the HTTP status as an HttpStatus enum value
        Returns:
        false if the status code has not been set because the HTTP response is already committed, true if it has been set correctly.
      • getHeaders

        public HttpHeaders getHeaders()
        Description copied from interface: HttpMessage
        Return the headers of this message.
        Specified by:
        getHeaders in interface HttpMessage
        Returns:
        a corresponding HttpHeaders object (never null)
      • beforeCommit

        public void beforeCommit(java.util.function.Supplier<? extends reactor.core.publisher.Mono<java.lang.Void>> action)
        Description copied from interface: ReactiveHttpOutputMessage
        Register an action to apply just before the HttpOutputMessage is committed.

        Note: the supplied action must be properly deferred, e.g. via Mono.defer(java.util.function.Supplier<? extends reactor.core.publisher.Mono<? extends T>>) or Mono.fromRunnable(java.lang.Runnable), to ensure it's executed in the right order, relative to other actions.

        Specified by:
        beforeCommit in interface ReactiveHttpOutputMessage
        Parameters:
        action - the action to apply
      • writeWith

        public reactor.core.publisher.Mono<java.lang.Void> writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body)
        Description copied from interface: ReactiveHttpOutputMessage
        Use the given Publisher to write the body of the message to the underlying HTTP layer.
        Specified by:
        writeWith in interface ReactiveHttpOutputMessage
        Parameters:
        body - the body content publisher
        Returns:
        a Mono that indicates completion or error
      • writeAndFlushWith

        public reactor.core.publisher.Mono<java.lang.Void> writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body)
        Description copied from interface: ReactiveHttpOutputMessage
        Use the given Publisher of Publishers to write the body of the HttpOutputMessage to the underlying HTTP layer, flushing after each Publisher<DataBuffer>.
        Specified by:
        writeAndFlushWith in interface ReactiveHttpOutputMessage
        Parameters:
        body - the body content publisher
        Returns:
        a Mono that indicates completion or error
      • setComplete

        public reactor.core.publisher.Mono<java.lang.Void> setComplete()
        Description copied from interface: ReactiveHttpOutputMessage
        Indicate that message handling is complete, allowing for any cleanup or end-of-processing tasks to be performed such as applying header changes made via HttpMessage.getHeaders() to the underlying HTTP message (if not applied already).

        This method should be automatically invoked at the end of message processing so typically applications should not have to invoke it. If invoked multiple times it should have no side effects.

        Specified by:
        setComplete in interface ReactiveHttpOutputMessage
        Returns:
        a Mono that indicates completion or error
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object