RequestCookies

scamper.http.cookies.RequestCookies
final class RequestCookies(request: HttpRequest) extends AnyVal

Adds standardized access to cookies in Cookie header.

In HttpRequest, cookies are stringed together in the Cookie header. You can access them using extension methods provided by RequestCookies, with each cookie represented as PlainCookie.

import scala.language.implicitConversions

import scamper.http.RequestMethod.Registry.Get
import scamper.http.cookies.{ PlainCookie, toRequestCookies }
import scamper.http.stringToUri

// Build request with cookies
val req = Get("https://localhost:8080/motd").setCookies(
 PlainCookie("ID", "bG9zCg"), PlainCookie("Region", "SE-US")
)

// Print all cookies
req.cookies.foreach(println)

// Get cookies by name
val id: Option[PlainCookie] = req.getCookie("ID")
val region: Option[PlainCookie] = req.getCookie("Region")

// Get cookie values by name
assert(req.getCookieValue("ID").contains("bG9zCg"))
assert(req.getCookieValue("Region").contains("SE-US"))

Attributes

Graph
Supertypes
class AnyVal
trait Matchable
class Any

Members list

Value members

Concrete methods

def cookies: Seq[PlainCookie]

Gets cookies.

Gets cookies.

Attributes

def getCookie(name: String): Option[PlainCookie]

Gets specified cookie.

Gets specified cookie.

Value parameters

name

cookie name

Attributes

def getCookieValue(name: String): Option[String]

Gets value of specified cookie.

Gets value of specified cookie.

Value parameters

name

cookie name

Attributes

def putCookies(cookies: Seq[PlainCookie]): HttpRequest

Creates copy of request with supplied cookie.

Creates copy of request with supplied cookie.

Value parameters

cookies

new cookies

Attributes

Note

Previous cookies with same name are removed.

Creates copy of request with supplied cookies.

Creates copy of request with supplied cookies.

Value parameters

more

additional cookies

one

cookie

Attributes

Note

Previous cookies with same name are removed.

def removeCookies(names: Seq[String]): HttpRequest

Creates copy of request excluding cookies with given names.

Creates copy of request excluding cookies with given names.

Value parameters

names

cookie names

Attributes

def removeCookies(one: String, more: String*): HttpRequest

Creates copy of request excluding cookies with given names.

Creates copy of request excluding cookies with given names.

Value parameters

more

additional cookie names

one

cookie name

Attributes

def setCookies(cookies: Seq[PlainCookie]): HttpRequest

Creates copy of request with new set of cookies.

Creates copy of request with new set of cookies.

Value parameters

cookies

new set of cookies

Attributes

Note

All previous cookies are removed.

Creates copy of request with new set of cookies.

Creates copy of request with new set of cookies.

Value parameters

more

additional new cookies

one

new cookie

Attributes

Note

All previous cookies are removed.