Package io.vertx.mutiny.ext.web.handler

Class BodyHandler

java.lang.Object
io.vertx.mutiny.ext.web.handler.BodyHandler
All Implemented Interfaces:
MutinyDelegate, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>
public class BodyHandler extends Object implements io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>, MutinyDelegate
A handler which gathers the entire request body and sets it on the RoutingContext.

It also handles HTTP file uploads and can be used to limit body sizes.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Tim Fox
See Also:
  • BodyHandler

  • Field Details

    • DEFAULT_BODY_LIMIT

      public static final long DEFAULT_BODY_LIMIT
      Default max size for a request body in bytes = 10485760, i.e. 10 megabytes
      See Also:

    • DEFAULT_UPLOADS_DIRECTORY

      public static final String DEFAULT_UPLOADS_DIRECTORY
      Default uploads directory on server for file uploads
      See Also:

    • DEFAULT_MERGE_FORM_ATTRIBUTES

      public static final boolean DEFAULT_MERGE_FORM_ATTRIBUTES
      Default value of whether form attributes should be merged into request params
      See Also:

    • DEFAULT_DELETE_UPLOADED_FILES_ON_END

      public static final boolean DEFAULT_DELETE_UPLOADED_FILES_ON_END
      Default value of whether uploaded files should be removed after handling the request
      See Also:

    • DEFAULT_PREALLOCATE_BODY_BUFFER

      public static final boolean DEFAULT_PREALLOCATE_BODY_BUFFER
      Default value of whether to pre-allocate the body buffer size according to the content-length HTTP request header
      See Also:

    • __TYPE_ARG

      public static final TypeArg<BodyHandler> __TYPE_ARG

  • Constructor Details

    • BodyHandler

      public BodyHandler(io.vertx.ext.web.handler.BodyHandler delegate)
      Create a new instance of BodyHandler delegating to the given (non-null) instance of BodyHandler.

    • BodyHandler

      public BodyHandler(Object delegate)

  • Method Details

    • accept

      public void accept(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      accept in interface Consumer<RoutingContext>

    • handle

      public void handle(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      handle in interface io.vertx.core.Handler<RoutingContext>

    • getDelegate

      public io.vertx.ext.web.handler.BodyHandler getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • create

      public static BodyHandler create()
      Create a body handler with defaults.
      Returns:
      the body handler

    • create

      public static BodyHandler create(boolean handleFileUploads)
      Create a body handler setting if it should handle file uploads.
      Parameters:
      handleFileUploads - true if files upload should be handled
      Returns:
      the body handler

    • create

      public static BodyHandler create(String uploadDirectory)
      Create a body handler and use the given upload directory.
      Parameters:
      uploadDirectory - the uploads directory
      Returns:
      the body handler

    • setHandleFileUploads

      public BodyHandler setHandleFileUploads(boolean handleFileUploads)
      Set whether file uploads will be handled.
      Parameters:
      handleFileUploads - true if they should be handled
      Returns:
      reference to this for fluency

    • setBodyLimit

      public BodyHandler setBodyLimit(long bodyLimit)
      Set the maximum body size in bytes, -1 means no limit.
      Parameters:
      bodyLimit - the max size in bytes
      Returns:
      reference to this for fluency

    • setUploadsDirectory

      public BodyHandler setUploadsDirectory(String uploadsDirectory)
      Set the uploads directory to use.
      Parameters:
      uploadsDirectory - the uploads directory
      Returns:
      reference to this for fluency

    • setMergeFormAttributes

      public BodyHandler setMergeFormAttributes(boolean mergeFormAttributes)
      Set whether form attributes will be added to the request parameters.
      Parameters:
      mergeFormAttributes - true if they should be merged
      Returns:
      reference to this for fluency

    • setDeleteUploadedFilesOnEnd

      public BodyHandler setDeleteUploadedFilesOnEnd(boolean deleteUploadedFilesOnEnd)
      Set whether uploaded files should be removed after handling the request.
      Parameters:
      deleteUploadedFilesOnEnd - true if uploaded files should be removed after handling the request
      Returns:
      reference to this for fluency

    • setPreallocateBodyBuffer

      public BodyHandler setPreallocateBodyBuffer(boolean isPreallocateBodyBuffer)
      Pre-allocate the body buffer according to the value parsed from content-length header. The buffer is capped at 64KB
      Parameters:
      isPreallocateBodyBuffer - true if body buffer is pre-allocated according to the size read from content-length Header. {code false} if body buffer is pre-allocated to 1KB, and is resized dynamically
      Returns:
      reference to this for fluency

    • newInstance

      public static BodyHandler newInstance(io.vertx.ext.web.handler.BodyHandler delegate)
      Creates a new instance of the BodyHandler.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object