akka.http.scaladsl.model.HttpEntity
CloseDelimited
Related Doc:
package HttpEntity
Some(content length) if a length is defined for this entity, None otherwise.
Some(content length) if a length is defined for this entity, None otherwise. A length is only defined for Strict and Default entity types.
In many cases it's dangerous to rely on the (non-)existence of a content-length. HTTP intermediaries like (transparent) proxies are allowed to change the transfer-encoding which can result in the entity being delivered as another type as expected.
The ContentType associated with this entity.
The ContentType associated with this entity.
A stream of the data of this entity.
A stream of the data of this entity.
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.
Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once
as the stream is directly attached to the "live" incoming data source from the underlying TCP connection.
Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose
of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an
"stream can cannot be materialized more than once" exception.
In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.
Java API
Java API
Java API
Java API
Java API
Java API
Determines whether this entity is known to be empty.
Determines whether this entity is known to be empty.
Java API
Java API
Collects all possible parts and returns a potentially future Strict entity for easier processing.
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.
Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer.
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.
Creates a copy of this HttpEntity with the contentType overridden with the given one.
Creates a copy of this HttpEntity with the contentType overridden with the given one.
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.
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.
Note that the size limit applied via this method will only have any effect if the Source instance contained
in this entity has been appropriately modified via the HttpEntity.limitable method. For all entities created
by the HTTP layer itself this is always the case, but if you create entities yourself and would like them to
properly respect limits defined via this method you need to make sure to apply HttpEntity.limitable yourself.
Lift the size limit from this entity by returning a new entity instance which skips the size verification.
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.
Note that the size limit applied via this method will only have any effect if the Source instance contained
in this entity has been appropriately modified via the HttpEntity.limitable method. For all entities created
by the HTTP layer itself this is always the case, but if you create entities yourself and would like them to
properly respect limits defined via this method you need to make sure to apply HttpEntity.limitable yourself.
See withSizeLimit for more details.
Some(content length) if a length is defined for this entity, None otherwise.
Some(content length) if a length is defined for this entity, None otherwise. A length is only defined for Strict and Default entity types.
In many cases it's dangerous to rely on the (non-)existence of a content-length. HTTP intermediaries like (transparent) proxies are allowed to change the transfer-encoding which can result in the entity being delivered as another type as expected.
(closeDelimited: ResponseEntity).contentLengthOption
The ContentType associated with this entity.
The ContentType associated with this entity.
(closeDelimited: ResponseEntity).contentType
A stream of the data of this entity.
A stream of the data of this entity.
(closeDelimited: ResponseEntity).dataBytes
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.
Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once
as the stream is directly attached to the "live" incoming data source from the underlying TCP connection.
Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose
of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an
"stream can cannot be materialized more than once" exception.
In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.
(closeDelimited: HttpEntityScalaDSLSugar).discardBytes()(mat)
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.
Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once
as the stream is directly attached to the "live" incoming data source from the underlying TCP connection.
Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose
of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an
"stream can cannot be materialized more than once" exception.
In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.
(closeDelimited: ResponseEntity).discardBytes(mat)
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Discards the entities data bytes by running the dataBytes Source contained in this entity.
Note: It is crucial that entities are either discarded, or consumed by running the underlying akka.stream.scaladsl.Source as otherwise the lack of consuming of the data will trigger back-pressure to the underlying TCP connection (as designed), however possibly leading to an idle-timeout that will close the connection, instead of just having ignored the data.
Warning: It is not allowed to discard and/or consume the entity.dataBytes more than once
as the stream is directly attached to the "live" incoming data source from the underlying TCP connection.
Allowing it to be consumable twice would require buffering the incoming data, thus defeating the purpose
of its streaming nature. If the dataBytes source is materialized a second time, it will fail with an
"stream can cannot be materialized more than once" exception.
In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.
(closeDelimited: HttpEntityScalaDSLSugar).discardBytes()(mat)
Java API
Java API
(closeDelimited: ResponseEntity).getContentLengthOption()
Java API
Java API
(closeDelimited: ResponseEntity).getContentType()
Java API
Java API
(closeDelimited: ResponseEntity).getDataBytes()
(closeDelimited: HttpEntityScalaDSLSugar).httpEntity
(closeDelimited: HttpEntityScalaDSLSugar).httpEntity
(closeDelimited: ResponseEntity).isChunked()
(closeDelimited: ResponseEntity).isCloseDelimited()
(closeDelimited: ResponseEntity).isDefault()
(closeDelimited: ResponseEntity).isIndefiniteLength()
Determines whether this entity is known to be empty.
Determines whether this entity is known to be empty.
(closeDelimited: ResponseEntity).isKnownEmpty()
Java API
Java API
(closeDelimited: ResponseEntity).toStrict(timeoutMillis, materializer)
Collects all possible parts and returns a potentially future Strict entity for easier processing.
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.
(closeDelimited: ResponseEntity).toStrict(timeout)(fm)
Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer.
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.
(closeDelimited: ResponseEntity).transformDataBytes(transformer)
Creates a copy of this HttpEntity with the contentType overridden with the given one.
Creates a copy of this HttpEntity with the contentType overridden with the given one.
(closeDelimited: ResponseEntity).withContentType(contentType)
(closeDelimited: ResponseEntity).withSizeLimit(maxBytes)
See HttpEntity#withoutSizeLimit
(closeDelimited: ResponseEntity).withoutSizeLimit()
The model for the entity of an HTTP response that is terminated by the server closing the connection. The content-length of such responses is unknown at the time the response headers have been received. Note that this type of HttpEntity can only be used for HttpResponses.