Package io.micronaut.http.server.netty

Interface HttpContentProcessor

All Superinterfaces:
io.micronaut.core.util.Toggleable
All Known Implementing Classes:
DefaultHttpContentProcessor
@Deprecated public interface HttpContentProcessor extends io.micronaut.core.util.Toggleable
Deprecated.
Use the MessageBodyReader API instead
This class represents the first step of the HTTP body parsing pipeline. It transforms ByteBufHolder instances that come from a StreamedHttpRequest into parsed objects, e.g. json nodes or form data fragments.
Processors are stateful. They can receive repeated calls to add(io.netty.buffer.ByteBufHolder, java.util.Collection<java.lang.Object>) with more data, followed by a call to complete(java.util.Collection<java.lang.Object>) to finish up. Both of these methods accept a Collection out parameter that is populated with the processed items.
Since:
1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(io.netty.buffer.ByteBufHolder data, Collection<Object> out)
    Deprecated.
    Process more data.
    default void
    cancel()
    Deprecated.
    Cancel processing, clean up any data.
    default void
    complete(Collection<Object> out)
    Deprecated.
    Finish processing data.
    default @Nullable Object
    processSingle(io.netty.buffer.ByteBuf data)
    Deprecated.
    Process a single ByteBuf into a single item, if possible.
    default HttpContentProcessor
    resultType(io.micronaut.core.type.Argument<?> type)
    Deprecated.
    Set the type of the values returned by this processor.

    Methods inherited from interface io.micronaut.core.util.Toggleable

    isEnabled

  • Method Details

    • add

      void add(io.netty.buffer.ByteBufHolder data, Collection<Object> out) throws Throwable
      Deprecated.
      Process more data.
      Parameters:
      data - The input data
      out - The collection to add output items to
      Throws:
      Throwable

    • complete

      default void complete(Collection<Object> out) throws Throwable
      Deprecated.
      Finish processing data.
      Parameters:
      out - The collection to add remaining output items to
      Throws:
      Throwable

    • cancel

      default void cancel() throws Throwable
      Deprecated.
      Cancel processing, clean up any data. After this, there should be no more calls to add(io.netty.buffer.ByteBufHolder, java.util.Collection<java.lang.Object>) and complete(java.util.Collection<java.lang.Object>).
      Throws:
      Throwable

    • resultType

      default HttpContentProcessor resultType(io.micronaut.core.type.Argument<?> type)
      Deprecated.
      Set the type of the values returned by this processor. Most processors do not respect this setting, but e.g. the io.micronaut.http.server.netty.jackson.JsonContentProcessor does.
      Parameters:
      type - The type produced by this processor
      Returns:
      This processor, for chaining

    • processSingle

      @Nullable default @Nullable Object processSingle(io.netty.buffer.ByteBuf data) throws Throwable
      Deprecated.
      Process a single ByteBuf into a single item, if possible.
      Parameters:
      data - The input data
      Returns:
      The output value, or null if this is unsupported.
      Throws:
      Throwable - Any failure