org.apache.pekko.http.scaladsl.server.directives

Interface CookieDirectives

All Known Subinterfaces:

Directives

All Known Implementing Classes:

CookieDirectives$, Directives$, HttpApp

public interface CookieDirectives

Method Summary

Modifier and Type	Method and Description
Directive<scala.Tuple1<HttpCookiePair>>	cookie(java.lang.String name) Extracts the HttpCookiePair with the given name.
Directive<scala.runtime.BoxedUnit>	deleteCookie(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a Set-Cookie response header expiring the given cookies.
Directive<scala.runtime.BoxedUnit>	deleteCookie(java.lang.String name, java.lang.String domain, java.lang.String path) Adds a Set-Cookie response header expiring the cookie with the given properties.
scala.Function1<HttpHeader,scala.Option<HttpCookiePair>>	findCookie(java.lang.String name)
Directive<scala.Tuple1<scala.Option<HttpCookiePair>>>	optionalCookie(java.lang.String name) Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair].
Directive<scala.runtime.BoxedUnit>	setCookie(HttpCookie first, scala.collection.immutable.Seq<HttpCookie> more) Adds a Set-Cookie response header with the given cookies.

Method Detail

cookie

Directive<scala.Tuple1<HttpCookiePair>> cookie(java.lang.String name)

Extracts the HttpCookiePair with the given name. If the cookie is not present the request is rejected with a respective MissingCookieRejection.

Parameters:

name - (undocumented)

Returns:

(undocumented)

optionalCookie

Directive<scala.Tuple1<scala.Option<HttpCookiePair>>> optionalCookie(java.lang.String name)

Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair]. If the cookie is not present a value of None is extracted.

Parameters:

name - (undocumented)

Returns:

(undocumented)

findCookie

scala.Function1<HttpHeader,scala.Option<HttpCookiePair>> findCookie(java.lang.String name)

setCookie

Directive<scala.runtime.BoxedUnit> setCookie(HttpCookie first,
                                             scala.collection.immutable.Seq<HttpCookie> more)

Adds a 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 Set-Cookie response header expiring the given cookies.

Parameters:

first - (undocumented)

more - (undocumented)

Returns:

(undocumented)

deleteCookie

Directive<scala.runtime.BoxedUnit> deleteCookie(java.lang.String name,
                                                java.lang.String domain,
                                                java.lang.String path)

Adds a Set-Cookie response header expiring the cookie with the given properties.

Parameters:

name - (undocumented)

domain - (undocumented)

path - (undocumented)

Returns:

(undocumented)