Class

spray.http

HttpRequest

Related Doc: package http

Permalink

case class HttpRequest(method: HttpMethod = HttpMethods.GET, uri: Uri = Uri./, headers: List[HttpHeader] = Nil, entity: HttpEntity = HttpEntity.Empty, protocol: HttpProtocol = HttpProtocols.`HTTP/1.1`) extends HttpMessage with HttpRequestPart with Product with Serializable

Immutable HTTP request model.

Linear Supertypes
Serializable, Serializable, Product, Equals, HttpRequestPart, HttpMessage, HttpMessageEnd, HttpMessageStart, HttpMessagePart, HttpMessagePartWrapper, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HttpRequestPart
  7. HttpMessage
  8. HttpMessageEnd
  9. HttpMessageStart
  10. HttpMessagePart
  11. HttpMessagePartWrapper
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpRequest(method: HttpMethod = HttpMethods.GET, uri: Uri = Uri./, headers: List[HttpHeader] = Nil, entity: HttpEntity = HttpEntity.Empty, protocol: HttpProtocol = HttpProtocols.`HTTP/1.1`)

    Permalink

Type Members

  1. type Self = HttpRequest

    Permalink
    Definition Classes
    HttpRequestHttpMessage

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. def acceptableContentType(contentTypes: Seq[ContentType]): Option[ContentType]

    Permalink

    Determines whether one of the given content-types is accepted by the client.

    Determines whether one of the given content-types is accepted by the client. If a given ContentType does not define a charset an accepted charset is selected, i.e. the method guarantees that, if a ContentType instance is returned within the option, it will contain a defined charset.

  5. def acceptedCharsetRanges: List[HttpCharsetRange]

    Permalink
  6. def acceptedEncodingRanges: List[HttpEncodingRange]

    Permalink
  7. def acceptedMediaRanges: List[MediaRange]

    Permalink
  8. def ack: None.type

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def asPartStream(maxChunkSize: Long = Long.MaxValue): Stream[HttpMessagePart]

    Permalink

    Returns the message as if it was sent in chunks

    Returns the message as if it was sent in chunks

    Definition Classes
    HttpMessage
  11. def canBeRetried: Boolean

    Permalink
  12. def chunkedMessageStart: ChunkedRequestStart

    Permalink

    Returns the start part for this message

    Returns the start part for this message

    Definition Classes
    HttpRequestHttpMessage
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def connectionCloseExpected: Boolean

    Permalink
    Definition Classes
    HttpMessage
  15. def cookies: List[HttpCookie]

    Permalink
  16. def encoding: HttpEncoding

    Permalink

    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
  17. val entity: HttpEntity

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def header[T <: HttpHeader](implicit arg0: ClassTag[T]): Option[T]

    Permalink
    Definition Classes
    HttpMessage
  22. val headers: List[HttpHeader]

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  23. def isCharsetAccepted(charset: HttpCharset, ranges: List[HttpCharsetRange] = acceptedCharsetRanges): Boolean

    Permalink

    Determines whether the given charset is accepted by the client.

  24. def isEncodingAccepted(encoding: HttpEncoding, ranges: List[HttpEncodingRange] = acceptedEncodingRanges): Boolean

    Permalink

    Determines whether the given encoding is accepted by the client.

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. def isMediaTypeAccepted(mediaType: MediaType, ranges: List[MediaRange] = acceptedMediaRanges): Boolean

    Permalink

    Determines whether the given media-type is accepted by the client.

  27. def isRequest: Boolean

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  28. def isResponse: Boolean

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  29. def mapEntity(f: (HttpEntity) ⇒ HttpEntity): Self

    Permalink
    Definition Classes
    HttpMessage
  30. def mapHeaders(f: (List[HttpHeader]) ⇒ List[HttpHeader]): Self

    Permalink
    Definition Classes
    HttpMessageHttpMessageStart
  31. def message: HttpRequest

    Permalink
    Definition Classes
    HttpRequestHttpMessageHttpMessageStart
  32. def messagePart: HttpMessagePart

    Permalink
  33. val method: HttpMethod

    Permalink
  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. val protocol: HttpProtocol

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  38. def qValueForCharset(charset: HttpCharset, ranges: List[HttpCharsetRange] = acceptedCharsetRanges): Float

    Permalink

    Returns the q-value that the client (implicitly or explicitly) attaches to the given charset.

  39. def qValueForEncoding(encoding: HttpEncoding, ranges: List[HttpEncodingRange] = acceptedEncodingRanges): Float

    Permalink

    Returns the q-value that the client (implicitly or explicitly) attaches to the given encoding.

  40. def qValueForMediaType(mediaType: MediaType, ranges: List[MediaRange] = acceptedMediaRanges): Float

    Permalink

    Returns the q-value that the client (implicitly or explicitly) attaches to the given media-type.

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

    Permalink
    Definition Classes
    AnyRef
  42. val uri: Uri

    Permalink
  43. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def withAck(ack: Any): Confirmed

    Permalink
    Definition Classes
    HttpMessagePart
  47. def withDefaultHeaders(defaultHeaders: List[HttpHeader]): Self

    Permalink
    Definition Classes
    HttpMessage
  48. def withEffectiveUri(securedConnection: Boolean, defaultHostHeader: Host = Host.empty): HttpRequest

    Permalink
  49. def withEntity(entity: HttpEntity): Self

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  50. def withHeaders(headers: List[HttpHeader]): Self

    Permalink
    Definition Classes
    HttpRequestHttpMessage
  51. def withHeaders(headers: HttpHeader*): Self

    Permalink
    Definition Classes
    HttpMessage
  52. def withHeadersAndEntity(headers: List[HttpHeader], entity: HttpEntity): Self

    Permalink
    Definition Classes
    HttpRequestHttpMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HttpRequestPart

Inherited from HttpMessage

Inherited from HttpMessageEnd

Inherited from HttpMessageStart

Inherited from HttpMessagePart

Inherited from HttpMessagePartWrapper

Inherited from AnyRef

Inherited from Any

Ungrouped