trait HttpRequest extends HttpMessage with MessageBuilder[HttpRequest]
- Alphabetic
- By Inheritance
- HttpRequest
- MessageBuilder
- HttpMessage
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type LineType = RequestLine
Type of start line in message
Type of start line in message
- Definition Classes
- HttpRequest → HttpMessage
Abstract Value Members
- abstract def attributes: Map[String, Any]
Gets message attributes.
Gets message attributes.
- Definition Classes
- HttpMessage
- Note
Attributes are arbitrary values associated with message and are not part of transmitted message.
- abstract def body: Entity
Gets message body.
Gets message body.
- Definition Classes
- HttpMessage
- abstract def headers: Seq[Header]
Gets message headers.
Gets message headers.
- Definition Classes
- HttpMessage
- abstract def path: String
Gets target path.
- abstract def query: QueryString
Gets query string.
- abstract def startLine: LineType
Gets message start line.
Gets message start line.
- Definition Classes
- HttpMessage
- abstract def withAttributes(attributes: Map[String, Any]): HttpRequest
Creates message with supplied attributes.
Creates message with supplied attributes.
- attributes
message attributes
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous attributes are removed.
- abstract def withBody(body: Entity): HttpRequest
Creates message with supplied body.
Creates message with supplied body.
- body
message body
- returns
new message
- Definition Classes
- MessageBuilder
- abstract def withHeaders(headers: Seq[Header]): HttpRequest
Creates message with supplied headers.
Creates message with supplied headers.
- headers
message headers
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous headers are removed.
- abstract def withMethod(method: RequestMethod): HttpRequest
Creates request with new method.
Creates request with new method.
- returns
new request
- abstract def withPath(path: String): HttpRequest
Creates request with new target path.
Creates request with new target path.
- returns
new request
- abstract def withQuery(params: Seq[(String, String)]): HttpRequest
Creates request with new query using supplied parameters.
Creates request with new query using supplied parameters.
- returns
new request
- abstract def withQuery(params: Map[String, Seq[String]]): HttpRequest
Creates request with new query using supplied parameters.
Creates request with new query using supplied parameters.
- returns
new request
- abstract def withQuery(query: QueryString): HttpRequest
Creates request with new query.
Creates request with new query.
- returns
new request
- abstract def withStartLine(startLine: LineType): HttpRequest
Creates message with supplied start line.
Creates message with supplied start line.
- startLine
message start line
- returns
new message
- Definition Classes
- MessageBuilder
- abstract def withTarget(target: Uri): HttpRequest
Creates request with new target.
Creates request with new target.
- returns
new request
- abstract def withVersion(version: HttpVersion): HttpRequest
Creates request with new HTTP version.
Creates request with new HTTP version.
- returns
new request
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addHeaders(one: Header, more: Header*): HttpRequest
Creates message with additional headers.
Creates message with additional headers.
- one
message header
- more
additional message headers
- returns
new message
- Definition Classes
- MessageBuilder
- def addHeaders(headers: Seq[Header]): HttpRequest
Creates message with additional headers.
Creates message with additional headers.
- headers
message headers
- returns
new message
- Definition Classes
- MessageBuilder
- def addOptionalHeader(name: String, value: Option[String]): HttpRequest
Creates message with additional header, if value supplied.
Creates message with additional header, if value supplied.
- name
header name
- value
optional header value
- returns
new message
- Definition Classes
- MessageBuilder
- def as[T](implicit parser: BodyParser[T]): T
Gets message body as instance of
T
. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getAttribute[T](name: String): Option[T]
Gets attribute value with given name.
- def getAttributeOrElse[T](name: String, default: => T): T
Gets attribute value with given name, or returns default if attribute not present.
Gets attribute value with given name, or returns default if attribute not present.
- name
attribute name
- default
default value
- Definition Classes
- HttpMessage
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getHeader(name: String): Option[Header]
Gets first header with given name.
Gets first header with given name.
- Definition Classes
- HttpMessage
- def getHeaderOrElse(name: String, default: => Header): Header
Gets first header with given name, or returns default if header not present.
Gets first header with given name, or returns default if header not present.
- Definition Classes
- HttpMessage
- def getHeaderValue(name: String): Option[String]
Gets first header value with given name.
Gets first header value with given name.
- Definition Classes
- HttpMessage
- def getHeaderValueOrElse(name: String, default: => String): String
Gets first header value with given name, or returns default if header not present.
Gets first header value with given name, or returns default if header not present.
- Definition Classes
- HttpMessage
- def getHeaderValues(name: String): Seq[String]
Gets header values with given name.
Gets header values with given name.
- Definition Classes
- HttpMessage
- def getHeaders(name: String): Seq[Header]
Gets headers with given name.
Gets headers with given name.
- Definition Classes
- HttpMessage
- def hasHeader(name: String): Boolean
Tests for header with given name.
Tests for header with given name.
- Definition Classes
- HttpMessage
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isConnect: Boolean
Tests for CONNECT method.
- def isDelete: Boolean
Tests for DELETE method.
- def isGet: Boolean
Tests for GET method.
- def isHead: Boolean
Tests for HEAD method.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isOptions: Boolean
Tests for OPTIONS method.
- def isPatch: Boolean
Tests for PATCH method.
- def isPost: Boolean
Tests for POST method.
- def isPut: Boolean
Tests for PUT method.
- def isTrace: Boolean
Tests for TRACE method.
- def method: RequestMethod
Gets request method.
- 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()
- def removeAttributes(one: String, more: String*): HttpRequest
Creates message excluding attributes with given names.
Creates message excluding attributes with given names.
- one
attribute name
- more
additional attribute names
- returns
new message
- Definition Classes
- MessageBuilder
- def removeAttributes(names: Seq[String]): HttpRequest
Creates message excluding attributes with given names.
Creates message excluding attributes with given names.
- names
attribute names
- returns
new message
- Definition Classes
- MessageBuilder
- def removeHeaders(one: String, more: String*): HttpRequest
Creates message excluding headers with given names.
Creates message excluding headers with given names.
- one
header name
- more
additional header names
- returns
new message
- Definition Classes
- MessageBuilder
- def removeHeaders(names: Seq[String]): HttpRequest
Creates message excluding headers with given names.
Creates message excluding headers with given names.
- names
header names
- returns
new message
- Definition Classes
- MessageBuilder
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def target: Uri
Gets request target.
- def toString(): String
- Definition Classes
- AnyRef → Any
- def version: HttpVersion
Gets HTTP version.
Gets HTTP version.
- Definition Classes
- HttpMessage
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAttribute(attribute: (String, Any)): HttpRequest
Creates message with supplied attribute.
Creates message with supplied attribute.
- attribute
name/value pair
- returns
new message
- Definition Classes
- MessageBuilder
- Note
If attribute already exists, its value is replaced.
- def withAttributes(one: (String, Any), more: (String, Any)*): HttpRequest
Creates message with supplied attributes.
Creates message with supplied attributes.
- one
message attribute
- more
additional message attributes
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous attributes are removed.
- def withHeader(header: Header): HttpRequest
Creates message with supplied header.
Creates message with supplied header.
- header
message header
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous headers with same name are removed.
- def withHeaders(one: Header, more: Header*): HttpRequest
Creates message with supplied headers.
Creates message with supplied headers.
- one
message header
- more
additional message headers
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous headers are removed.
- def withOptionalHeader(name: String, value: Option[String]): HttpRequest
Creates message with optional header.
Creates message with optional header.
- name
header name
- value
optional header value
- returns
new message
- Definition Classes
- MessageBuilder
- Note
All previous headers with same name are removed; if no value is supplied, then no header is added.
- def withQuery(one: (String, String), more: (String, String)*): HttpRequest
Creates request with new query using supplied parameters.
Creates request with new query using supplied parameters.
- returns
new request
Provided herein is API documentation for Scamper, the HTTP library for Scala.