Package org.apache.pekko.http.scaladsl.model

Class HttpEntity.Strict

java.lang.Object
org.apache.pekko.http.scaladsl.model.HttpEntity.Strict
All Implemented Interfaces:
Serializable, BodyPartEntity, HttpEntity, HttpEntity.Strict, RequestEntity, ResponseEntity, UniversalEntity, BodyPartEntity, HttpEntity, RequestEntity, ResponseEntity, UniversalEntity, scala.Equals, scala.Product
Enclosing interface:
HttpEntity
public static final class HttpEntity.Strict extends Object implements HttpEntity.Strict, UniversalEntity, scala.Product, Serializable
The model for the entity of a "regular" unchunked HTTP message with known, fixed data.
See Also:

  • Constructor Details

    • Strict

      public Strict(ContentType contentType, org.apache.pekko.util.ByteString data)

  • Method Details

    • contentType

      public ContentType contentType()
      Description copied from interface: HttpEntity
      The ContentType associated with this entity.
      Specified by:
      contentType in interface HttpEntity
      Returns:
      (undocumented)

    • data

      public org.apache.pekko.util.ByteString data()

    • contentLength

      public long contentLength()
      Specified by:
      contentLength in interface UniversalEntity

    • isKnownEmpty

      public boolean isKnownEmpty()
      Description copied from interface: HttpEntity
      Returns if this entity is known to be empty. Open-ended entity types like HttpEntityChunked and HttpCloseDelimited will always return false here.
      Specified by:
      isKnownEmpty in interface HttpEntity
      Specified by:
      isKnownEmpty in interface HttpEntity
      Returns:
      (undocumented)

    • isStrict

      public boolean isStrict()
      Description copied from interface: HttpEntity
      Returns if this entity is a subtype of HttpEntityStrict.
      Specified by:
      isStrict in interface HttpEntity
      Specified by:
      isStrict in interface HttpEntity

    • dataBytes

      public org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> dataBytes()
      Description copied from interface: HttpEntity
      A stream of the data of this entity.
      Specified by:
      dataBytes in interface HttpEntity
      Returns:
      (undocumented)

    • toStrict

      public scala.concurrent.Future<HttpEntity.Strict> toStrict(scala.concurrent.duration.FiniteDuration timeout, org.apache.pekko.stream.Materializer fm)
      Description copied from interface: HttpEntity
      Collects all possible parts and returns a potentially future Strict entity for easier processing. The Future is failed with an TimeoutException if the stream isn't completed after the given timeout, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes as configured in pekko.http.parsing.max-to-strict-bytes. Not that this method does not support different defaults for client- and server use: if you want that, use the toStrict method and pass in an explicit maximum number of bytes.
      Specified by:
      toStrict in interface HttpEntity
      Parameters:
      timeout - (undocumented)
      fm - (undocumented)
      Returns:
      (undocumented)

    • transformDataBytes

      public RequestEntity transformDataBytes(org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,Object> transformer)
      Description copied from interface: HttpEntity
      Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer. For a Chunked entity, the chunks will be transformed one by one keeping the chunk metadata (but may introduce an extra chunk before the LastChunk if transformer.onTermination returns additional data).

      This method may only throw an exception if the transformer function throws an exception while creating the transformer. Any other errors are reported through the new entity data stream.

      Specified by:
      transformDataBytes in interface HttpEntity
      Specified by:
      transformDataBytes in interface RequestEntity
      Specified by:
      transformDataBytes in interface ResponseEntity
      Parameters:
      transformer - (undocumented)
      Returns:
      (undocumented)

    • withContentType

      public HttpEntity.Strict withContentType(ContentType contentType)
      Description copied from interface: HttpEntity
      Creates a copy of this HttpEntity with the contentType overridden with the given one.
      Specified by:
      withContentType in interface BodyPartEntity
      Specified by:
      withContentType in interface HttpEntity
      Specified by:
      withContentType in interface RequestEntity
      Specified by:
      withContentType in interface ResponseEntity
      Specified by:
      withContentType in interface UniversalEntity
      Parameters:
      contentType - (undocumented)
      Returns:
      (undocumented)

    • withSizeLimit

      public UniversalEntity withSizeLimit(long maxBytes)
      Description copied from interface: HttpEntity
      Apply the given size limit to this entity by returning a new entity instance which automatically verifies that the data stream encapsulated by this instance produces at most `maxBytes` data bytes. In case this verification fails the respective stream will be terminated with an `EntityStreamException` either directly at materialization time (if the Content-Length is known) or whenever more data bytes than allowed have been read.

      When called on `Strict` entities the method will return the entity itself if the length is within the bound, otherwise a `Default` entity with a single element data stream. This allows for potential refinement of the entity size limit at a later point (before materialization of the data stream).

      By default all message entities produced by the HTTP layer automatically carry the limit that is defined in the application's `max-content-length` config setting. If the entity is transformed in a way that changes the Content-Length and then another limit is applied then this new limit will be evaluated against the new Content-Length. If the entity is transformed in a way that changes the Content-Length and no new limit is applied then the previous limit will be applied against the previous Content-Length.

      Specified by:
      withSizeLimit in interface BodyPartEntity
      Specified by:
      withSizeLimit in interface HttpEntity
      Specified by:
      withSizeLimit in interface HttpEntity
      Specified by:
      withSizeLimit in interface RequestEntity
      Specified by:
      withSizeLimit in interface ResponseEntity
      Specified by:
      withSizeLimit in interface UniversalEntity
      Parameters:
      maxBytes - (undocumented)
      Returns:
      (undocumented)

    • withoutSizeLimit

      public UniversalEntity withoutSizeLimit()
      Description copied from interface: HttpEntity
      Lift the size limit from this entity by returning a new entity instance which skips the size verification.

      By default all message entities produced by the HTTP layer automatically carry the limit that is defined in the application's `max-content-length` config setting. It is recommended to always keep an upper limit on accepted entities to avoid potential attackers flooding you with too large requests/responses, so use this method with caution.

      See [[withSizeLimit]] for more details.

      Specified by:
      withoutSizeLimit in interface BodyPartEntity
      Specified by:
      withoutSizeLimit in interface HttpEntity
      Specified by:
      withoutSizeLimit in interface HttpEntity
      Specified by:
      withoutSizeLimit in interface RequestEntity
      Specified by:
      withoutSizeLimit in interface ResponseEntity
      Specified by:
      withoutSizeLimit in interface UniversalEntity
      Returns:
      (undocumented)

    • productPrefix

      public String productPrefix()
      Specified by:
      productPrefix in interface scala.Product

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getData

      public org.apache.pekko.util.ByteString getData()
      Java API
      Specified by:
      getData in interface HttpEntity.Strict