t

akka.http.javadsl.model

UniversalEntity

trait UniversalEntity extends RequestEntity with ResponseEntity with BodyPartEntity

Marker-interface for entity types that can be used in any context

Source
UniversalEntity.java
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UniversalEntity
  2. BodyPartEntity
  3. RequestEntity
  4. ResponseEntity
  5. HttpEntity
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def discardBytes(materializer: Materializer): 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 akka.stream.javadsl.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 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
  2. abstract def getContentLengthOption(): OptionalLong

    Returns Some(contentLength) if the length is defined and none otherwise.

    Returns Some(contentLength) if the length is defined and none otherwise.

    Definition Classes
    HttpEntity
  3. abstract def getContentType(): ContentType

    Returns the content-type of this entity

    Returns the content-type of this entity

    Definition Classes
    HttpEntity
  4. abstract def getDataBytes(): Source[ByteString, AnyRef]

    Returns a stream of data bytes this entity consists of.

    Returns a stream of data bytes this entity consists of.

    Definition Classes
    HttpEntity
  5. abstract def isChunked(): Boolean

    Returns if this entity is a subtype of HttpEntityChunked.

    Returns if this entity is a subtype of HttpEntityChunked.

    Definition Classes
    HttpEntity
  6. abstract def isCloseDelimited(): Boolean

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Returns if this entity is a subtype of HttpEntityCloseDelimited.

    Definition Classes
    HttpEntity
  7. abstract def isDefault(): Boolean

    Returns if this entity is a subtype of HttpEntityDefault.

    Returns if this entity is a subtype of HttpEntityDefault.

    Definition Classes
    HttpEntity
  8. abstract def isIndefiniteLength(): Boolean

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Returns if this entity is a subtype of HttpEntityIndefiniteLength.

    Definition Classes
    HttpEntity
  9. abstract def isKnownEmpty(): Boolean

    Returns if this entity is known to be empty.

    Returns if this entity is known to be empty. Open-ended entity types like HttpEntityChunked and HttpCloseDelimited will always return false here.

    Definition Classes
    HttpEntity
  10. abstract def isStrict(): Boolean

    Returns if this entity is a subtype of HttpEntityStrict.

    Returns if this entity is a subtype of HttpEntityStrict.

    Definition Classes
    HttpEntity
  11. abstract def toStrict(timeoutMillis: Long, maxBytes: Long, materializer: Materializer): CompletionStage[Strict]

    Returns a CompletionStage of a strict entity that contains the same data as this entity which is only completed when the complete entity has been collected.

    Returns a CompletionStage of a strict entity that contains the same data as this entity which is only completed when the complete entity has been collected. As the duration of receiving the complete entity cannot be predicted, a timeout needs to be specified to guard the process against running and keeping resources infinitely.

    Use getDataBytes and stream processing instead if the expected data is big or is likely to take a long time.

    Definition Classes
    HttpEntity
  12. abstract def toStrict(timeoutMillis: Long, materializer: Materializer): CompletionStage[Strict]

    Returns a CompletionStage of a strict entity that contains the same data as this entity which is only completed when the complete entity has been collected.

    Returns a CompletionStage of a strict entity that contains the same data as this entity which is only completed when the complete entity has been collected. As the duration of receiving the complete entity cannot be predicted, a timeout needs to be specified to guard the process against running and keeping resources infinitely.

    Use getDataBytes and stream processing instead if the expected data is big or is likely to take a long time.

    Definition Classes
    HttpEntity
  13. abstract def withContentType(contentType: ContentType): HttpEntity

    Returns a copy of this entity with new content type./

    Returns a copy of this entity with new content type./

    Definition Classes
    HttpEntity
  14. abstract def withSizeLimit(maxBytes: Long): 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.

    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.

    Definition Classes
    HttpEntity
  15. abstract def withoutSizeLimit(): HttpEntity

    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.

    Definition Classes
    HttpEntity

Concrete 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 UniversalEntity to any2stringadd[UniversalEntity] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UniversalEntity, B)
    Implicit
    This member is added by an implicit conversion from UniversalEntity to ArrowAssoc[UniversalEntity] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (UniversalEntity) ⇒ Boolean, msg: ⇒ Any): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (UniversalEntity) ⇒ Boolean): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): UniversalEntity
    Implicit
    This member is added by an implicit conversion from UniversalEntity to Ensuring[UniversalEntity] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UniversalEntity to StringFormat[UniversalEntity] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def [B](y: B): (UniversalEntity, B)
    Implicit
    This member is added by an implicit conversion from UniversalEntity to ArrowAssoc[UniversalEntity] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from BodyPartEntity

Inherited from RequestEntity

Inherited from ResponseEntity

Inherited from HttpEntity

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UniversalEntity to any2stringadd[UniversalEntity]

Inherited by implicit conversion StringFormat from UniversalEntity to StringFormat[UniversalEntity]

Inherited by implicit conversion Ensuring from UniversalEntity to Ensuring[UniversalEntity]

Inherited by implicit conversion ArrowAssoc from UniversalEntity to ArrowAssoc[UniversalEntity]

Ungrouped