Packages

final case class Default(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any]) extends javadsl.model.HttpEntity.Default with UniversalEntity with Product with Serializable

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

Source
HttpEntity.scala
Linear Supertypes
Serializable, Product, Equals, UniversalEntity, BodyPartEntity, RequestEntity, ResponseEntity, HttpEntity, javadsl.model.HttpEntity.Default, javadsl.model.UniversalEntity, javadsl.model.BodyPartEntity, javadsl.model.RequestEntity, javadsl.model.ResponseEntity, javadsl.model.HttpEntity, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Default
  2. Serializable
  3. Product
  4. Equals
  5. UniversalEntity
  6. BodyPartEntity
  7. RequestEntity
  8. ResponseEntity
  9. HttpEntity
  10. Default
  11. UniversalEntity
  12. BodyPartEntity
  13. RequestEntity
  14. ResponseEntity
  15. HttpEntity
  16. AnyRef
  17. Any
Implicitly
  1. by fromJava
  2. by HttpEntityScalaDSLSugar
  3. by HttpEntityScalaDSLSugar
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Default(contentType: ContentType, contentLength: Long, data: Source[ByteString, Any])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Default toany2stringadd[Default] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Default, B)
    Implicit
    This member is added by an implicit conversion from Default toArrowAssoc[Default] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val contentLength: Long
    Definition Classes
    Default → UniversalEntity
  9. def contentLengthOption: Option[Long]

    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.

    Definition Classes
    UniversalEntity → HttpEntity
  10. val contentType: ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

    Definition Classes
    Default → HttpEntity
  11. val data: Source[ByteString, Any]
  12. def dataBytes: Source[ByteString, Any]

    A stream of the data of this entity.

    A stream of the data of this entity.

    Definition Classes
    Default → HttpEntity
  13. def discardBytes(system: ClassicActorSystemProvider): HttpMessage.DiscardedEntity

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  14. def discardBytes(mat: Materializer): HttpMessage.DiscardedEntity

    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 pekko.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.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Definition Classes
    HttpEntity → HttpEntity
  15. def ensuring(cond: (Default) => Boolean, msg: => Any): Default
    Implicit
    This member is added by an implicit conversion from Default toEnsuring[Default] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Default) => Boolean): Default
    Implicit
    This member is added by an implicit conversion from Default toEnsuring[Default] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): Default
    Implicit
    This member is added by an implicit conversion from Default toEnsuring[Default] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Default
    Implicit
    This member is added by an implicit conversion from Default toEnsuring[Default] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getContentLength(): Long

    Java API

    Java API

    Definition Classes
    Default → Default
  23. def getContentLengthOption(): OptionalLong

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  24. def getContentType(): javadsl.model.ContentType

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  25. def getDataBytes(): Source[ByteString, AnyRef]

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  26. def isChunked(): Boolean

    Returns if this entity is a subtype of HttpEntityChunked.

    Returns if this entity is a subtype of HttpEntityChunked.

    Definition Classes
    HttpEntity → HttpEntity
  27. def isCloseDelimited(): Boolean

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Definition Classes
    HttpEntity → HttpEntity
  28. def isDefault(): Boolean

    Returns if this entity is a subtype of HttpEntityDefault.

    Returns if this entity is a subtype of HttpEntityDefault.

    Definition Classes
    Default → HttpEntity → HttpEntity
  29. def isIndefiniteLength(): Boolean

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Definition Classes
    HttpEntity → HttpEntity
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isKnownEmpty(): Boolean

    Determines whether this entity is known to be empty.

    Determines whether this entity is known to be empty.

    Definition Classes
    Default → HttpEntity → HttpEntity
  32. def isStrict(): Boolean

    Returns if this entity is a subtype of HttpEntityStrict.

    Returns if this entity is a subtype of HttpEntityStrict.

    Definition Classes
    HttpEntity → HttpEntity
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. def productPrefix: String
    Definition Classes
    Default → Product
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toStrict(timeoutMillis: Long, maxBytes: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  40. def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  41. def toStrict(timeoutMillis: Long, maxBytes: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  42. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  43. def toStrict(timeout: FiniteDuration, maxBytes: Long)(implicit fm: Materializer): Future[Strict]

    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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes.

    Definition Classes
    HttpEntity
  44. def toStrict(timeout: FiniteDuration)(implicit fm: Materializer): Future[Strict]

    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, 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.

    Definition Classes
    HttpEntity
  45. def toString(): String
    Definition Classes
    Default → AnyRef → Any
  46. def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): Chunked

    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.

    Definition Classes
    Default → RequestEntity → ResponseEntity → HttpEntity
  47. def transformDataBytes(newContentLength: Long, transformer: Flow[ByteString, ByteString, Any]): UniversalEntity

    Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as newContentLength.

    Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as newContentLength.

    Definition Classes
    HttpEntity
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. def withContentType(contentType: ContentType): Default

    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.

    Definition Classes
    Default → UniversalEntity → BodyPartEntity → RequestEntity → ResponseEntity → HttpEntity
  52. def withContentType(contentType: javadsl.model.ContentType): HttpEntity

    Java API

    Java API

    Definition Classes
    HttpEntity → HttpEntity
  53. def withSizeLimit(maxBytes: Long): Default

    See HttpEntity#withSizeLimit.

    See HttpEntity#withSizeLimit.

    Definition Classes
    Default → UniversalEntity → BodyPartEntity → RequestEntity → ResponseEntity → HttpEntity → HttpEntity
  54. def withoutSizeLimit(): Default

    See HttpEntity#withoutSizeLimit

    See HttpEntity#withoutSizeLimit

    Definition Classes
    Default → UniversalEntity → BodyPartEntity → RequestEntity → ResponseEntity → HttpEntity → HttpEntity

Shadowed Implicit Value Members

  1. def contentLengthOption: Option[Long]

    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.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).contentLengthOption
    Definition Classes
    HttpEntity
  2. def contentType: ContentType

    The ContentType associated with this entity.

    The ContentType associated with this entity.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).contentType
    Definition Classes
    HttpEntity
  3. def dataBytes: Source[ByteString, Any]

    A stream of the data of this entity.

    A stream of the data of this entity.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).dataBytes
    Definition Classes
    HttpEntity
  4. def discardBytes(system: ClassicActorSystemProvider): HttpMessage.DiscardedEntity

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).discardBytes(system)
    Definition Classes
    HttpEntity → HttpEntity
  5. def discardBytes(mat: Materializer): HttpMessage.DiscardedEntity

    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 pekko.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.

    When called on Strict entities or sources whose values can be buffered in memory, the above warnings can be ignored. Repeated materialization is not necessary in this case, avoiding the mentioned exceptions due to the data being held in memory.

    In future versions, more automatic ways to warn or resolve these situations may be introduced, see issue #18716.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).discardBytes(mat)
    Definition Classes
    HttpEntity → HttpEntity
  6. def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity

    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 pekko.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.

    Implicit
    This member is added by an implicit conversion from Default toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: HttpEntityScalaDSLSugar).discardBytes()(mat)
    Definition Classes
    HttpEntityScalaDSLSugar
  7. def discardBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity

    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 pekko.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.

    Implicit
    This member is added by an implicit conversion from Default toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: HttpEntityScalaDSLSugar).discardBytes()(mat)
    Definition Classes
    HttpEntityScalaDSLSugar
  8. def getContentLengthOption(): OptionalLong

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).getContentLengthOption()
    Definition Classes
    HttpEntity → HttpEntity
  9. def getContentType(): javadsl.model.ContentType

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).getContentType()
    Definition Classes
    HttpEntity → HttpEntity
  10. def getDataBytes(): Source[ByteString, AnyRef]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).getDataBytes()
    Definition Classes
    HttpEntity → HttpEntity
  11. val httpEntity: HttpEntity
    Implicit
    This member is added by an implicit conversion from Default toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpEntity.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (default: HttpEntityScalaDSLSugar).httpEntity
    Definition Classes
    HttpEntityScalaDSLSugar
  12. val httpEntity: HttpEntity
    Implicit
    This member is added by an implicit conversion from Default toHttpEntityScalaDSLSugar performed by method HttpEntityScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpEntity.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (default: HttpEntityScalaDSLSugar).httpEntity
    Definition Classes
    HttpEntityScalaDSLSugar
  13. def isChunked(): Boolean

    Returns if this entity is a subtype of HttpEntityChunked.

    Returns if this entity is a subtype of HttpEntityChunked.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isChunked()
    Definition Classes
    HttpEntity → HttpEntity
  14. def isCloseDelimited(): Boolean

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isCloseDelimited()
    Definition Classes
    HttpEntity → HttpEntity
  15. def isDefault(): Boolean

    Returns if this entity is a subtype of HttpEntityDefault.

    Returns if this entity is a subtype of HttpEntityDefault.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isDefault()
    Definition Classes
    HttpEntity → HttpEntity
  16. def isIndefiniteLength(): Boolean

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isIndefiniteLength()
    Definition Classes
    HttpEntity → HttpEntity
  17. def isKnownEmpty(): Boolean

    Determines whether this entity is known to be empty.

    Determines whether this entity is known to be empty.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isKnownEmpty()
    Definition Classes
    HttpEntity → HttpEntity
  18. def isStrict(): Boolean

    Returns if this entity is a subtype of HttpEntityStrict.

    Returns if this entity is a subtype of HttpEntityStrict.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).isStrict()
    Definition Classes
    HttpEntity → HttpEntity
  19. def toStrict(timeoutMillis: Long, maxBytes: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeoutMillis, maxBytes, system)
    Definition Classes
    HttpEntity → HttpEntity
  20. def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeoutMillis, system)
    Definition Classes
    HttpEntity → HttpEntity
  21. def toStrict(timeoutMillis: Long, maxBytes: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeoutMillis, maxBytes, materializer)
    Definition Classes
    HttpEntity → HttpEntity
  22. def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[javadsl.model.HttpEntity.Strict]

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeoutMillis, materializer)
    Definition Classes
    HttpEntity → HttpEntity
  23. def toStrict(timeout: FiniteDuration, maxBytes: Long)(implicit fm: Materializer): Future[Strict]

    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, or with a EntityStreamException when the end of the entity is not reached within the maximum number of bytes.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeout, maxBytes)(fm)
    Definition Classes
    HttpEntity
  24. def toStrict(timeout: FiniteDuration)(implicit fm: Materializer): Future[Strict]

    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, 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.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).toStrict(timeout)(fm)
    Definition Classes
    HttpEntity
  25. def transformDataBytes(newContentLength: Long, transformer: Flow[ByteString, ByteString, Any]): UniversalEntity

    Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as newContentLength.

    Transforms this' entities data bytes with a transformer that will produce exactly the number of bytes given as newContentLength.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).transformDataBytes(newContentLength, transformer)
    Definition Classes
    HttpEntity
  26. def transformDataBytes(transformer: Flow[ByteString, ByteString, Any]): ResponseEntity

    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.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).transformDataBytes(transformer)
    Definition Classes
    ResponseEntity → HttpEntity
  27. def withContentType(contentType: javadsl.model.ContentType): HttpEntity

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).withContentType(contentType)
    Definition Classes
    HttpEntity → HttpEntity
  28. def withContentType(contentType: ContentType): ResponseEntity

    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.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).withContentType(contentType)
    Definition Classes
    ResponseEntity → HttpEntity
  29. def withSizeLimit(maxBytes: Long): ResponseEntity

    See HttpEntity#withSizeLimit.

    See HttpEntity#withSizeLimit.

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).withSizeLimit(maxBytes)
    Definition Classes
    ResponseEntity → HttpEntity → HttpEntity
  30. def withoutSizeLimit(): ResponseEntity

    See HttpEntity#withoutSizeLimit

    See HttpEntity#withoutSizeLimit

    Implicit
    This member is added by an implicit conversion from Default toResponseEntity performed by method fromJava in org.apache.pekko.http.scaladsl.model.ResponseEntity.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (default: ResponseEntity).withoutSizeLimit()
    Definition Classes
    ResponseEntity → HttpEntity → HttpEntity

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Default toStringFormat[Default] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (Default, B)
    Implicit
    This member is added by an implicit conversion from Default toArrowAssoc[Default] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UniversalEntity

Inherited from BodyPartEntity

Inherited from RequestEntity

Inherited from ResponseEntity

Inherited from HttpEntity

Inherited from javadsl.model.HttpEntity.Default

Inherited from javadsl.model.UniversalEntity

Inherited from javadsl.model.BodyPartEntity

Inherited from javadsl.model.RequestEntity

Inherited from javadsl.model.ResponseEntity

Inherited from javadsl.model.HttpEntity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion fromJava fromDefault to ResponseEntity

Inherited by implicit conversion HttpEntityScalaDSLSugar fromDefault to HttpEntityScalaDSLSugar

Inherited by implicit conversion HttpEntityScalaDSLSugar fromDefault to HttpEntityScalaDSLSugar

Inherited by implicit conversion any2stringadd fromDefault to any2stringadd[Default]

Inherited by implicit conversion StringFormat fromDefault to StringFormat[Default]

Inherited by implicit conversion Ensuring fromDefault to Ensuring[Default]

Inherited by implicit conversion ArrowAssoc fromDefault to ArrowAssoc[Default]

Ungrouped