org.apache.pekko.http.javadsl.server.directives

Class CookieDirectives

java.lang.Object

org.apache.pekko.http.javadsl.server.directives.BasicDirectives

org.apache.pekko.http.javadsl.server.directives.CacheConditionDirectives

org.apache.pekko.http.javadsl.server.directives.CodingDirectives

org.apache.pekko.http.javadsl.server.directives.CookieDirectives

Direct Known Subclasses:

DebuggingDirectives

public abstract class CookieDirectives
extends CodingDirectives

Constructor Summary

Constructors

Constructor and Description
CookieDirectives()

Method Summary

Modifier and Type	Method and Description
Route	cookie(java.lang.String name, java.util.function.Function<HttpCookiePair,Route> inner) Extracts the HttpCookiePair with the given name.
Route	deleteCookie(HttpCookie cookie, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header expiring the given cookie.
Route	deleteCookie(java.lang.Iterable<HttpCookie> cookies, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header expiring the given cookies.
Route	deleteCookie(java.lang.String name, java.lang.String domain, java.lang.String path, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header expiring the cookie with the given properties.
Route	deleteCookie(java.lang.String name, java.lang.String domain, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header expiring the cookie with the given properties.
Route	deleteCookie(java.lang.String name, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header expiring the cookie with the given properties.
Route	optionalCookie(java.lang.String name, java.util.function.Function<java.util.Optional<HttpCookiePair>,Route> inner) Extracts the HttpCookiePair with the given name as an Option[HttpCookiePair].
Route	setCookie(HttpCookie cookie, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header with the given cookie.
Route	setCookie(java.lang.Iterable<HttpCookie> cookies, java.util.function.Supplier<Route> inner) Adds a Set-Cookie response header with the given cookies.

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.CodingDirectives

decodeRequest, decodeRequestWith, decodeRequestWith, encodeResponse, encodeResponseWith, requestEncodedWith, responseEncodingAccepted, withPrecompressedMediaTypeSupport

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.CacheConditionDirectives

conditional, conditional, conditional, conditional

Methods inherited from class org.apache.pekko.http.javadsl.server.directives.BasicDirectives

cancelRejection, cancelRejections, cancelRejections, extract, extractActorSystem, extractDataBytes, extractEntity, extractExecutionContext, extractLog, extractMatchedPath, extractMaterializer, extractParserSettings, extractRequest, extractRequestContext, extractRequestEntity, extractSettings, extractStrictEntity, extractStrictEntity, extractUnmatchedPath, extractUri, mapInnerRoute, mapRejections, mapRequest, mapRequestContext, mapResponse, mapResponseEntity, mapResponseHeaders, mapRouteResult, mapRouteResultFuture, mapRouteResultPF, mapRouteResultWith, mapRouteResultWithPF, mapSettings, mapUnmatchedPath, pass, provide, recoverRejections, recoverRejectionsWith, toStrictEntity, toStrictEntity, withExecutionContext, withLog, withMaterializer, withSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CookieDirectives

public CookieDirectives()

Method Detail

cookie

public Route cookie(java.lang.String name,
                    java.util.function.Function<HttpCookiePair,Route> inner)

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

Parameters:

name - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

deleteCookie

public Route deleteCookie(HttpCookie cookie,
                          java.util.function.Supplier<Route> inner)

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

Parameters:

cookie - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

deleteCookie

public Route deleteCookie(java.lang.Iterable<HttpCookie> cookies,
                          java.util.function.Supplier<Route> inner)

Adds a Set-Cookie response header expiring the given cookies.

Parameters:

cookies - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

deleteCookie

public Route deleteCookie(java.lang.String name,
                          java.util.function.Supplier<Route> inner)

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

Parameters:

name - Name of the cookie to match

inner - (undocumented)

Returns:

(undocumented)

deleteCookie

public Route deleteCookie(java.lang.String name,
                          java.lang.String domain,
                          java.util.function.Supplier<Route> inner)

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

Parameters:

name - Name of the cookie to match

domain - Domain of the cookie to match, or empty string to match any domain

inner - (undocumented)

Returns:

(undocumented)

deleteCookie

public Route deleteCookie(java.lang.String name,
                          java.lang.String domain,
                          java.lang.String path,
                          java.util.function.Supplier<Route> inner)

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

Parameters:

name - Name of the cookie to match

domain - Domain of the cookie to match, or empty string to match any domain

path - Path of the cookie to match, or empty string to match any path

inner - (undocumented)

Returns:

(undocumented)

optionalCookie

public Route optionalCookie(java.lang.String name,
                            java.util.function.Function<java.util.Optional<HttpCookiePair>,Route> inner)

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)

inner - (undocumented)

Returns:

(undocumented)

setCookie

public Route setCookie(HttpCookie cookie,
                       java.util.function.Supplier<Route> inner)

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

Parameters:

cookie - (undocumented)

inner - (undocumented)

Returns:

(undocumented)

setCookie

public Route setCookie(java.lang.Iterable<HttpCookie> cookies,
                       java.util.function.Supplier<Route> inner)

Adds a Set-Cookie response header with the given cookies.

Parameters:

cookies - (undocumented)

inner - (undocumented)

Returns:

(undocumented)