Package io.micronaut.http.netty

Class NettyMutableHttpResponse<B>

java.lang.Object
io.micronaut.http.netty.NettyMutableHttpResponse<B>
Type Parameters:
B - The response body
All Implemented Interfaces:
io.micronaut.core.attr.AttributeHolder, io.micronaut.core.attr.MutableAttributeHolder, io.micronaut.http.HttpMessage<B>, io.micronaut.http.HttpResponse<B>, io.micronaut.http.MutableHttpMessage<B>, io.micronaut.http.MutableHttpResponse<B>, NettyHttpResponseBuilder
@Internal public final class NettyMutableHttpResponse<B> extends Object implements io.micronaut.http.MutableHttpResponse<B>, NettyHttpResponseBuilder
Delegates to Netty's FullHttpResponse.
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    NettyMutableHttpResponse(io.micronaut.core.convert.ConversionService conversionService)
     
    NettyMutableHttpResponse(io.netty.handler.codec.http.FullHttpResponse nettyResponse, io.micronaut.core.convert.ConversionService conversionService)
     
    NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.micronaut.core.convert.ConversionService conversionService)
    Creates a new instance.
    NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.netty.handler.codec.http.HttpHeaders nettyHeaders, Object body, io.micronaut.core.convert.ConversionService conversionService)
    Creates a new instance.
    NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, Object body, io.micronaut.core.convert.ConversionService conversionService)
    Creates a new instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> io.micronaut.http.MutableHttpResponse<T>
    body(T body)
     
    io.micronaut.http.MutableHttpMessage<B>
    bodyWriter(io.micronaut.http.body.MessageBodyWriter<B> messageBodyWriter)
     
    int
    code()
     
    io.micronaut.http.MutableHttpResponse<B>
    contentType(io.micronaut.http.MediaType mediaType)
     
    io.micronaut.http.MutableHttpResponse<B>
    cookie(io.micronaut.http.cookie.Cookie cookie)
     
    io.micronaut.http.MutableHttpResponse<B>
    cookies(Set<io.micronaut.http.cookie.Cookie> cookies)
     
    io.micronaut.core.convert.value.MutableConvertibleValues<Object>
    getAttributes()
     
    Optional<B>
    getBody()
     
    <T> Optional<T>
    getBody(io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)
     
    <T1> Optional<T1>
    getBody(Class<T1> type)
     
    Optional<io.micronaut.http.body.MessageBodyWriter<B>>
    getBodyWriter()
     
    Optional<io.micronaut.http.cookie.Cookie>
    getCookie(String name)
     
    io.micronaut.http.cookie.Cookies
    getCookies()
     
    io.micronaut.http.MutableHttpHeaders
    getHeaders()
     
    io.netty.handler.codec.http.HttpHeaders
    getNettyHeaders()
    The netty headers.
    io.netty.handler.codec.http.HttpResponseStatus
    getNettyHttpStatus()
    The netty http response status.
    io.netty.handler.codec.http.HttpVersion
    getNettyHttpVersion()
    The netty http version.
    boolean
    isStream()
     
    String
    reason()
     
    io.micronaut.http.HttpResponse<B>
    setAttribute(CharSequence name, Object value)
     
    io.micronaut.http.MutableHttpResponse<B>
    status(int status, CharSequence message)
     
    @NonNull io.netty.handler.codec.http.FullHttpResponse
    toFullHttpResponse()
    Converts this object to a full http response.
    @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
    toNoBodyResponse(io.micronaut.http.HttpResponse<?> response)
    Create a non-body netty response from the given MN response.
    @NonNull StreamedHttpResponse
    toStreamHttpResponse()
    Converts this object to a streamed http response.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.micronaut.core.attr.AttributeHolder

    getAttribute, getAttribute

    Methods inherited from interface io.micronaut.http.HttpMessage

    getBody, getCharacterEncoding, getContentLength, getContentType, getLocale

    Methods inherited from interface io.micronaut.http.HttpResponse

    body, getStatus, header, status

    Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

    removeAttribute

    Methods inherited from interface io.micronaut.http.MutableHttpMessage

    basicAuth, bearerAuth

    Methods inherited from interface io.micronaut.http.MutableHttpResponse

    attribute, characterEncoding, characterEncoding, contentEncoding, contentLength, contentType, header, headers, headers, locale, status, status, status, toMutableResponse

  • Constructor Details

    • NettyMutableHttpResponse

      public NettyMutableHttpResponse(io.netty.handler.codec.http.FullHttpResponse nettyResponse, io.micronaut.core.convert.ConversionService conversionService)
      Parameters:
      nettyResponse - The FullHttpResponse
      conversionService - The conversion service

    • NettyMutableHttpResponse

      public NettyMutableHttpResponse(io.micronaut.core.convert.ConversionService conversionService)
      Parameters:
      conversionService - The conversion service

    • NettyMutableHttpResponse

      public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.micronaut.core.convert.ConversionService conversionService)
      Creates a new instance.
      Parameters:
      httpVersion - The http version
      httpResponseStatus - THe http response status
      conversionService - The conversion service

    • NettyMutableHttpResponse

      public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, Object body, io.micronaut.core.convert.ConversionService conversionService)
      Creates a new instance.
      Parameters:
      httpVersion - The http version
      httpResponseStatus - THe http response status
      body - The body
      conversionService - The conversion service

    • NettyMutableHttpResponse

      public NettyMutableHttpResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpResponseStatus httpResponseStatus, io.netty.handler.codec.http.HttpHeaders nettyHeaders, Object body, io.micronaut.core.convert.ConversionService conversionService)
      Creates a new instance.
      Parameters:
      httpVersion - The http version
      httpResponseStatus - THe http response status
      nettyHeaders - The http headers
      body - The body
      conversionService - The conversion service

  • Method Details

    • toNoBodyResponse

      @NonNull public static @NonNull io.netty.handler.codec.http.HttpResponse toNoBodyResponse(@NonNull io.micronaut.http.HttpResponse<?> response)
      Create a non-body netty response from the given MN response.
      Parameters:
      response - The mn response
      Returns:
      The netty response

    • getBodyWriter

      public Optional<io.micronaut.http.body.MessageBodyWriter<B>> getBodyWriter()
      Specified by:
      getBodyWriter in interface io.micronaut.http.HttpMessage<B>

    • bodyWriter

      public io.micronaut.http.MutableHttpMessage<B> bodyWriter(io.micronaut.http.body.MessageBodyWriter<B> messageBodyWriter)
      Specified by:
      bodyWriter in interface io.micronaut.http.MutableHttpMessage<B>

    • getNettyHttpVersion

      public io.netty.handler.codec.http.HttpVersion getNettyHttpVersion()
      The netty http version.
      Returns:
      http version

    • getNettyHttpStatus

      public io.netty.handler.codec.http.HttpResponseStatus getNettyHttpStatus()
      The netty http response status.
      Returns:
      http response status

    • getNettyHeaders

      public io.netty.handler.codec.http.HttpHeaders getNettyHeaders()
      The netty headers.
      Returns:
      netty headers

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getHeaders

      public io.micronaut.http.MutableHttpHeaders getHeaders()
      Specified by:
      getHeaders in interface io.micronaut.http.HttpMessage<B>
      Specified by:
      getHeaders in interface io.micronaut.http.MutableHttpMessage<B>

    • getAttributes

      public io.micronaut.core.convert.value.MutableConvertibleValues<Object> getAttributes()
      Specified by:
      getAttributes in interface io.micronaut.core.attr.AttributeHolder
      Specified by:
      getAttributes in interface io.micronaut.http.HttpMessage<B>
      Specified by:
      getAttributes in interface io.micronaut.core.attr.MutableAttributeHolder

    • setAttribute

      public io.micronaut.http.HttpResponse<B> setAttribute(CharSequence name, Object value)
      Specified by:
      setAttribute in interface io.micronaut.http.HttpMessage<B>
      Specified by:
      setAttribute in interface io.micronaut.http.HttpResponse<B>
      Specified by:
      setAttribute in interface io.micronaut.core.attr.MutableAttributeHolder

    • code

      public int code()
      Specified by:
      code in interface io.micronaut.http.HttpResponse<B>

    • reason

      public String reason()
      Specified by:
      reason in interface io.micronaut.http.HttpResponse<B>

    • cookie

      public io.micronaut.http.MutableHttpResponse<B> cookie(io.micronaut.http.cookie.Cookie cookie)
      Specified by:
      cookie in interface io.micronaut.http.MutableHttpResponse<B>

    • cookies

      public io.micronaut.http.MutableHttpResponse<B> cookies(Set<io.micronaut.http.cookie.Cookie> cookies)
      Specified by:
      cookies in interface io.micronaut.http.MutableHttpResponse<B>

    • getCookies

      public io.micronaut.http.cookie.Cookies getCookies()
      Specified by:
      getCookies in interface io.micronaut.http.HttpResponse<B>

    • getCookie

      public Optional<io.micronaut.http.cookie.Cookie> getCookie(String name)
      Specified by:
      getCookie in interface io.micronaut.http.HttpResponse<B>

    • getBody

      public Optional<B> getBody()
      Specified by:
      getBody in interface io.micronaut.http.HttpMessage<B>

    • getBody

      public <T1> Optional<T1> getBody(Class<T1> type)
      Specified by:
      getBody in interface io.micronaut.http.HttpMessage<B>

    • getBody

      public <T> Optional<T> getBody(io.micronaut.core.convert.ArgumentConversionContext<T> conversionContext)
      Specified by:
      getBody in interface io.micronaut.http.HttpMessage<B>

    • status

      public io.micronaut.http.MutableHttpResponse<B> status(int status, CharSequence message)
      Specified by:
      status in interface io.micronaut.http.MutableHttpResponse<B>

    • body

      public <T> io.micronaut.http.MutableHttpResponse<T> body(@Nullable T body)
      Specified by:
      body in interface io.micronaut.http.MutableHttpMessage<B>
      Specified by:
      body in interface io.micronaut.http.MutableHttpResponse<B>

    • contentType

      public io.micronaut.http.MutableHttpResponse<B> contentType(io.micronaut.http.MediaType mediaType)
      Specified by:
      contentType in interface io.micronaut.http.MutableHttpMessage<B>
      Specified by:
      contentType in interface io.micronaut.http.MutableHttpResponse<B>

    • toFullHttpResponse

      @NonNull public @NonNull io.netty.handler.codec.http.FullHttpResponse toFullHttpResponse()
      Description copied from interface: NettyHttpResponseBuilder
      Converts this object to a full http response.
      Specified by:
      toFullHttpResponse in interface NettyHttpResponseBuilder
      Returns:
      a full http response

    • toStreamHttpResponse

      @NonNull public @NonNull StreamedHttpResponse toStreamHttpResponse()
      Description copied from interface: NettyHttpResponseBuilder
      Converts this object to a streamed http response.
      Specified by:
      toStreamHttpResponse in interface NettyHttpResponseBuilder
      Returns:
      The streamed response

    • toHttpResponse

      @NonNull public @NonNull io.netty.handler.codec.http.HttpResponse toHttpResponse()
      Description copied from interface: NettyHttpResponseBuilder
      Converts this object to the most appropriate http response type.
      Specified by:
      toHttpResponse in interface NettyHttpResponseBuilder
      Returns:
      The http response

    • isStream

      public boolean isStream()
      Specified by:
      isStream in interface NettyHttpResponseBuilder
      Returns:
      Is the response a stream.