rawhttp.cookies

Class ServerCookieHelper

java.lang.Object

rawhttp.cookies.ServerCookieHelper

public final class ServerCookieHelper
extends java.lang.Object

Utility static methods to help HTTP servers set cookies.

Example usage:

 
 var headers = RawHttpHeaders.newBuilder();
 var cookie = new HttpCookie("sid", "123456");
 ServerCookieHelper.setCookie(headers, cookie);
 var response = new RawHttp().parseResponse("200 OK")
   .withHeaders(headers.build());
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COOKIE_HEADER The name of the Cookie header sent by HTTP clients.
static java.lang.String	SET_COOKIE_HEADER The name of the Set-Cookie header used by HTTP servers to set cookies on a client.

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.net.HttpCookie>	readClientCookies(rawhttp.core.RawHttpHeaders headers) Read the cookies sent by a HTTP client within the given headers.
static java.util.List<java.net.HttpCookie>	readClientCookies(rawhttp.core.RawHttpRequest request) Read the cookies sent by a HTTP client in the given request.
static rawhttp.core.RawHttpHeaders.Builder	setCookie(rawhttp.core.RawHttpHeaders.Builder headers, java.net.HttpCookie cookie)
static rawhttp.core.RawHttpHeaders.Builder	setCookie(rawhttp.core.RawHttpHeaders.Builder headers, java.net.HttpCookie cookie, SameSite sameSite)
static rawhttp.core.RawHttpHeaders.Builder	setCookie(rawhttp.core.RawHttpHeaders.Builder headers, java.net.HttpCookie cookie, SameSite sameSite, java.lang.Object extension)
static rawhttp.core.RawHttpHeaders	setCookie(rawhttp.core.RawHttpHeaders headers, java.net.HttpCookie cookie)
static rawhttp.core.RawHttpHeaders	setCookie(rawhttp.core.RawHttpHeaders headers, java.net.HttpCookie cookie, SameSite sameSite)
static rawhttp.core.RawHttpHeaders	setCookie(rawhttp.core.RawHttpHeaders headers, java.net.HttpCookie cookie, SameSite sameSite, java.lang.Object extension)
static <T> rawhttp.core.RawHttpResponse<T>	setCookie(rawhttp.core.RawHttpResponse<T> response, java.net.HttpCookie cookie)
static <T> rawhttp.core.RawHttpResponse<T>	setCookie(rawhttp.core.RawHttpResponse<T> response, java.net.HttpCookie cookie, SameSite sameSite)
static <T> rawhttp.core.RawHttpResponse<T>	setCookie(rawhttp.core.RawHttpResponse<T> response, java.net.HttpCookie cookie, SameSite sameSite, java.lang.Object extension)
static java.lang.String	setCookieHeaderValue(java.net.HttpCookie cookie) Compute the value of the "Set-Cookie" header to represent the given cookie.
static java.lang.String	setCookieHeaderValue(java.net.HttpCookie cookie, SameSite sameSite) Compute the value of the "Set-Cookie" header to represent the given cookie, with an optional SameSite attribute.
static java.lang.String	setCookieHeaderValue(java.net.HttpCookie cookie, SameSite sameSite, java.lang.Object extension) Compute the value of the "Set-Cookie" header to represent the given cookie, with an optional SameSite attribute and extension.
static rawhttp.core.RawHttpHeaders.Builder	setCookies(rawhttp.core.RawHttpHeaders.Builder headers, java.util.List<java.net.HttpCookie> cookies)
static rawhttp.core.RawHttpHeaders.Builder	setCookies(rawhttp.core.RawHttpHeaders.Builder headers, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite)
static rawhttp.core.RawHttpHeaders.Builder	setCookies(rawhttp.core.RawHttpHeaders.Builder headers, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite, java.lang.Object extension)
static rawhttp.core.RawHttpHeaders	setCookies(rawhttp.core.RawHttpHeaders headers, java.util.List<java.net.HttpCookie> cookies)
static rawhttp.core.RawHttpHeaders	setCookies(rawhttp.core.RawHttpHeaders headers, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite)
static rawhttp.core.RawHttpHeaders	setCookies(rawhttp.core.RawHttpHeaders headers, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite, java.lang.Object extension)
static <T> rawhttp.core.RawHttpResponse<T>	setCookies(rawhttp.core.RawHttpResponse<T> response, java.util.List<java.net.HttpCookie> cookies)
static <T> rawhttp.core.RawHttpResponse<T>	setCookies(rawhttp.core.RawHttpResponse<T> response, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite)
static <T> rawhttp.core.RawHttpResponse<T>	setCookies(rawhttp.core.RawHttpResponse<T> response, java.util.List<java.net.HttpCookie> cookies, SameSite sameSite, java.lang.Object extension)

Methods inherited from class java.lang.Object

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

Field Detail

COOKIE_HEADER

public static final java.lang.String COOKIE_HEADER

The name of the Cookie header sent by HTTP clients.

See Also:

Constant Field Values

SET_COOKIE_HEADER

public static final java.lang.String SET_COOKIE_HEADER

The name of the Set-Cookie header used by HTTP servers to set cookies on a client.

See Also:

Constant Field Values

Method Detail

setCookie

public static <T> rawhttp.core.RawHttpResponse<T> setCookie(rawhttp.core.RawHttpResponse<T> response,
                                                            java.net.HttpCookie cookie)

setCookie

public static <T> rawhttp.core.RawHttpResponse<T> setCookie(rawhttp.core.RawHttpResponse<T> response,
                                                            java.net.HttpCookie cookie,
                                                            @Nullable
                                                            SameSite sameSite)

setCookie

