final class HttpResponse extends javadsl.model.HttpResponse with HttpMessage

The immutable HTTP response model.

Source
HttpMessage.scala
Linear Supertypes
HttpMessage, javadsl.model.HttpResponse, MessageTransformations[javadsl.model.HttpResponse], javadsl.model.HttpMessage, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpResponse
  2. HttpMessage
  3. HttpResponse
  4. MessageTransformations
  5. HttpMessage
  6. AnyRef
  7. 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

Instance Constructors

  1. new HttpResponse(status: StatusCode, headers: Seq[HttpHeader], attributes: Map[AttributeKey[_], _], entity: ResponseEntity, protocol: HttpProtocol)

Type Members

  1. type Self = HttpResponse
    Definition Classes
    HttpResponse → HttpMessage

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 HttpResponse toany2stringadd[HttpResponse] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpResponse, B)
    Implicit
    This member is added by an implicit conversion from HttpResponse toArrowAssoc[HttpResponse] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _1: StatusCode
  7. def _2: Seq[HttpHeader]
  8. def _3: ResponseEntity
  9. def _4: HttpProtocol
  10. def addAttribute[T](key: javadsl.model.AttributeKey[T], value: T): Self
    Definition Classes
    HttpMessage
  11. def addCredentials(credentials: HttpCredentials): Self
    Definition Classes
    HttpMessage
  12. 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

    Definition Classes
    HttpMessage
  13. def addHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def attribute[T](key: javadsl.model.AttributeKey[T])(implicit ev: JavaMapping[javadsl.model.AttributeKey[T], AttributeKey[T]]): Option[T]
    Definition Classes
    HttpMessage
  16. val attributes: Map[AttributeKey[_], _]
    Definition Classes
    HttpResponse → HttpMessage
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  18. 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
    Definition Classes
    HttpMessage
  19. def discardEntityBytes(system: ClassicActorSystemProvider): DiscardedEntity

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  20. 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
  21. 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.

    Definition Classes
    HttpMessage
  22. def ensuring(cond: (HttpResponse) => Boolean, msg: => Any): HttpResponse
    Implicit
    This member is added by an implicit conversion from HttpResponse toEnsuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: (HttpResponse) => Boolean): HttpResponse
    Implicit
    This member is added by an implicit conversion from HttpResponse toEnsuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean, msg: => Any): HttpResponse
    Implicit
    This member is added by an implicit conversion from HttpResponse toEnsuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean): HttpResponse
    Implicit
    This member is added by an implicit conversion from HttpResponse toEnsuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. val entity: ResponseEntity

    The entity of this message.

    The entity of this message.

    Definition Classes
    HttpResponse → HttpMessage → HttpResponse → HttpMessage
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(obj: Any): Boolean
    Definition Classes
    HttpResponse → AnyRef → Any
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  30. def getAttribute[T](attributeKey: javadsl.model.AttributeKey[T]): Optional[T]

    Java API

    Java API

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

    Java API

    Java API

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

    Java API

    Java API

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

    Java API

    Java API

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

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage
  36. def hashCode(): Int
    Definition Classes
    HttpResponse → AnyRef → Any
  37. 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

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

    Definition Classes
    HttpMessage
  38. def headers[T <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Seq[T]

    Returns all the headers of the given type *

    Returns all the headers of the given type *

    Definition Classes
    HttpMessage
  39. val headers: Seq[HttpHeader]
    Definition Classes
    HttpResponse → HttpMessage
  40. val httpMessage: HttpMessage
    Implicit
    This member is added by an implicit conversion from HttpResponse toHttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in org.apache.pekko.http.scaladsl.model.HttpMessage.
    Definition Classes
    HttpMessageScalaDSLSugar
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def isRequest(): Boolean

    Is this instance a request.

    Is this instance a request.

    Definition Classes
    HttpResponse → HttpMessage → HttpMessage
  43. def isResponse(): Boolean

    Is this instance a response.

    Is this instance a response.

    Definition Classes
    HttpResponse → HttpMessage → HttpMessage
  44. def mapAttributes(f: (Map[AttributeKey[_], _]) => Map[AttributeKey[_], _]): Self

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

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

    Definition Classes
    HttpMessage
  45. def mapEntity(f: (ResponseEntity) => ResponseEntity): HttpResponse
  46. def mapHeaders(f: (Seq[HttpHeader]) => Seq[HttpHeader]): Self

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

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

    Definition Classes
    HttpMessage
  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. val protocol: HttpProtocol

    The protocol of this message.

    The protocol of this message.

    Definition Classes
    HttpResponse → HttpMessage → HttpMessage
  51. def removeAttribute(key: javadsl.model.AttributeKey[_]): Self
    Definition Classes
    HttpMessage
  52. def removeHeader(headerName: String): Self

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

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

    Definition Classes
    HttpMessage
  53. def self: HttpResponse
    Definition Classes
    HttpResponse → HttpMessage
  54. val status: StatusCode

    Returns the status-code of this response.

    Returns the status-code of this response.

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

    Java API

    Java API

    Definition Classes
    HttpMessage
  57. def toStrict(timeoutMillis: Long, system: ClassicActorSystemProvider): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  58. def toStrict(timeoutMillis: Long, maxBytes: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  59. def toStrict(timeoutMillis: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  60. 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.

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

    Definition Classes
    HttpMessage
  61. def toStrict(timeout: FiniteDuration)(implicit ec: ExecutionContext, fm: Materializer): Future[Self]

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

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

    Definition Classes
    HttpMessage
  62. def toString(): String
    Definition Classes
    HttpResponse → AnyRef → Any
  63. def transformEntityDataBytes[T](transformer: Graph[FlowShape[ByteString, ByteString], T]): HttpResponse

    Returns a copy of Self message after applying the given transformation

    Returns a copy of Self message after applying the given transformation

    Definition Classes
    HttpResponse → HttpMessage → MessageTransformations
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. def withAttributes(attributes: Map[AttributeKey[_], _]): HttpResponse

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

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

    Definition Classes
    HttpResponse → HttpMessage
  68. def withDefaultHeaders(firstHeader: HttpHeader, otherHeaders: HttpHeader*): Self
    Definition Classes
    HttpMessage
  69. 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.

    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.

    Definition Classes
    HttpMessage
  70. def withEntity(entity: javadsl.model.RequestEntity): HttpResponse

    Returns a copy of Self message with a new entity.

    Returns a copy of Self message with a new entity.

    Definition Classes
    HttpResponse → MessageTransformations
  71. def withEntity(entity: MessageEntity): HttpResponse

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

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

    Definition Classes
    HttpResponse → HttpMessage
  72. def withEntity(entity: javadsl.model.ResponseEntity): HttpResponse

    Returns a copy of this instance with a new entity.

    Returns a copy of this instance with a new entity.

    Definition Classes
    HttpResponse → HttpResponse
  73. def withEntity(contentType: javadsl.model.ContentType, file: Path): Self
    Definition Classes
    HttpMessage
  74. def withEntity(contentType: javadsl.model.ContentType, file: File): Self
    Definition Classes
    HttpMessage
  75. def withEntity(contentType: javadsl.model.ContentType, bytes: ByteString): Self
    Definition Classes
    HttpMessage
  76. def withEntity(contentType: javadsl.model.ContentType, bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  77. def withEntity(contentType: NonBinary, string: String): Self
    Definition Classes
    HttpMessage
  78. def withEntity(bytes: ByteString): Self
    Definition Classes
    HttpMessage
  79. def withEntity(bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  80. def withEntity(string: String): Self
    Definition Classes
    HttpMessage
  81. def withHeaders(headers: Seq[HttpHeader]): HttpResponse

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

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

    Definition Classes
    HttpResponse → HttpMessage
  82. def withHeaders(firstHeader: HttpHeader, otherHeaders: HttpHeader*): Self
    Definition Classes
    HttpMessage
  83. def withHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  84. def withHeadersAndEntity(headers: Seq[HttpHeader], entity: ResponseEntity): HttpResponse
  85. def withHeadersAndEntity(headers: Seq[HttpHeader], entity: MessageEntity): HttpResponse

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

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

    Definition Classes
    HttpResponse → HttpMessage
  86. def withProtocol(protocol: HttpProtocol): HttpResponse
  87. def withProtocol(protocol: javadsl.model.HttpProtocol): javadsl.model.HttpResponse

    Returns a copy of this message with a new protocol.

    Returns a copy of this message with a new protocol.

    Definition Classes
    HttpResponse → MessageTransformations
  88. def withStatus(statusCode: javadsl.model.StatusCode): HttpResponse

    Returns a copy of this instance with a new status-code.

    Returns a copy of this instance with a new status-code.

    Definition Classes
    HttpResponse → HttpResponse
  89. def withStatus(statusCode: Int): HttpResponse

    Returns a copy of this instance with a new status-code.

    Returns a copy of this instance with a new status-code.

    Definition Classes
    HttpResponse → HttpResponse

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 HttpResponse 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:
    (httpResponse: HttpMessageScalaDSLSugar).discardEntityBytes()(mat)
    Definition Classes
    HttpMessageScalaDSLSugar

Deprecated Value Members

  1. def copy(status: StatusCode = status, headers: Seq[HttpHeader] = headers, entity: ResponseEntity = entity, protocol: HttpProtocol = protocol): HttpResponse
    Annotations
    @deprecated
    Deprecated

    (Since version Akka HTTP 10.2.0) Use the withXYZ methods instead

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpResponse toStringFormat[HttpResponse] 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.

  3. def →[B](y: B): (HttpResponse, B)
    Implicit
    This member is added by an implicit conversion from HttpResponse toArrowAssoc[HttpResponse] 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 HttpMessage

Inherited from javadsl.model.HttpResponse

Inherited from MessageTransformations[javadsl.model.HttpResponse]

Inherited from javadsl.model.HttpMessage

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion HttpMessageScalaDSLSugar fromHttpResponse to HttpMessageScalaDSLSugar

Inherited by implicit conversion any2stringadd fromHttpResponse to any2stringadd[HttpResponse]

Inherited by implicit conversion StringFormat fromHttpResponse to StringFormat[HttpResponse]

Inherited by implicit conversion Ensuring fromHttpResponse to Ensuring[HttpResponse]

Inherited by implicit conversion ArrowAssoc fromHttpResponse to ArrowAssoc[HttpResponse]

Ungrouped