org.libj.net

Class Cookies

java.lang.Object

org.libj.net.Cookies

public final class Cookies
extends Object

Utility methods for management of cookies in HttpServletRequests and HttpServletResponses.

Method Summary

Modifier and Type	Method and Description
static Map.Entry<String,String>	createCookieHeader(Collection<String> cookies) Create a semicolon-delimited cookie header for the specified cookies.
static String	getCookieValue(HttpServletRequest request, String name) Returns the cookie value associated with the given cookie name from the given request.
static void	removeCookie(HttpServletResponse response, String name) Remove the cookie in the response with the provided name.
static void	setCookieValue(HttpServletResponse response, String name, String value, int maxAge) Set the cookie in the response with the provided name, value, and expiration maxAge.

Methods inherited from class java.lang.Object

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

Method Detail

getCookieValue

public static String getCookieValue(HttpServletRequest request,
                                    String name)

Returns the cookie value associated with the given cookie name from the given request.

Parameters:

request - The request.

name - The cookie name.

Returns:

The cookie value associated with the given cookie name, or null if the cookie name is not found in the request.

Throws:

NullPointerException - If request or name is null.

setCookieValue

public static void setCookieValue(HttpServletResponse response,
                                  String name,
                                  String value,
                                  int maxAge)

Set the cookie in the response with the provided name, value, and expiration maxAge.

Parameters:

response - The HttpServletResponse to be used.

name - The cookie name to associate the cookie value with.

value - The actual cookie value to be set in the given servlet response.

maxAge - The expiration interval in seconds. If this is set to 0, then the cookie will immediately expire.

Throws:

NullPointerException - If response is null.

IllegalArgumentException - If the cookie name is null or empty or contains any illegal characters (for example, a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol.

removeCookie

public static void removeCookie(HttpServletResponse response,
                                String name)

Remove the cookie in the response with the provided name.

The cookie expiration interval is set to zero, resulting in the cookie being expired immediately.

Parameters:

response - The HttpServletResponse to be used.

name - The cookie name of the cookie to be removed.

Throws:

NullPointerException - If response is null.

IllegalArgumentException - If the cookie name is null or empty or contains any illegal characters (for example, a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol.

createCookieHeader

public static Map.Entry<String,String> createCookieHeader(Collection<String> cookies)

Create a semicolon-delimited cookie header for the specified cookies.

Parameters:

cookies - The collection of cookies.

Returns:

A Map.Entry<String,String> with key set to "Cookie", and value set to semicolon-delimited cookies.

Throws:

NullPointerException - If cookies is null.