Interface HttpContentProcessor

All Superinterfaces:
Toggleable
@Deprecated(forRemoval=true, since="4.0.0") public interface HttpContentProcessor extends Toggleable
Deprecated, for removal: This API element is subject to removal in a future version.
Use the MessageBodyReader API instead. This interface has not been used or implemented by the server since 4.0.0, and, as with any API marked for removal, it will be removed in a future major release rather than in a 5.x minor.
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(ByteBufHolder, Collection) with more data, followed by a call to complete(Collection) to finish up. Both of these methods accept a Collection out parameter that is populated with the processed items.
Since:
1.0
Author:
Graeme Rocher

  • Method Summary

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

    Methods inherited from interface Toggleable

    isEnabled

  • Method Details

    • add

      void add(io.netty.buffer.ByteBufHolder data, Collection<Object> out) throws Throwable
      Deprecated, for removal: This API element is subject to removal in a future version.
      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, for removal: This API element is subject to removal in a future version.
      Finish processing data.
      Parameters:
      out - The collection to add remaining output items to
      Throws:
      Throwable

    • cancel

      default void cancel() throws Throwable
      Deprecated, for removal: This API element is subject to removal in a future version.
      Cancel processing, clean up any data. After this, there should be no more calls to add(ByteBufHolder, Collection) and complete(Collection).
      Throws:
      Throwable

    • resultType

      default HttpContentProcessor resultType(Argument<?> type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the type of the values returned by this processor. Most processors do not respect this setting.
      Parameters:
      type - The type produced by this processor
      Returns:
      This processor, for chaining

    • processSingle

      default @Nullable Object processSingle(io.netty.buffer.ByteBuf data) throws Throwable
      Deprecated, for removal: This API element is subject to removal in a future version.
      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