sealed trait HttpMessage extends javadsl.model.HttpMessage

Common base class of HttpRequest and HttpResponse.

Source
HttpMessage.scala
Linear Supertypes
javadsl.model.HttpMessage, AnyRef, Any
Known Subclasses
HttpRequest, HttpResponse
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpMessage
  2. HttpMessage
  3. AnyRef
  4. Any
Implicitly
  1. by HttpMessageScalaDSLSugar
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Self <: HttpMessage { type Self = HttpMessage.this.Self }

Abstract Value Members

  1. abstract def attributes: Map[AttributeKey[_], _]
  2. abstract def entity(): ResponseEntity

    The entity of this message.

    The entity of this message.

    Definition Classes
    HttpMessage → HttpMessage
  3. abstract def headers: Seq[HttpHeader]
  4. abstract def isRequest(): Boolean

    Is this instance a request.

    Is this instance a request.

    Definition Classes
    HttpMessage → HttpMessage
  5. abstract def isResponse(): Boolean

    Is this instance a response.

    Is this instance a response.

    Definition Classes
    HttpMessage → HttpMessage
  6. abstract def protocol(): HttpProtocol

    The protocol of this message.

    The protocol of this message.

    Definition Classes
    HttpMessage → HttpMessage
  7. abstract def self: Self
  8. abstract def transformEntityDataBytes[M](transformer: Graph[FlowShape[ByteString, ByteString], M]): Self
  9. abstract def withAttributes(headers: Map[AttributeKey[_], _]): Self

    Returns a copy of this message with the attributes set to the given ones.

  10. abstract def withEntity(entity: MessageEntity): Self

    Returns a copy of this message with the entity set to the given one.

  11. abstract def withHeaders(headers: Seq[HttpHeader]): Self

    Returns a copy of this message with the list of headers set to the given ones.

  12. abstract def withHeadersAndEntity(headers: Seq[HttpHeader], entity: MessageEntity): Self

    Returns a copy of this message with the entity and headers set to the given ones.

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 toany2stringadd[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 toArrowAssoc[HttpMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAttribute[T](key: javadsl.model.AttributeKey[T], value: T): Self
  7. def addCredentials(credentials: HttpCredentials): Self
  8. def addHeader(header: javadsl.model.HttpHeader): Self

    Return a new instance with the given header added to the headers sequence.

    Return a new instance with the given header added to the headers sequence. It's undefined where the header is added to the sequence

  9. def addHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def attribute[T](key: javadsl.model.AttributeKey[T])(implicit ev: JavaMapping[javadsl.model.AttributeKey[T], AttributeKey[T]]): Option[T]
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def connectionCloseExpected: Boolean

    Returns true if this message is an:

    Returns true if this message is an:

    • HttpRequest and the client does not want to reuse the connection after the response for this request has been received
    • HttpResponse and the server will close the connection after this response
  14. def discardEntityBytes(system: ClassicActorSystemProvider): DiscardedEntity

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  15. def discardEntityBytes(mat: Materializer): DiscardedEntity

    Discards the entities data bytes by running the dataBytes Source contained in this HttpMessage.

    Discards the entities data bytes by running the dataBytes Source contained in this HttpMessage.

    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
    HttpMessage → HttpMessage
  16. def encoding: HttpEncoding

    The content encoding as specified by the Content-Encoding header.

    The content encoding as specified by the Content-Encoding header. If no Content-Encoding header is present the default value 'identity' is returned.

  17. def ensuring(cond: (HttpMessage) => Boolean, msg: => Any): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage toEnsuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (HttpMessage) => Boolean): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage toEnsuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage toEnsuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage toEnsuring[HttpMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. def getAttribute[T](attributeKey: javadsl.model.AttributeKey[T]): Optional[T]

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def getHeader(headerName: String): Optional[javadsl.model.HttpHeader]

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  27. def getHeader[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Optional[T]

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  28. def getHeaders[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Iterable[T]

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  29. def getHeaders(): Iterable[javadsl.model.HttpHeader]

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def header[T >: Null <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Option[T]

    Returns the first header of the given type if there is one

  32. def headers[T <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Seq[T]

    Returns all the headers of the given type *

  33. val httpMessage: HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpMessage toHttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpMessage.
    Definition Classes
    HttpMessageScalaDSLSugar
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def mapAttributes(f: (Map[AttributeKey[_], _]) => Map[AttributeKey[_], _]): Self

    Returns a copy of this message with the attributes transformed by the given function

  36. def mapHeaders(f: (Seq[HttpHeader]) => Seq[HttpHeader]): Self

    Returns a copy of this message with the list of headers transformed by the given function

  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. def removeAttribute(key: javadsl.model.AttributeKey[_]): Self
  41. def removeHeader(headerName: String): Self

    Removes the header with the given name (case-insensitive)

  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def toStrict(timeoutMillis: Long, maxBytes: Long, system: ClassicActorSystemProvider): CompletionStage[Self]

    Java API

  44. def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[Self]

    Java API

  45. def toStrict(timeoutMillis: Long, maxBytes: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

  46. def toStrict(timeoutMillis: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

  47. def toStrict(timeout: FiniteDuration, maxBytes: Long)(implicit ec: ExecutionContext, fm: Materializer): Future[Self]

    Returns a shareable and serializable copy of this message with a strict entity.

  48. def toStrict(timeout: FiniteDuration)(implicit ec: ExecutionContext, fm: Materializer): Future[Self]

    Returns a shareable and serializable copy of this message with a strict entity.

  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. def withDefaultHeaders(firstHeader: HttpHeader, otherHeaders: HttpHeader*): Self
  54. def withDefaultHeaders(defaultHeaders: Seq[HttpHeader]): Self

    Returns a new message that contains all of the given default headers which didn't already exist (by case-insensitive header name) in this message.

  55. def withEntity(contentType: javadsl.model.ContentType, file: Path): Self
  56. def withEntity(contentType: javadsl.model.ContentType, file: File): Self
  57. def withEntity(contentType: javadsl.model.ContentType, bytes: ByteString): Self
  58. def withEntity(contentType: javadsl.model.ContentType, bytes: Array[Byte]): Self
  59. def withEntity(contentType: NonBinary, string: String): Self
  60. def withEntity(bytes: ByteString): Self
  61. def withEntity(bytes: Array[Byte]): Self
  62. def withEntity(string: String): Self
  63. def withHeaders(firstHeader: HttpHeader, otherHeaders: HttpHeader*): Self
  64. def withHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

Shadowed Implicit Value Members

  1. def discardEntityBytes()(implicit mat: 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 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 HttpMessage toHttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpMessage.
    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:
    (httpMessage: HttpMessageScalaDSLSugar).discardEntityBytes()(mat)
    Definition Classes
    HttpMessageScalaDSLSugar

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpMessage toStringFormat[HttpMessage] 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): (HttpMessage, B)
    Implicit
    This member is added by an implicit conversion from HttpMessage toArrowAssoc[HttpMessage] 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 javadsl.model.HttpMessage

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion HttpMessageScalaDSLSugar fromHttpMessage to HttpMessageScalaDSLSugar

Inherited by implicit conversion any2stringadd fromHttpMessage to any2stringadd[HttpMessage]

Inherited by implicit conversion StringFormat fromHttpMessage to StringFormat[HttpMessage]

Inherited by implicit conversion Ensuring fromHttpMessage to Ensuring[HttpMessage]

Inherited by implicit conversion ArrowAssoc fromHttpMessage to ArrowAssoc[HttpMessage]

Ungrouped