Package io.micronaut.http.netty

Interface NettyHttpResponseBuilder

All Known Implementing Classes:
NettyMutableHttpResponse
public interface NettyHttpResponseBuilder
Common interface for client and server to implement to construct the Netty versions of the response objects.
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isStream()
     
    @NonNull io.netty.handler.codec.http.FullHttpResponse
    toFullHttpResponse()
    Converts this object to a full http response.
    static @NonNull io.netty.handler.codec.http.FullHttpResponse
    toFullHttpResponse(io.micronaut.http.HttpResponse<?> response, @NonNull io.netty.buffer.ByteBuf byteBuf)
    Convert the given response to a full http response.
    default @NonNull io.netty.handler.codec.http.HttpResponse
    toHttpResponse()
    Converts this object to the most appropriate http response type.
    static @NonNull io.netty.handler.codec.http.HttpResponse
    toHttpResponse(io.micronaut.http.HttpResponse<?> response)
    Convert the given response to a full http response.
    default @NonNull StreamedHttpResponse
    toStreamHttpResponse()
    Converts this object to a streamed http response.
    static @NonNull StreamedHttpResponse
    toStreamResponse(io.micronaut.http.HttpResponse<?> response)
    Convert the given response to a full http response.

  • Method Details

    • toFullHttpResponse

      @NonNull @NonNull io.netty.handler.codec.http.FullHttpResponse toFullHttpResponse()
      Converts this object to a full http response.
      Returns:
      a full http response

    • toStreamHttpResponse

      @NonNull default @NonNull StreamedHttpResponse toStreamHttpResponse()
      Converts this object to a streamed http response.
      Returns:
      The streamed response

    • toHttpResponse

      @NonNull default @NonNull io.netty.handler.codec.http.HttpResponse toHttpResponse()
      Converts this object to the most appropriate http response type.
      Returns:
      The http response

    • isStream

      boolean isStream()
      Returns:
      Is the response a stream.

    • toHttpResponse

      @NonNull static @NonNull io.netty.handler.codec.http.HttpResponse toHttpResponse(@NonNull io.micronaut.http.HttpResponse<?> response)
      Convert the given response to a full http response.
      Parameters:
      response - The response
      Returns:
      The full response.

    • toFullHttpResponse

      @NonNull static @NonNull io.netty.handler.codec.http.FullHttpResponse toFullHttpResponse(@NonNull io.micronaut.http.HttpResponse<?> response, @NonNull @NonNull io.netty.buffer.ByteBuf byteBuf)
      Convert the given response to a full http response.
      Parameters:
      response - The response
      byteBuf - The byteBuf
      Returns:
      The full response.
      Since:
      4.3.0

    • toStreamResponse

      @NonNull static @NonNull StreamedHttpResponse toStreamResponse(@NonNull io.micronaut.http.HttpResponse<?> response)
      Convert the given response to a full http response.
      Parameters:
      response - The response
      Returns:
      The full response.