com.github.mjeanroy.junit.servers.client

Class Cookie

java.lang.Object

com.github.mjeanroy.junit.servers.client.Cookie

public class Cookie
extends Object

Default implementation for cookie object.
To build a cookie, use:

• The Cookie.Builder API
• Or one of the static factories in Cookies class

Using the builder is easy:

   Cookie cookie = new Cookie.Builder("name", "value")
     .domain("domain")
     .path("path")
     .secure(true)   // Defaults to false.
     .httpOnly(true) // Defaults to false.
     .maxAge(3600)
     .expires(tt.getTime())
     .build();
 

You can also use one of the static factories:

   Cookie c1 = Cookies.cookie("name", "value");
   Cookie c2 = Cookies.cookie("name", "value", "domain", "path", maxAge, expires, true, true);
 

See Also:

https://developer.mozilla.org/fr/docs/Web/HTTP/Headers/Set-Cookie

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cookie.Builder Builder to create Cookie instances.

Method Summary

Modifier and Type	Method and Description
static Cookie	cookie(String name, String value) Deprecated. Use Cookies.cookie(String, String) instead.
static Cookie	cookie(String name, String value, String domain, String path, Long expires, Long maxAge, boolean secure, boolean httpOnly) Deprecated. Use Cookies.cookie(String, String, String, String, Long, Long, boolean, boolean) instead.
boolean	equals(Object o)
String	getDomain() Get cookie domain.
Long	getExpires() Get cookie expires value.
Long	getMaxAge() Cookie max age.
String	getName() Get cookie name.
String	getPath() Get cookie path.
String	getValue() Get cookie value.
int	hashCode()
boolean	isHttpOnly() Cookie http-only flag.
boolean	isSecure() Cookie secure flag.
static Cookie	read(String rawValue) Deprecated. Use Cookies.read(String) instead.
static Cookie	secureCookie(String name, String value, String domain, String path, Long expires, Long maxAge) Deprecated. Use Cookies.secureCookie(String, String, String, String, Long, Long) instead.
static Cookie	sessionCookie(String name, String value, String domain, String path) Deprecated. Use Cookies.sessionCookie(String, String, String, String) instead.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

read

@Deprecated
public static Cookie read(String rawValue)

Deprecated. Use Cookies.read(String) instead.

Create a cookie from header value.

Parameters:

rawValue - Header value.

Returns:

Cookie.

cookie

@Deprecated
public static Cookie cookie(String name,
                                        String value)

Deprecated. Use Cookies.cookie(String, String) instead.

Create cookie.

Parameters:

name - Cookie name.

value - Cookie value.

Returns:

Cookie.

Throws:

NullPointerException - if name or value is null.

IllegalArgumentException - if name is empty or blank.

cookie

@Deprecated
public static Cookie cookie(String name,
                                        String value,
                                        String domain,
                                        String path,
                                        Long expires,
                                        Long maxAge,
                                        boolean secure,
                                        boolean httpOnly)

Deprecated. Use Cookies.cookie(String, String, String, String, Long, Long, boolean, boolean) instead.

Create cookie.

Parameters:

name - Cookie name.

value - Cookie value.

domain - Cookie domain.

path - Cookie path.

expires - Cookie expires value.

maxAge - Cookie max age value.

secure - Secure flag.

httpOnly - Http flag.

Returns:

Cookie.

Throws:

NullPointerException - if name or value is null.

IllegalArgumentException - if name is empty or blank.

secureCookie

@Deprecated
public static Cookie secureCookie(String name,
                                              String value,
                                              String domain,
                                              String path,
                                              Long expires,
                                              Long maxAge)

Deprecated. Use Cookies.secureCookie(String, String, String, String, Long, Long) instead.

Create a secured cookie, it means that cookie will have secure flag and http only flag set to true.

Parameters:

name - Cookie name.

value - Cookie value.

domain - Cookie domain.

path - Cookie path.

expires - Cookie expires value.

maxAge - Cookie max age.

Returns:

Cookie.

Throws:

NullPointerException - if name or value is null.

IllegalArgumentException - if name is empty or blank.

sessionCookie

@Deprecated
public static Cookie sessionCookie(String name,
                                               String value,
                                               String domain,
                                               String path)

Deprecated. Use Cookies.sessionCookie(String, String, String, String) instead.

Create a session cookie, it means that cookie will have secure flag and http only flag set to true and expires / max age values are set to zero.

Parameters:

name - Cookie name.

value - Cookie value.

domain - Cookie domain.

path - Cookie path.

Returns:

Cookie.

Throws:

NullPointerException - if name or value is null.

IllegalArgumentException - if name is empty or blank.

getName

public String getName()

Get cookie name.

Returns:

Cookie name.

getValue

public String getValue()

Get cookie value.

Returns:

Cookie value.

getDomain

public String getDomain()

Get cookie domain.

Returns:

Cookie domain.

getPath

public String getPath()

Get cookie path.

Returns:

Cookie path.

getExpires

public Long getExpires()

Get cookie expires value. The value is a timestamp. If value is lower than zero, it means that expires value has not been set on cookie.

Returns:

Expires value.

getMaxAge

public Long getMaxAge()

Cookie max age. This is the max validity time in seconds.

Returns:

Max age value.

isSecure

public boolean isSecure()

Cookie secure flag.

Returns:

Secure flag.

isHttpOnly

public boolean isHttpOnly()

Cookie http-only flag.

Returns:

Http-Only flag.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object