com.sksamuel.scruffy

HttpRequest

case class HttpRequest(uri: Uri, method: HttpMethod, entity: Array[Byte] = scala.Array.emptyByteArray, headers: List[Header] = immutable.this.Nil, response: HttpResponse = HttpResponse.ok, properties: Map[PropertyKey[Any], Any] = ..., context: ScruffyContext = ScruffyContext.apply()) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpRequest(uri: Uri, method: HttpMethod, entity: Array[Byte] = scala.Array.emptyByteArray, headers: List[Header] = immutable.this.Nil, response: HttpResponse = HttpResponse.ok, properties: Map[PropertyKey[Any], Any] = ..., context: ScruffyContext = ScruffyContext.apply())

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def contentType: Option[String]

  9. val context: ScruffyContext

  10. def cookie(name: String): Option[Cookie]

  11. def cookieValue(name: String): Option[String]

  12. lazy val cookies: List[Cookie]

  13. val entity: Array[Byte]

  14. def entityAs[F](implicit arg0: Manifest[F]): F

    Returns the entity/payload of the request, marshalled into an instance of the given type parameter.

    Returns the entity/payload of the request, marshalled into an instance of the given type parameter. For example, given a case class Customer then entityAs[Customer] would attempt to marshall the entity into an instance of Customer.

    The marshaller is chosen by the registered marshallers.

    returns

    the entity as the marshalled type.

  15. def entityStream: InputStream

  16. def entityString: String

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

    Definition Classes
    AnyRef
  18. def etag: Option[String]

  19. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  21. def hasCookie(name: String): Boolean

  22. def hasHeader(name: String): Boolean

  23. def hasHeader(name: HeaderName): Boolean

  24. def hasProperty(key: PropertyKey[_]): Boolean

    Returns true if the request has a property value set for the given property key

    Returns true if the request has a property value set for the given property key

    key

    the property to test for

  25. def header(name: String): Option[String]

  26. def header(name: HeaderName): Option[String]

    Returns the optional header for the given HeaderName

    Returns the optional header for the given HeaderName

    returns

    the matching header of None

  27. val headers: List[Header]

  28. def id: RequestId

  29. def idOpt: Option[RequestId]

  30. def ipAddress: String

  31. def ipAddressOpt: Option[String]

  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. def isSecure: Boolean

  34. def mediaType: Option[MediaType]

  35. val method: HttpMethod

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

    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  39. def pathParam(name: String): String

  40. def pathParams: Map[String, String]

  41. val properties: Map[PropertyKey[Any], Any]

  42. def property[T](key: PropertyKey[T]): T

    Returns the property value for the given property key.

    Returns the property value for the given property key.

    key

    the property to test for

  43. def propertyOption[T](key: PropertyKey[T]): Option[T]

  44. def queryParam(name: String): Option[String]

  45. def queryParams: Seq[Parameter]

  46. def queryParams(name: String): Seq[String]

  47. def queryParamsAs[P <: Product](implicit arg0: Manifest[P]): P

  48. def referer: Option[String]

  49. val response: HttpResponse

  50. def session: Session

  51. def sessionOpt: Option[Session]

  52. def skipped: HttpRequest

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

    Definition Classes
    AnyRef
  54. val uri: Uri

  55. def userAgent: Option[String]

  56. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. def withHeader(name: HeaderName, value: String): HttpRequest

    Adds a header to the Will replace any existing value for that header.

    Adds a header to the Will replace any existing value for that header.

    returns

    returns the new request with the added header

  60. def withProperty[T](key: PropertyKey[T], value: T): HttpRequest

    Adds a property to the Will replace any existing value for that property.

    Adds a property to the Will replace any existing value for that property.

    returns

    returns the new request with the added property

  61. def withResponse(response: HttpResponse): HttpRequest

  62. def withSession(session: Session): HttpRequest

  63. def withoutHeader(name: HeaderName): HttpRequest

  64. def withoutHeader(name: String): HttpRequest

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped