com.github.jscookie.javacookie

Class Cookies

java.lang.Object

com.github.jscookie.javacookie.Cookies

public final class Cookies
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cookies.Attributes
static class	Cookies.Converter

Method Summary

Methods

Modifier and Type	Method and Description
AttributesDefinition	defaults() Retrieve the default attributes of this instance
Map<String,String>	get() Retrieves all cookies
String	get(String name) Retrieves a cookie By default, assumes the characters not allowed in each cookie name are encoded with each one's UTF-8 Hex equivalent using percent-encoding.
<T> T	get(String name, Class<T> dataType) Retrieves a cookie and parse it using the given dataType instance
<T> T	get(String name, com.fasterxml.jackson.core.type.TypeReference<T> typeRef) Retrieves a cookie and parse it using the given type reference.
static Cookies	initFromServlet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	remove(String name) Remove an existing cookie using the default attributes
void	remove(String name, AttributesDefinition attributes) Remove an existing cookie By default, assumes the characters not allowed in each cookie name are encoded with each one's UTF-8 Hex equivalent using percent-encoding.
void	set(String name, boolean value) Create or update an existing cookie using the default attributes and serializing the typed value
void	set(String name, boolean value, AttributesDefinition attributes) Create or update an existing cookie extending the default attributes and serializing the typed value
void	set(String name, CookieValue value) Create or update an existing cookie extending the default attributes and serializing the typed value
void	set(String name, CookieValue value, AttributesDefinition attributes) Create or update an existing cookie extending the default attributes and serializing the typed value
void	set(String name, int value) Create or update an existing cookie using the default attributes and serializing the typed value
void	set(String name, int value, AttributesDefinition attributes) Create or update an existing cookie extending the default attributes and serializing the typed value
<T> void	set(String name, List<T> value) Create or update an existing cookie using the default attributes and serializing the typed value
<T> void	set(String name, List<T> value, AttributesDefinition attributes) Create or update an existing cookie extending the default attributes and serializing the typed value
void	set(String name, String value) Create or update an existing cookie using the default attributes
void	set(String name, String value, AttributesDefinition attributes) Create or update an existing cookie extending the default attributes By default, the characters not allowed in the cookie name or value are encoded with each one's UTF-8 Hex equivalent using percent-encoding.
Cookies	withConverter(ConverterStrategy converter) Create a new instance of the api that overrides the default decoding implementation All methods that rely in a proper decoding to work, such as remove(String, AttributesDefinition) and get(String), will run the converter first for each cookie.

Methods inherited from class java.lang.Object

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

Method Detail

initFromServlet

public static Cookies initFromServlet(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)

get

public String get(String name)

Retrieves a cookie
By default, assumes the characters not allowed in each cookie name are encoded with each one's UTF-8 Hex equivalent using percent-encoding.

Returns:

null if the cookie doesn't exist

get

public <T> T get(String name,
        Class<T> dataType)
      throws CookieParseException

Retrieves a cookie and parse it using the given dataType instance

Throws:

CookieParseException - If there's an error while parsing the cookie name using the given dataType

get

public <T> T get(String name,
        com.fasterxml.jackson.core.type.TypeReference<T> typeRef)
      throws CookieParseException

Retrieves a cookie and parse it using the given type reference. The type reference is used to infer generic types from within a class and workaround Java Type Erasure.
For more information check http://wiki.fasterxml.com/JacksonDataBinding#Full_Data_Binding

Throws:

CookieParseException - If there's an error while parsing the cookie name using the given dataType

See Also:

get(String, Class)

get

public Map<String,String> get()

Retrieves all cookies

See Also:

get(String)

set

public void set(String name,
       String value,
       AttributesDefinition attributes)

Create or update an existing cookie extending the default attributes
By default, the characters not allowed in the cookie name or value are encoded with each one's UTF-8 Hex equivalent using percent-encoding.

See Also:

get(String)

set

public void set(String name,
       int value,
       AttributesDefinition attributes)
         throws CookieSerializationException

Create or update an existing cookie extending the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String, AttributesDefinition)

set

public void set(String name,
       boolean value,
       AttributesDefinition attributes)
         throws CookieSerializationException

Create or update an existing cookie extending the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String, AttributesDefinition)

set

public <T> void set(String name,
           List<T> value,
           AttributesDefinition attributes)
         throws CookieSerializationException

Create or update an existing cookie extending the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String, AttributesDefinition)

set

public void set(String name,
       CookieValue value,
       AttributesDefinition attributes)
         throws CookieSerializationException

Create or update an existing cookie extending the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String, AttributesDefinition)

set

public void set(String name,
       String value)

Create or update an existing cookie using the default attributes

See Also:

set(String, String, AttributesDefinition)

set

public void set(String name,
       int value)
         throws CookieSerializationException

Create or update an existing cookie using the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String)

set

public void set(String name,
       boolean value)

Create or update an existing cookie using the default attributes and serializing the typed value

See Also:

set(String, String)

set

public <T> void set(String name,
           List<T> value)
         throws CookieSerializationException

Create or update an existing cookie using the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String)

set

public void set(String name,
       CookieValue value)
         throws CookieSerializationException

Create or update an existing cookie extending the default attributes and serializing the typed value

Throws:

CookieSerializationException

See Also:

set(String, String)

remove

public void remove(String name,
          AttributesDefinition attributes)

Remove an existing cookie
By default, assumes the characters not allowed in each cookie name are encoded with each one's UTF-8 Hex equivalent using percent-encoding.

attributes - You must pass the exact same path, domain and secure attributes that were used to set the cookie, unless you're relying on the default attributes

See Also:

get(String)

remove

public void remove(String name)

Remove an existing cookie using the default attributes

See Also:

remove(String, AttributesDefinition)

defaults

public AttributesDefinition defaults()

Retrieve the default attributes of this instance

withConverter

public Cookies withConverter(ConverterStrategy converter)

Create a new instance of the api that overrides the default decoding implementation
All methods that rely in a proper decoding to work, such as remove(String, AttributesDefinition) and get(String), will run the converter first for each cookie.
The returning String will be used as the cookie value.