Package akka.http.scaladsl.model

Class HttpEntity.Strict

    • Constructor Detail

      • Strict

        public Strict​(ContentType contentType,
              akka.util.ByteString data)

    • Method Detail

      • 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 akka.util.ByteString data()

      • 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 akka.stream.scaladsl.Source<akka.util.ByteString,​akka.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,
                                                           akka.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 akka.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​(akka.stream.scaladsl.Flow<akka.util.ByteString,​akka.util.ByteString,​java.lang.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)

      • 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)

      • productPrefix

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object