Trait/Object

com.lightbend.lagom.scaladsl.api.transport

ResponseHeader

Related Docs: object ResponseHeader | package transport

Permalink

sealed trait ResponseHeader extends MessageHeader

This header may or may not be mapped down onto HTTP. In order to remain agnostic to the underlying protocol, information required by Lagom, such as protocol information, is extracted. It is encouraged that the protocol information always be used in preference to reading the information directly out of headers, since the headers may not contain the necessary protocol information.

The headers are however still provided, in case information needs to be extracted out of non standard headers.

Linear Supertypes
MessageHeader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResponseHeader
  2. MessageHeader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addHeader(name: String, value: String): ResponseHeader

    Permalink

    Return a copy of this message header with the given header added to the map of headers.

    Return a copy of this message header with the given header added to the map of headers.

    If the header already has a value, this value will be added to it.

    name

    The name of the header to add.

    value

    The value of the header to add.

    returns

    The new message header.

    Definition Classes
    ResponseHeader → MessageHeader

  2. abstract val headerMap: Map[String, Seq[(String, String)]]

    Permalink

    The header map for the message.

    The header map for the message.

    Definition Classes
    MessageHeader

  3. abstract val protocol: MessageProtocol

    Permalink

    The protocol of the message.

    The protocol of the message.

    Definition Classes
    MessageHeader

  4. abstract def removeHeader(name: String): ResponseHeader

    Permalink

    Return a copy of this message header with the given header removed from the map of headers.

    Return a copy of this message header with the given header removed from the map of headers.

    name

    The name of the header to remove.

    returns

    The new message header.

    Definition Classes
    ResponseHeader → MessageHeader

  5. abstract val status: Int

    Permalink

    The status code of the response.

  6. abstract def withHeader(name: String, value: String): ResponseHeader

    Permalink

    Return a copy of this message header with the given header added to the map of headers.

    Return a copy of this message header with the given header added to the map of headers.

    If the header already has a value, this value will replace it.

    name

    The name of the header to add.

    value

    The value of the header to add.

    returns

    The new message header.

    Definition Classes
    ResponseHeader → MessageHeader

  7. abstract def withHeaders(headers: Seq[(String, String)]): ResponseHeader

    Permalink

    Return a copy of this message header with the headers replaced by the given headers.

    Return a copy of this message header with the headers replaced by the given headers.

    headers

    The headers.

    returns

    A copy of the message header with the given headers.

    Definition Classes
    ResponseHeader → MessageHeader

  8. abstract def withProtocol(protocol: MessageProtocol): ResponseHeader

    Permalink

    Return a copy of this message header with the given protocol.

    Return a copy of this message header with the given protocol.

    protocol

    The protocol to set.

    returns

    A copy of the message header with the given protocol.

    Definition Classes
    ResponseHeader → MessageHeader

  9. abstract def withStatus(status: Int): ResponseHeader

    Permalink

    Return a copy of this response with the given status code.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getHeader(name: String): Option[String]

    Permalink

    Get the header with the given name.

    Get the header with the given name.

    The lookup is case insensitive.

    name

    The name of the header.

    returns

    The header value.

    Definition Classes
    MessageHeader

  11. def getHeaders(name: String): Seq[String]

    Permalink

    Get all the header values for the given header name.

    Get all the header values for the given header name.

    The lookup is case insensitive.

    name

    The name of the header.

    returns

    The header values.

    Definition Classes
    MessageHeader

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. def headers: Iterable[(String, String)]

    Permalink

    Get all the headers for the message.

    Get all the headers for the message.

    Definition Classes
    MessageHeader

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

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

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

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

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

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

Inherited from MessageHeader

Inherited from AnyRef

Inherited from Any

Ungrouped