com.sksamuel.scruffy

HttpRequest

case class HttpRequest(entityBytes: Array[Byte], method: HttpMethod, uri: Uri, headers: Set[Header], properties: Map[PropertyKey[Any], Any], ipAddress: String, responseCookies: Map[String, String] = Map.empty, session: Option[Session], response: Option[HttpResponse] = None, marshallers: Iterable[Marshaller] = Nil) extends Dynamic with Product with Serializable

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

Instance Constructors

  1. new HttpRequest(entityBytes: Array[Byte], method: HttpMethod, uri: Uri, headers: Set[Header], properties: Map[PropertyKey[Any], Any], ipAddress: String, responseCookies: Map[String, String] = Map.empty, session: Option[Session], response: Option[HttpResponse] = None, marshallers: Iterable[Marshaller] = Nil)

Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

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

  9. lazy val cookies: Set[Cookie]

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

    Returns the entity/payload of the request, marshalled into the format identified by the current type parameter of the request.

    Returns the entity/payload of the request, marshalled into the format identified by the current type parameter of the request.

    returns

    the entity as the marshalled type.

  11. val entityBytes: Array[Byte]

  12. def entityStream: ByteArrayInputStream

    Returns the entity/payload of the request as a ByteArrayInputStream

  13. def entityString: String

    Returns the entity/payload of the request as a UTF-8 encoded String.

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

    Definition Classes
    AnyRef
  15. def etag: Option[Header]

  16. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  18. def group(name: String): String

  19. def groups: Map[String, String]

  20. def hasProperty(key: PropertyKey[Any]): 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

  21. def header(name: HeaderName): Option[Header]

    Returns the optional value for the given header name.

    Returns the optional value for the given header name.

    returns

    the value or none for the header identified by the given key.

  22. def header(name: String): Option[Header]

    Returns the optional header for the given header name.

  23. def headerValue(name: String): Option[String]

  24. def headerValue(name: HeaderName): Option[String]

  25. val headers: Set[Header]

  26. val ipAddress: String

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. def isSecure: Boolean

  29. val marshallers: Iterable[Marshaller]

  30. val method: HttpMethod

  31. def methodString: String

    Returns the HTTP Method used in this request as an uppercase string, eg POST.

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

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

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

    Definition Classes
    AnyRef
  35. def param(name: String): Option[String]

  36. def params: Seq[Parameter]

  37. def params(name: String): Seq[String]

  38. def paramsAs[P <: Product](implicit arg0: Manifest[P]): P

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

  40. def property[T](key: PropertyKey[T]): Option[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

  41. def referer: Option[Header]

  42. def responded: Boolean

  43. val response: Option[HttpResponse]

  44. val responseCookies: Map[String, String]

  45. def selectDynamic(name: String): String

  46. val session: Option[Session]

  47. def setHeader(name: HeaderName, value: String): HttpRequest

    Creates a new HttpRequest with the given header added.

    Creates a new HttpRequest with the given header added. If there is already a header with this value, then the header is replaced.

    returns

    the new HttpRequest with the added header.

  48. def skipped: HttpRequest

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

    Definition Classes
    AnyRef
  50. val uri: Uri

  51. def userAgent: Option[Header]

  52. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def withCookie(name: String, v: String): HttpRequest

  56. def withHeader(name: HeaderName, value: String): HttpRequest

    Adds a header to the request.

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

    returns

    returns the new request with the added header

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

  58. def withResponse(response: HttpResponse): HttpRequest

  59. def withSession(session: Session): HttpRequest

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Dynamic

Inherited from AnyRef

Inherited from Any

Ungrouped