Interface CookieDirectives
- All Known Subinterfaces:
Directives
- All Known Implementing Classes:
CookieDirectives$
,Directives$
,HttpApp
public interface CookieDirectives
-
Method Summary
Modifier and TypeMethodDescriptionDirective<scala.Tuple1<HttpCookiePair>>
Extracts theHttpCookiePair
with the given name.Directive<scala.runtime.BoxedUnit>
deleteCookie
(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a {@link Set-Cookie} response header expiring the given cookies.Directive<scala.runtime.BoxedUnit>
deleteCookie
(String name, String domain, String path) Adds a {@link Set-Cookie} response header expiring the cookie with the given properties.scala.Function1<HttpHeader,
scala.Option<HttpCookiePair>> findCookie
(String name) Directive<scala.Tuple1<scala.Option<HttpCookiePair>>>
optionalCookie
(String name) Extracts theHttpCookiePair
with the given name as anOption[HttpCookiePair]
.Directive<scala.runtime.BoxedUnit>
setCookie
(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a {@link Set-Cookie} response header with the given cookies.
-
Method Details
-
cookie
Extracts theHttpCookiePair
with the given name. If the cookie is not present the request is rejected with a respectiveMissingCookieRejection
.- Parameters:
name
- (undocumented)- Returns:
- (undocumented)
-
optionalCookie
Extracts theHttpCookiePair
with the given name as anOption[HttpCookiePair]
. If the cookie is not present a value ofNone
is extracted.- Parameters:
name
- (undocumented)- Returns:
- (undocumented)
-
findCookie
-
setCookie
Directive<scala.runtime.BoxedUnit> setCookie(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a {@link Set-Cookie} response header with the given cookies.- Parameters:
first
- (undocumented)more
- (undocumented)- Returns:
- (undocumented)
-
deleteCookie
Directive<scala.runtime.BoxedUnit> deleteCookie(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a {@link Set-Cookie} response header expiring the given cookies.- Parameters:
first
- (undocumented)more
- (undocumented)- Returns:
- (undocumented)
-
deleteCookie
Adds a {@link Set-Cookie} response header expiring the cookie with the given properties.- Parameters:
name
- (undocumented)domain
- (undocumented)path
- (undocumented)- Returns:
- (undocumented)
-