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.

Annotations
@DoNotInherit()
Source
HttpMessage.java
Linear Supertypes
AnyRef, Any
Known Subclasses
HttpRequest, HttpResponse, HttpMessage, HttpRequest, HttpResponse
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

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 Optional.of(header), otherwise this method returns an empty Optional.

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

    Try to find the first header with the given name (case-insensitive) and return Optional.of(header), otherwise this method returns an empty Optional.

  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.