sealed trait RequestHeader extends MessageHeader

A request header.

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.

Source
MessageHeader.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestHeader
  2. MessageHeader
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val acceptedResponseProtocols: Seq[MessageProtocol]

    The accepted response protocols for this request.

  2. abstract def addHeader(name: String, value: String): RequestHeader

    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
    RequestHeaderMessageHeader
  3. abstract def clearPrincipal: RequestHeader

    Return a copy of this request header with the principal cleared.

    Return a copy of this request header with the principal cleared.

    returns

    A copy of this request header.

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

    The header map for the message.

    The header map for the message.

    Definition Classes
    MessageHeader
  5. abstract val method: Method

    The method used to make this request.

  6. abstract val principal: Option[Principal]

    The principal for this request, if there is one.

  7. abstract val protocol: MessageProtocol

    The protocol of the message.

    The protocol of the message.

    Definition Classes
    MessageHeader
  8. abstract def removeHeader(name: String): RequestHeader

    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
    RequestHeaderMessageHeader
  9. abstract val uri: URI

    The URI for this request.

  10. abstract def withAcceptedResponseProtocols(acceptedResponseProtocols: Seq[MessageProtocol]): RequestHeader

    Return a copy of this request header with the given accepted response protocols set.

    Return a copy of this request header with the given accepted response protocols set.

    acceptedResponseProtocols

    The accepted response protocols to set.

    returns

    A copy of this request header.

  11. abstract def withHeader(name: String, value: String): RequestHeader

    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
    RequestHeaderMessageHeader
  12. abstract def withHeaders(headers: Seq[(String, String)]): RequestHeader

    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
    RequestHeaderMessageHeader
  13. abstract def withMethod(method: Method): RequestHeader

    Return a copy of this request header with the given method set.

    Return a copy of this request header with the given method set.

    method

    The method to set.

    returns

    A copy of this request header.

  14. abstract def withPrincipal(principal: Principal): RequestHeader

    Return a copy of this request header with the principal set.

    Return a copy of this request header with the principal set.

    principal

    The principal to set.

    returns

    A copy of this request header.

  15. abstract def withProtocol(protocol: MessageProtocol): RequestHeader

    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
    RequestHeaderMessageHeader
  16. abstract def withUri(uri: URI): RequestHeader

    Return a copy of this request header with the given uri set.

    Return a copy of this request header with the given uri set.

    uri

    The uri to set.

    returns

    A copy of this request header.

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 RequestHeader to any2stringadd[RequestHeader] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RequestHeader, B)
    Implicit
    This member is added by an implicit conversion from RequestHeader to ArrowAssoc[RequestHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def ensuring(cond: (RequestHeader) ⇒ Boolean, msg: ⇒ Any): RequestHeader
    Implicit
    This member is added by an implicit conversion from RequestHeader to Ensuring[RequestHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RequestHeader) ⇒ Boolean): RequestHeader
    Implicit
    This member is added by an implicit conversion from RequestHeader to Ensuring[RequestHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): RequestHeader
    Implicit
    This member is added by an implicit conversion from RequestHeader to Ensuring[RequestHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RequestHeader
    Implicit
    This member is added by an implicit conversion from RequestHeader to Ensuring[RequestHeader] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RequestHeader to StringFormat[RequestHeader] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getHeader(name: String): Option[String]

    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
  18. def getHeaders(name: String): Seq[String]

    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
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def headers: Iterable[(String, String)]

    Get all the headers for the message.

    Get all the headers for the message.

    Definition Classes
    MessageHeader
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. def [B](y: B): (RequestHeader, B)
    Implicit
    This member is added by an implicit conversion from RequestHeader to ArrowAssoc[RequestHeader] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from MessageHeader

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped