io.vertx.ext.web

## Interface RequestBody

-     public interface RequestBody

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default JsonArray` | `asJsonArray()`
    `JsonArray` | `asJsonArray(int maxAllowedLength)` Gets the current body buffer as a `JsonArray`.
    `default JsonObject` | `asJsonObject()`
    `JsonObject` | `asJsonObject(int maxAllowedLength)` Gets the current body buffer as a `JsonObject`.
    `default <R> R` | `asPojo(Class<R> clazz)`
    `<R> R` | `asPojo(Class<R> clazz, int maxAllowedLength)`
    `String` | `asString()`
    `String` | `asString(String encoding)` Get the entire HTTP request body as a string, assuming the specified encoding.
    `boolean` | `available()` Return `true` if a `BodyHandler` was executed before this call in the lifetime of the request.
    `Buffer` | `buffer()`
    `default boolean` | `isEmpty()` A body can be empty if it is not available, or its length is `0`.
    `int` | `length()` Returns the total length of the body buffer.

- - ### Method Detail

    - #### asString

          String asString()

      Returns:
        the entire HTTP request body as a string, assuming UTF-8 encoding if the request does not provide the content type charset attribute. If a charset is provided in the request that it shall be respected. The context must have first been routed to a `BodyHandler` for this to be populated.

    - #### asString

          String asString(String encoding)

      Get the entire HTTP request body as a string, assuming the specified encoding. The context must have first been routed to a `BodyHandler` for this to be populated.
      Parameters:
        `encoding` - the encoding, e.g. "UTF-16"
      Returns:
        the body

    - #### asJsonObject

          JsonObject asJsonObject(int maxAllowedLength)

      Gets the current body buffer as a `JsonObject`. If a positive limit is provided the parsing will only happen if the buffer length is smaller or equal to the limit. Otherwise an `IllegalStateException` is thrown. When the application is only handling uploads in JSON format, it is recommended to set a limit on `BodyHandler.setBodyLimit(long)` as this will avoid the upload to be parsed and loaded into the application memory.
      Parameters:
        `maxAllowedLength` - if the current buffer length is greater than the limit an `IllegalStateException` is thrown. This can be used to avoid DDoS attacks on very long JSON payloads that could take over the CPU while attempting to parse the data.
      Returns:
        Get the entire HTTP request body as a `JsonObject`. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned.

    - #### asJsonArray

          JsonArray asJsonArray(int maxAllowedLength)

      Gets the current body buffer as a `JsonArray`. If a positive limit is provided the parsing will only happen if the buffer length is smaller or equal to the limit. Otherwise an `IllegalStateException` is thrown. When the application is only handling uploads in JSON format, it is recommended to set a limit on `BodyHandler.setBodyLimit(long)` as this will avoid the upload to be parsed and loaded into the application memory.
      Parameters:
        `maxAllowedLength` - if the current buffer length is greater than the limit an `IllegalStateException` is thrown. This can be used to avoid DDoS attacks on very long JSON payloads that could take over the CPU while attempting to parse the data.
      Returns:
        Get the entire HTTP request body as a `JsonArray`. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned.

    - #### asJsonObject

          default JsonObject asJsonObject()

      Returns:
        Get the entire HTTP request body as a `JsonObject`. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned.

    - #### asJsonArray

          default JsonArray asJsonArray()

      Returns:
        Get the entire HTTP request body as a `JsonArray`. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned.

    - #### buffer

          Buffer buffer()

      Returns:
        Get the entire HTTP request body as a `Buffer`. The context must have first been routed to a `BodyHandler` for this to be populated.

    - #### asPojo

          <R> R asPojo(Class<R> clazz,
                       int maxAllowedLength)

      Parameters:
        `maxAllowedLength` - if the current buffer length is greater than the limit an `IllegalStateException` is thrown. This can be used to avoid DDoS attacks on very long JSON payloads that could take over the CPU while attempting to parse the data.
      Returns:
        Get the entire HTTP request body as a POJO. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned. WARNING: This feature requires jackson-databind. Or another JSON codec that implements POJO parsing

    - #### asPojo

          default <R> R asPojo(Class<R> clazz)

      Returns:
        Get the entire HTTP request body as a POJO. The context must have first been routed to a `BodyHandler` for this to be populated.
        When the body is `null` or the `"null"` JSON literal then `null` is returned. WARNING: This feature requires jackson-databind. Or another JSON codec that implements POJO parsing

    - #### length

          int length()

      Returns the total length of the body buffer. This is the length in bytes. When there is no buffer the length is `-1`.
      Returns:
        length in bytes.

    - #### isEmpty

          default boolean isEmpty()

      A body can be empty if it is not available, or its length is `0`.
      Returns:
        `true` if empty.

    - #### available

          boolean available()

      Return `true` if a `BodyHandler` was executed before this call in the lifetime of the request.
      Returns:
        `true` if body was parsed during the duration of the request.

Copyright © 2024 Eclipse. All rights reserved.