Module io.inverno.mod.http.server
Package io.inverno.mod.http.server

Interface ResponseBody

All Known Subinterfaces:
WebResponseBody
public interface ResponseBody

Represents the payload body of a server response in a server exchange.

The response body basically provides multiple ways to produce the response payload.

Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Method Details

    • transform

      ResponseBody transform(Function<Publisher<ByteBuf>,Publisher<ByteBuf>> transformer) throws IllegalArgumentException

      Transforms the payload publisher.

      This can be used in an exchange interceptor in order to decorate response data publisher.

      Parameters:
      transformer - a request payload publisher transformer
      Returns:
      the response body
      Throws:
      IllegalArgumentException - if data were already sent to the client

    • before

      default ResponseBody before(Mono<Void> before)

      Transforms the payload publisher to subscribe to the specified publisher before subscribing to the payload publisher.

      This basically allows to perform actions before the response is actually sent.

      Parameters:
      before - the publisher to subscribe before the response body publisher
      Returns:
      the response body

    • after

      default ResponseBody after(Mono<Void> after)

      Transforms the payload publisher to subscribe to the specified publisher after payload publisher completion.

      This basically allows to perform actions after the response body has been sent.

      Parameters:
      after - the publisher to subscribe before the response body publisher
      Returns:
      the response body

    • empty

      void empty()

      Produces an empty payload.

      If a payload has already been provided this method does nothing.

      A typical usage is: 

      
 exchange.response().body().empty();

    • raw

      OutboundData<ByteBuf> raw()

      Returns a raw payload producer.

      A typical usage is: 

      
 exchange.response().body().raw().stream(
     Flux.just(
         Unpooled.unreleasableBuffer(Unpooled.copiedBuffer("Hello ", Charsets.DEFAULT)), 
         Unpooled.unreleasableBuffer(Unpooled.copiedBuffer("World!", Charsets.DEFAULT))
     )
 );
      Returns:
      a raw payload producer

    • string

      <T extends CharSequence> OutboundData<T> string()

      Returns a string payload producer.

      A typical usage is: 

      
 exchange.response().body().string().stream(
     Flux.just(
         Unpooled.unreleasableBuffer("Hello "), 
         Unpooled.unreleasableBuffer("World!")
     )
 );
      Type Parameters:
      T - the type of char sequence
      Returns:
      a string payload producer

    • resource

      ResponseBody.Resource resource()

      Returns a resource payload producer.

      A typical usage is: 

      
 ResourceService resourceService = ... 
 exchange.response().body().resource().value(resourceService.get("file:/path/to/resource");
      Returns:
      a resource payload producer

    • sse

      ResponseBody.Sse<ByteBuf,ResponseBody.Sse.Event<ByteBuf>,ResponseBody.Sse.EventFactory<ByteBuf,ResponseBody.Sse.Event<ByteBuf>>> sse()

      Returns a server-sent events payload producer as defined by Server-Sent Events.

      A typical usage is: 

      
 exchange.response().body().sse().from(
     (events, data) -> Flux.interval(Duration.ofSeconds(1))
         .map(seq -> events.create(event -> event
                 .id(Long.toString(seq))
                 .event("seq")
                 .value(Unpooled.unreleasableBuffer(Unpooled.copiedBuffer("Event #" + seq, Charsets.DEFAULT)))
             )
         )
 );
      Returns:
      a server-sent events payload producer

    • sseString

      <T extends CharSequence> ResponseBody.Sse<T,ResponseBody.Sse.Event<T>,ResponseBody.Sse.EventFactory<T,ResponseBody.Sse.Event<T>>> sseString()

      Returns a server-sent events payload producer as defined by Server-Sent Events.

      A typical usage is: 

      
 exchange.response().body().sseString().from(
     (events, data) -> Flux.interval(Duration.ofSeconds(1))
         .map(seq -> events.create(event -> event
                 .id(Long.toString(seq))
                 .event("seq")
                 .value("Event #" + seq, Charsets.DEFAULT))
             )
         )
 );
      Type Parameters:
      T - The type of char sequence
      Returns:
      a server-sent events payload producer