com.belladati.extensions

Interface CookieService

public interface CookieService

Used by other services to obtain cookie values for the current request, or to write cookie values as part of the request.

Author:

BellaDati Inc.

Method Summary

Modifier and Type	Method and Description
String	readCookieValue(String name) Returns the value of the first cookie whose name matches.
void	removeCookieValue(String name) Removes a previously written cookie, by writing a new cookie with a maxAge of 0.
void	writeCookieValue(String name, String value) Creates or updates a cookie value.
void	writeCookieValue(String name, String value, int maxAge) As with writeCookieValue(String, String) but an explicit maximum age may be set.
void	writeCookieValue(String name, String value, String path) As with writeCookieValue(String, String) but an explicit domain may be set.
void	writeCookieValue(String name, String value, String path, String domain) As with writeCookieValue(String, String) but an explicit domain and maximum age may be set.
void	writeDomainCookieValue(String name, String value, String domain) As with writeCookieValue(String, String, String) but an explicit domain and path may be set.
void	writeDomainCookieValue(String name, String value, String domain, int maxAge) Removes a previously written cookie, by writing a new cookie with a maxAge of 0.

Method Detail

readCookieValue

String readCookieValue(String name)

Returns the value of the first cookie whose name matches.

Parameters:

name -

Returns:

removeCookieValue

void removeCookieValue(String name)

Removes a previously written cookie, by writing a new cookie with a maxAge of 0.

Parameters:

name - name of the cookie

writeCookieValue

void writeCookieValue(String name,
                      String value)

Creates or updates a cookie value.

Parameters:

name - name of the cookie

value - cookie value

writeCookieValue

void writeCookieValue(String name,
                      String value,
                      int maxAge)

As with writeCookieValue(String, String) but an explicit maximum age may be set.

Parameters:

name - name of the cookie

value - cookie value

maxAge - max age

writeCookieValue

void writeCookieValue(String name,
                      String value,
                      String path)

As with writeCookieValue(String, String) but an explicit domain may be set.

Parameters:

name - name of the cookie

value - cookie value

path - path to set

writeCookieValue

void writeCookieValue(String name,
                      String value,
                      String path,
                      String domain)

As with writeCookieValue(String, String) but an explicit domain and maximum age may be set.

Parameters:

name - name of the cookie

value - cookie value

path - path to set

domain - specific domain name

writeDomainCookieValue

void writeDomainCookieValue(String name,
                            String value,
                            String domain)

As with writeCookieValue(String, String, String) but an explicit domain and path may be set.

Parameters:

name - name of the cookie

value - cookie value

domain - specific domain name

writeDomainCookieValue

void writeDomainCookieValue(String name,
                            String value,
                            String domain,
                            int maxAge)

Removes a previously written cookie, by writing a new cookie with a maxAge of 0.

Parameters:

name - name of the cookie

value - cookie value

domain - specific domain name

maxAge - max age