org.apache.pekko.http.scaladsl.model

Class HttpEntity.Default

java.lang.Object

org.apache.pekko.http.scaladsl.model.HttpEntity.Default

All Implemented Interfaces:

java.io.Serializable, BodyPartEntity, HttpEntity, HttpEntity.Default, RequestEntity, ResponseEntity, UniversalEntity, scala.Equals, scala.Product

Enclosing interface:

HttpEntity

public static final class HttpEntity.Default
extends java.lang.Object
implements HttpEntity.Default, UniversalEntity, scala.Product, java.io.Serializable

The model for the entity of a "regular" unchunked HTTP message with a known non-zero length.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.model.HttpEntity

HttpEntity.Chunk, HttpEntity.Chunk$, HttpEntity.Chunked, HttpEntity.Chunked$, HttpEntity.ChunkStreamPart, HttpEntity.ChunkStreamPart$, HttpEntity.CloseDelimited, HttpEntity.CloseDelimited$, HttpEntity.Default, HttpEntity.Default$, HttpEntity.DiscardedEntity, HttpEntity.HttpEntityScalaDSLSugar, HttpEntity.HttpEntityScalaDSLSugar$, HttpEntity.IndefiniteLength, HttpEntity.IndefiniteLength$, HttpEntity.LastChunk, HttpEntity.LastChunk$, HttpEntity.Strict, HttpEntity.Strict$, HttpEntity.WithoutKnownLength

Constructor Summary

Constructors

Constructor and Description
Default(ContentType contentType, long contentLength, org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object> data)

Method Summary

Modifier and Type	Method and Description
long	contentLength()
ContentType	contentType() The ContentType associated with this entity.
org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object>	data()
org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object>	dataBytes() A stream of the data of this entity.
long	getContentLength() Java API
boolean	isDefault() Returns if this entity is a subtype of HttpEntityDefault.
boolean	isKnownEmpty() Returns if this entity is known to be empty.
java.lang.String	productPrefix()
java.lang.String	toString()
HttpEntity.Chunked	transformDataBytes(org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,java.lang.Object> transformer) Returns a copy of the given entity with the ByteString chunks of this entity transformed by the given transformer.
HttpEntity.Default	withContentType(ContentType contentType) Creates a copy of this HttpEntity with the contentType overridden with the given one.
HttpEntity.Default	withoutSizeLimit() Lift the size limit from this entity by returning a new entity instance which skips the size verification.
HttpEntity.Default	withSizeLimit(long maxBytes) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.pekko.http.scaladsl.model.UniversalEntity

contentLengthOption

Methods inherited from interface org.apache.pekko.http.scaladsl.model.HttpEntity

completionStageCovariant, discardBytes, discardBytes, getContentLengthOption, getContentType, getDataBytes, isChunked, isCloseDelimited, isIndefiniteLength, isStrict, toStrict, toStrict, toStrict, toStrict, toStrict, toStrict, transformDataBytes, withContentType

Methods inherited from interface scala.Product

$init$, productArity, productElement, productElementName, productElementNames, productIterator

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Default

public Default(ContentType contentType,
               long contentLength,
               org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object> data)

Method Detail

contentType

public ContentType contentType()

Description copied from interface: HttpEntity

The ContentType associated with this entity.

Returns:

(undocumented)

contentLength

public long contentLength()

data

public org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object> 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

Returns:

(undocumented)

isDefault

public boolean isDefault()

Description copied from interface: HttpEntity

Returns if this entity is a subtype of HttpEntityDefault.

Specified by:

isDefault in interface HttpEntity

dataBytes

public org.apache.pekko.stream.scaladsl.Source<org.apache.pekko.util.ByteString,java.lang.Object> dataBytes()

Description copied from interface: HttpEntity

A stream of the data of this entity.

Returns:

(undocumented)

transformDataBytes

public HttpEntity.Chunked transformDataBytes(org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.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.

Parameters:

transformer - (undocumented)

Returns:

(undocumented)

withContentType

public HttpEntity.Default withContentType(ContentType contentType)

Description copied from interface: HttpEntity

Creates a copy of this HttpEntity with the contentType overridden with the given one.

Parameters:

contentType - (undocumented)

Returns:

(undocumented)

withSizeLimit

public HttpEntity.Default 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 HttpEntity

Parameters:

maxBytes - (undocumented)

Returns:

(undocumented)

withoutSizeLimit

public HttpEntity.Default 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 HttpEntity

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

getContentLength

public long getContentLength()

Java API

Specified by:

getContentLength in interface HttpEntity.Default