Class/Object

akka.http.scaladsl.model

HttpResponse

Related Docs: object HttpResponse | package model

Permalink

final class HttpResponse extends javadsl.model.HttpResponse with HttpMessage

The immutable HTTP response model.

Source
HttpMessage.scala
Linear Supertypes
HttpMessage, javadsl.model.HttpResponse, javadsl.model.HttpMessage.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. All

Instance Constructors

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

    Permalink

Type Members

  1. type DiscardedEntity = javadsl.model.HttpMessage.DiscardedEntity

    Permalink
    Attributes
    protected
    Definition Classes
    HttpMessage

  2. type MessageTransformations[Self] = javadsl.model.HttpMessage.MessageTransformations[Self]

    Permalink
    Attributes
    protected
    Definition Classes
    HttpMessage

  3. type Self = HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpMessage

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to any2stringadd[HttpResponse] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (HttpResponse, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to ArrowAssoc[HttpResponse] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def _1: StatusCode

    Permalink

  7. def _2: Seq[HttpHeader]

    Permalink

  8. def _3: ResponseEntity

    Permalink

  9. def _4: HttpProtocol

    Permalink

  10. def addCredentials(credentials: HttpCredentials): Self

    Permalink
    Definition Classes
    HttpMessage

  11. def addHeader(header: javadsl.model.HttpHeader): Self

    Permalink
    Definition Classes
    HttpMessage

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

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage

  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. def connectionCloseExpected: Boolean

    Permalink

    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

  16. def copy(status: StatusCode = status, headers: Seq[HttpHeader] = headers, entity: ResponseEntity = entity, protocol: HttpProtocol = protocol): HttpResponse

    Permalink

  17. def discardEntityBytes(mat: Materializer): HttpMessage.DiscardedEntity

    Permalink

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

  18. def encoding: HttpEncoding

    Permalink

    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

  19. def ensuring(cond: (HttpResponse) ⇒ Boolean, msg: ⇒ Any): HttpResponse

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to Ensuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: (HttpResponse) ⇒ Boolean): HttpResponse

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to Ensuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  21. def ensuring(cond: Boolean, msg: ⇒ Any): HttpResponse

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to Ensuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  22. def ensuring(cond: Boolean): HttpResponse

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to Ensuring[HttpResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  23. val entity: ResponseEntity

    Permalink
    Definition Classes
    HttpResponse → HttpMessage → HttpResponse → HttpMessage

  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    HttpResponse → AnyRef → Any

  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  27. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to StringFormat[HttpResponse] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  29. def getHeader(headerName: String): Optional[javadsl.model.HttpHeader]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage

  30. def getHeader[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Optional[T]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage

  31. def getHeaders[T <: javadsl.model.HttpHeader](headerClass: Class[T]): Iterable[T]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage

  32. def getHeaders(): Iterable[javadsl.model.HttpHeader]

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage → HttpMessage

  33. def hashCode(): Int

    Permalink
    Definition Classes
    HttpResponse → AnyRef → Any

  34. def header[T >: Null <: javadsl.model.HttpHeader](implicit arg0: ClassTag[T]): Option[T]

    Permalink

    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

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

    Permalink

    Returns all the headers of the given type *

    Returns all the headers of the given type *

    Definition Classes
    HttpMessage

  36. val headers: Seq[HttpHeader]

    Permalink
    Definition Classes
    HttpResponse → HttpMessage

  37. val httpMessage: HttpMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to HttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in akka.http.scaladsl.model.HttpMessage.
    Definition Classes
    HttpMessageScalaDSLSugar

  38. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  39. def isRequest(): Boolean

    Permalink
    Definition Classes
    HttpResponse → HttpMessage → HttpMessage

  40. def isResponse(): Boolean

    Permalink
    Definition Classes
    HttpResponse → HttpMessage → HttpMessage

  41. def mapEntity(f: (ResponseEntity) ⇒ ResponseEntity): HttpResponse

    Permalink

  42. def mapHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): Self

    Permalink

    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

  43. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  44. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  45. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  46. val protocol: HttpProtocol

    Permalink
    Definition Classes
    HttpResponse → HttpMessage → HttpMessage

  47. def removeHeader(headerName: String): Self

    Permalink

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

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

    Definition Classes
    HttpMessage

  48. def self: HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpMessage

  49. val status: StatusCode

    Permalink
    Definition Classes
    HttpResponse → HttpResponse

  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

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

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage

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

    Permalink

    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

  53. def toString(): String

    Permalink
    Definition Classes
    HttpResponse → AnyRef → Any

  54. def transformEntityDataBytes[T](transformer: Graph[FlowShape[ByteString, ByteString], T]): HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpMessage → MessageTransformations

  55. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  56. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  57. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  58. def withDefaultHeaders(defaultHeaders: Seq[HttpHeader]): Self

    Permalink

    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

  59. def withDefaultHeaders(defaultHeaders: HttpHeader*): Self

    Permalink

    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

  60. def withEntity(entity: javadsl.model.RequestEntity): HttpResponse

    Permalink
    Definition Classes
    HttpResponse → MessageTransformations

  61. def withEntity(entity: MessageEntity): HttpResponse

    Permalink

    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

  62. def withEntity(entity: javadsl.model.ResponseEntity): HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpResponse

  63. def withEntity(contentType: javadsl.model.ContentType, file: Path): Self

    Permalink
    Definition Classes
    HttpMessage

  64. def withEntity(contentType: javadsl.model.ContentType, file: File): Self

    Permalink
    Definition Classes
    HttpMessage

  65. def withEntity(contentType: javadsl.model.ContentType, bytes: ByteString): Self

    Permalink
    Definition Classes
    HttpMessage

  66. def withEntity(contentType: javadsl.model.ContentType, bytes: Array[Byte]): Self

    Permalink
    Definition Classes
    HttpMessage

  67. def withEntity(contentType: NonBinary, string: String): Self

    Permalink
    Definition Classes
    HttpMessage

  68. def withEntity(bytes: ByteString): Self

    Permalink
    Definition Classes
    HttpMessage

  69. def withEntity(bytes: Array[Byte]): Self

    Permalink
    Definition Classes
    HttpMessage

  70. def withEntity(string: String): Self

    Permalink
    Definition Classes
    HttpMessage

  71. def withHeaders(headers: Seq[HttpHeader]): HttpResponse

    Permalink

    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

  72. def withHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Permalink

    Java API

    Java API

    Definition Classes
    HttpMessage

  73. def withHeaders(headers: HttpHeader*): Self

    Permalink

    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
    HttpMessage

  74. def withHeadersAndEntity(headers: Seq[HttpHeader], entity: ResponseEntity): HttpResponse

    Permalink

  75. def withHeadersAndEntity(headers: Seq[HttpHeader], entity: MessageEntity): HttpResponse

    Permalink

    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

  76. def withProtocol(protocol: HttpProtocol): HttpResponse

    Permalink

  77. def withProtocol(protocol: javadsl.model.HttpProtocol): javadsl.model.HttpResponse

    Permalink
    Definition Classes
    HttpResponse → MessageTransformations

  78. def withStatus(statusCode: javadsl.model.StatusCode): HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpResponse

  79. def withStatus(statusCode: Int): HttpResponse

    Permalink
    Definition Classes
    HttpResponse → HttpResponse

  80. def →[B](y: B): (HttpResponse, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HttpResponse to ArrowAssoc[HttpResponse] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def discardEntityBytes()(implicit mat: Materializer): HttpMessage.DiscardedEntity

    Permalink

    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.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 information
    This member is added by an implicit conversion from HttpResponse to HttpMessageScalaDSLSugar performed by method HttpMessageScalaDSLSugar in akka.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

Inherited from HttpMessage

Inherited from javadsl.model.HttpResponse

Inherited from javadsl.model.HttpMessage.MessageTransformations[javadsl.model.HttpResponse]

Inherited from javadsl.model.HttpMessage

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion HttpMessageScalaDSLSugar from HttpResponse to HttpMessageScalaDSLSugar

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

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

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

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

Ungrouped