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
- Alphabetic
- By Inheritance
- RequestHeader
- MessageHeader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
acceptedResponseProtocols: Seq[MessageProtocol]
The accepted response protocols for this request.
-
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
- RequestHeader → MessageHeader
-
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.
-
abstract
val
headerMap: Map[String, Seq[(String, String)]]
The header map for the message.
The header map for the message.
- Definition Classes
- MessageHeader
-
abstract
val
method: Method
The method used to make this request.
-
abstract
val
principal: Option[Principal]
The principal for this request, if there is one.
-
abstract
val
protocol: MessageProtocol
The protocol of the message.
The protocol of the message.
- Definition Classes
- MessageHeader
-
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
- RequestHeader → MessageHeader
-
abstract
val
uri: URI
The URI for this request.
-
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.
-
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
- RequestHeader → MessageHeader
-
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
- RequestHeader → MessageHeader
-
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.
-
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.
-
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
- RequestHeader → MessageHeader
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
headers: Iterable[(String, String)]
Get all the headers for the message.
Get all the headers for the message.
- Definition Classes
- MessageHeader
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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