t

akka.http.javadsl.model

HttpMessage

trait HttpMessage extends AnyRef

The base type for an Http message (request or response).

INTERNAL API: this trait will be changed in binary-incompatible ways for classes that are derived from it! Do not implement this interface outside the Akka code base!

Binary compatibility is only maintained for callers of this trait’s interface.

Source
HttpMessage.java
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpMessage
  2. AnyRef
  3. 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

Type Members

  1. type MessageTransformations[Self] = HttpMessage.MessageTransformations[Self]
    Attributes
    protected

Abstract Value Members

  1. abstract def discardEntityBytes(materializer: Materializer): DiscardedEntity

    Discards the entities data bytes by running the dataBytes Source contained by the entity of this HTTP message.

    Discards the entities data bytes by running the dataBytes Source contained by the entity of this HTTP message.

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

  2. abstract def entity(): ResponseEntity

    The entity of this message.

  3. abstract def getHeader[T <: HttpHeader](headerClass: Class[T]): Optional[T]

    Try to find the first header of the given class and return Some(header), otherwise this method returns None.

  4. abstract def getHeader(headerName: String): Optional[HttpHeader]

    Try to find the first header with the given name (case-insensitive) and return Some(header), otherwise this method returns None.

  5. abstract def getHeaders[T <: HttpHeader](headerClass: Class[T]): Iterable[T]

    An iterable containing all headers of the given class of this message.

  6. abstract def getHeaders(): Iterable[HttpHeader]

    An iterable containing the headers of this message.

  7. abstract def isRequest(): Boolean

    Is this instance a request.

  8. abstract def isResponse(): Boolean

    Is this instance a response.

  9. abstract def protocol(): HttpProtocol

    The protocol of this message.

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 HttpMessage to any2stringadd[HttpMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpMessage, B)
    Implicit
    This member is added by an implicit conversion from HttpMessage to ArrowAssoc[HttpMessage] 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: (HttpMessage) ⇒ Boolean, msg: ⇒ Any): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage to Ensuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HttpMessage) ⇒ Boolean): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage to Ensuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage to Ensuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage to Ensuring[HttpMessage] 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 HttpMessage to StringFormat[HttpMessage] 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): (HttpMessage, B)
    Implicit
    This member is added by an implicit conversion from HttpMessage to ArrowAssoc[HttpMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped