org.osgl.http.servlet

Class ServletCookie

java.lang.Object

org.osgl.http.H.Cookie

org.osgl.http.servlet.ServletCookie

All Implemented Interfaces:

Serializable

public class ServletCookie
extends H.Cookie

Adapt Cookie to H.Cookie

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.osgl.http.H.Cookie

H.Cookie.F

Constructor Summary

Constructors

Constructor and Description
ServletCookie(javax.servlet.http.Cookie cookie)

Method Summary

Modifier and Type	Method and Description
static javax.servlet.http.Cookie	asServletCookie(H.Cookie c)
String	domain() Returns the domain of the cookie
ServletCookie	domain(String domain) Set the domain of the cookie
int	maxAge() Returns the maximum age of cookie specified in seconds.
ServletCookie	maxAge(int maxAge) Set the max age of the cookie in seconds.
String	name() Returns the name of the cookie.
static ServletCookie	of(javax.servlet.http.Cookie c)
String	path() Returns the path on the server to which the browser returns this cookie.
ServletCookie	path(String uri) Specifies a path for the cookie to which the client should return the cookie.
boolean	secure() Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
ServletCookie	secure(boolean secure) Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
String	value() Returns the value of the cookie
ServletCookie	value(String value) Set a value to a cookie and the return this cookie

Methods inherited from class org.osgl.http.H.Cookie

all, comment, comment, expires, expires, get, httpOnly, httpOnly, set, version, version

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletCookie

public ServletCookie(javax.servlet.http.Cookie cookie)

Method Detail

name

public String name()

Description copied from class: H.Cookie

Returns the name of the cookie. Cookie name cannot be changed after created

Overrides:

name in class H.Cookie

Returns:

the name

value

public String value()

Description copied from class: H.Cookie

Returns the value of the cookie

Overrides:

value in class H.Cookie

Returns:

the value

value

public ServletCookie value(String value)

Description copied from class: H.Cookie

Set a value to a cookie and the return this cookie

Overrides:

value in class H.Cookie

Parameters:

value - the value to be set to the cookie

Returns:

this cookie

domain

public String domain()

Description copied from class: H.Cookie

Returns the domain of the cookie

Overrides:

domain in class H.Cookie

Returns:

domain

domain

public ServletCookie domain(String domain)

Description copied from class: H.Cookie

Set the domain of the cookie

Overrides:

domain in class H.Cookie

Parameters:

domain - the domain string

Returns:

this cookie

path

public String path()

Description copied from class: H.Cookie

Returns the path on the server to which the browser returns this cookie. The cookie is visible to all subpaths on the server.

Overrides:

path in class H.Cookie

Returns:

the path

See Also:

H.Cookie.path(String)

path

public ServletCookie path(String uri)

Description copied from class: H.Cookie

Specifies a path for the cookie to which the client should return the cookie.

The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories.

Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.

Overrides:

path in class H.Cookie

Parameters:

uri - a String specifying a path

Returns:

this cookie after path is set

See Also:

H.Cookie.path

maxAge

public int maxAge()

Description copied from class: H.Cookie

Returns the maximum age of cookie specified in seconds. If maxAge is set to -1 then the cookie will persist until browser shutdown

Overrides:

maxAge in class H.Cookie

Returns:

the max age of the cookie

maxAge

public ServletCookie maxAge(int maxAge)

Description copied from class: H.Cookie

Set the max age of the cookie in seconds.

A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.

A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.

Overrides:

maxAge in class H.Cookie

Parameters:

maxAge - the max age to be set

Returns:

this instance

See Also:

H.Cookie.maxAge()

secure

public boolean secure()

Description copied from class: H.Cookie

Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

Overrides:

secure in class H.Cookie

Returns:

if the cookie is secure

See Also:

H.Cookie.secure(boolean)

secure

public ServletCookie secure(boolean secure)

Description copied from class: H.Cookie

Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

The default value is false.

Overrides:

secure in class H.Cookie

Parameters:

secure - the cookie secure requirement

Returns:

this cookie instance

of

public static ServletCookie of(javax.servlet.http.Cookie c)

asServletCookie

public static javax.servlet.http.Cookie asServletCookie(H.Cookie c)