public static <T> rawhttp.core.RawHttpResponse<T> setCookie(rawhttp.core.RawHttpResponse<T> response,
                                                            java.net.HttpCookie cookie,
                                                            @Nullable
                                                            SameSite sameSite,
                                                            @Nullable
                                                            java.lang.Object extension)

setCookies

public static <T> rawhttp.core.RawHttpResponse<T> setCookies(rawhttp.core.RawHttpResponse<T> response,
                                                             java.util.List<java.net.HttpCookie> cookies)

setCookies

public static <T> rawhttp.core.RawHttpResponse<T> setCookies(rawhttp.core.RawHttpResponse<T> response,
                                                             java.util.List<java.net.HttpCookie> cookies,
                                                             @Nullable
                                                             SameSite sameSite)

setCookies

public static <T> rawhttp.core.RawHttpResponse<T> setCookies(rawhttp.core.RawHttpResponse<T> response,
                                                             java.util.List<java.net.HttpCookie> cookies,
                                                             @Nullable
                                                             SameSite sameSite,
                                                             @Nullable
                                                             java.lang.Object extension)

setCookies

public static rawhttp.core.RawHttpHeaders setCookies(rawhttp.core.RawHttpHeaders headers,
                                                     java.util.List<java.net.HttpCookie> cookies)

setCookies

public static rawhttp.core.RawHttpHeaders setCookies(rawhttp.core.RawHttpHeaders headers,
                                                     java.util.List<java.net.HttpCookie> cookies,
                                                     @Nullable
                                                     SameSite sameSite)

setCookies

public static rawhttp.core.RawHttpHeaders setCookies(rawhttp.core.RawHttpHeaders headers,
                                                     java.util.List<java.net.HttpCookie> cookies,
                                                     @Nullable
                                                     SameSite sameSite,
                                                     @Nullable
                                                     java.lang.Object extension)

setCookies

public static rawhttp.core.RawHttpHeaders.Builder setCookies(rawhttp.core.RawHttpHeaders.Builder headers,
                                                             java.util.List<java.net.HttpCookie> cookies)

setCookies

public static rawhttp.core.RawHttpHeaders.Builder setCookies(rawhttp.core.RawHttpHeaders.Builder headers,
                                                             java.util.List<java.net.HttpCookie> cookies,
                                                             @Nullable
                                                             SameSite sameSite)

setCookies

public static rawhttp.core.RawHttpHeaders.Builder setCookies(rawhttp.core.RawHttpHeaders.Builder headers,
                                                             java.util.List<java.net.HttpCookie> cookies,
                                                             @Nullable
                                                             SameSite sameSite,
                                                             @Nullable
                                                             java.lang.Object extension)

setCookie

public static rawhttp.core.RawHttpHeaders setCookie(rawhttp.core.RawHttpHeaders headers,
                                                    java.net.HttpCookie cookie)

setCookie

public static rawhttp.core.RawHttpHeaders setCookie(rawhttp.core.RawHttpHeaders headers,
                                                    java.net.HttpCookie cookie,
                                                    @Nullable
                                                    SameSite sameSite)

setCookie

public static rawhttp.core.RawHttpHeaders setCookie(rawhttp.core.RawHttpHeaders headers,
                                                    java.net.HttpCookie cookie,
                                                    @Nullable
                                                    SameSite sameSite,
                                                    @Nullable
                                                    java.lang.Object extension)

setCookie

public static rawhttp.core.RawHttpHeaders.Builder setCookie(rawhttp.core.RawHttpHeaders.Builder headers,
                                                            java.net.HttpCookie cookie)

setCookie

public static rawhttp.core.RawHttpHeaders.Builder setCookie(rawhttp.core.RawHttpHeaders.Builder headers,
                                                            java.net.HttpCookie cookie,
                                                            @Nullable
                                                            SameSite sameSite)

setCookie

public static rawhttp.core.RawHttpHeaders.Builder setCookie(rawhttp.core.RawHttpHeaders.Builder headers,
                                                            java.net.HttpCookie cookie,
                                                            @Nullable
                                                            SameSite sameSite,
                                                            @Nullable
                                                            java.lang.Object extension)

setCookieHeaderValue

public static java.lang.String setCookieHeaderValue(java.net.HttpCookie cookie)

Compute the value of the "Set-Cookie" header to represent the given cookie.

Parameters:

cookie - the cookie

Returns:

the value of the "Set-Cookie" header

setCookieHeaderValue

public static java.lang.String setCookieHeaderValue(java.net.HttpCookie cookie,
                                                    @Nullable
                                                    SameSite sameSite)

Compute the value of the "Set-Cookie" header to represent the given cookie, with an optional SameSite attribute.

Parameters:

cookie - the cookie

sameSite - attribute for the cookie (given separately as HttpCookie does not currently support it

Returns:

the value of the "Set-Cookie" header

setCookieHeaderValue

public static java.lang.String setCookieHeaderValue(java.net.HttpCookie cookie,
                                                    @Nullable
                                                    SameSite sameSite,
                                                    @Nullable
                                                    java.lang.Object extension)

Compute the value of the "Set-Cookie" header to represent the given cookie, with an optional SameSite attribute and extension.

Parameters:

cookie - the cookie

sameSite - attribute for the cookie (given separately as HttpCookie does not currently support it

extension - cookie extension

Returns:

the value of the "Set-Cookie" header

readClientCookies

public static java.util.List<java.net.HttpCookie> readClientCookies(rawhttp.core.RawHttpRequest request)

Read the cookies sent by a HTTP client in the given request.

Parameters:

request - that may contain cookies

Returns:

the cookies sent by the client

readClientCookies

public static java.util.List<java.net.HttpCookie> readClientCookies(rawhttp.core.RawHttpHeaders headers)

Read the cookies sent by a HTTP client within the given headers.

Parameters:

headers - from a HTTP request

Returns:

the cookies sent by the client