final class HttpResponse extends javadsl.model.HttpResponse with HttpMessage

The immutable HTTP response model.

Source
HttpMessage.scala
Linear Supertypes
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)

Type Members

  1. type MessageTransformations[Self] = javadsl.model.HttpMessage.MessageTransformations[Self]
    Attributes
    protected
    Definition Classes
    HttpMessage
  2. type Self = HttpResponse
    Definition Classes
    HttpResponseHttpMessage

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 to any2stringadd[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 to ArrowAssoc[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 addCredentials(credentials: HttpCredentials): Self
    Definition Classes
    HttpMessage
  11. def addHeader(header: javadsl.model.HttpHeader): Self
    Definition Classes
    HttpMessage
  12. def addHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  15. 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
  16. def copy(status: StatusCode = status, headers: Seq[HttpHeader] = headers, entity: ResponseEntity = entity, protocol: HttpProtocol = protocol): HttpResponse
  17. 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 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
    HttpMessageHttpMessage
  18. 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
  19. def ensuring(cond: (HttpResponse) ⇒ Boolean, msg: ⇒ Any): HttpResponse
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Implicit
    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

    The entity of this message.

    The entity of this message.

    Definition Classes
    HttpResponseHttpMessageHttpResponseHttpMessage
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(obj: Any): Boolean
    Definition Classes
    HttpResponse → AnyRef → Any
  26. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def formatted(fmtstr: String): String
    Implicit
    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[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def getHeader(headerName: String): Optional[javadsl.model.HttpHeader]

    Java API

    Java API

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

    Java API

    Java API

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

    Java API

    Java API

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

    Java API

    Java API

    Definition Classes
    HttpMessageHttpMessage
  33. def hashCode(): Int
    Definition Classes
    HttpResponse → AnyRef → Any
  34. 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
  35. 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
  36. val headers: Seq[HttpHeader]
    Definition Classes
    HttpResponseHttpMessage
  37. val httpMessage: HttpMessage
    Implicit
    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
    Definition Classes
    Any
  39. def isRequest(): Boolean

    Is this instance a request.

    Is this instance a request.

    Definition Classes
    HttpResponseHttpMessageHttpMessage
  40. def isResponse(): Boolean

    Is this instance a response.

    Is this instance a response.

    Definition Classes
    HttpResponseHttpMessageHttpMessage
  41. def mapEntity(f: (ResponseEntity) ⇒ ResponseEntity): HttpResponse
  42. 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
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. val protocol: HttpProtocol

    The protocol of this message.

    The protocol of this message.

    Definition Classes
    HttpResponseHttpMessageHttpMessage
  47. 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
  48. def self: HttpResponse
    Definition Classes
    HttpResponseHttpMessage
  49. val status: StatusCode

    Returns the status-code of this response.

    Returns the status-code of this response.

    Definition Classes
    HttpResponseHttpResponse
  50. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  51. def toStrict(timeoutMillis: Long, ec: Executor, materializer: Materializer): CompletionStage[Self]

    Java API

    Java API

    Definition Classes
    HttpMessage
  52. 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
  53. def toString(): String
    Definition Classes
    HttpResponse → AnyRef → Any
  54. 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
    HttpResponseHttpMessage → MessageTransformations
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  58. 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
  59. def withDefaultHeaders(defaultHeaders: 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
  60. 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
  61. 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
    HttpResponseHttpMessage
  62. 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
    HttpResponseHttpResponse
  63. def withEntity(contentType: javadsl.model.ContentType, file: Path): Self
    Definition Classes
    HttpMessage
  64. def withEntity(contentType: javadsl.model.ContentType, file: File): Self
    Definition Classes
    HttpMessage
  65. def withEntity(contentType: javadsl.model.ContentType, bytes: ByteString): Self
    Definition Classes
    HttpMessage
  66. def withEntity(contentType: javadsl.model.ContentType, bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  67. def withEntity(contentType: NonBinary, string: String): Self
    Definition Classes
    HttpMessage
  68. def withEntity(bytes: ByteString): Self
    Definition Classes
    HttpMessage
  69. def withEntity(bytes: Array[Byte]): Self
    Definition Classes
    HttpMessage
  70. def withEntity(string: String): Self
    Definition Classes
    HttpMessage
  71. 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
    HttpResponseHttpMessage
  72. def withHeaders(headers: Iterable[javadsl.model.HttpHeader]): Self

    Java API

    Java API

    Definition Classes
    HttpMessage
  73. def withHeaders(headers: HttpHeader*): Self

    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
  75. 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
    HttpResponseHttpMessage
  76. def withProtocol(protocol: HttpProtocol): HttpResponse
  77. 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
  78. 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
    HttpResponseHttpResponse
  79. 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
    HttpResponseHttpResponse
  80. def [B](y: B): (HttpResponse, B)
    Implicit
    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): 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.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 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.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