Package rife.engine

Class CookieBuilder

java.lang.Object

rife.engine.CookieBuilder

public class CookieBuilder
extends Object

Helper class for building a Cookie.

Since:

1.0

See Also:

• Cookie

Constructor Summary

Constructors

Constructor	Description
CookieBuilder(String name, String value)	Starts building a new Cookie.

Method Summary

Modifier and Type	Method	Description
CookieBuilder	attribute(String name, String value)	See Cookie.setAttribute(String, String)
Cookie	cookie()	Returns the Cookie
CookieBuilder	domain(String domain)	See Cookie.setDomain(java.lang.String)
CookieBuilder	httpOnly(boolean isHttpOnly)	See Cookie.setHttpOnly(boolean)
CookieBuilder	maxAge(int expiry)	See Cookie.setMaxAge(int)
CookieBuilder	path(String uri)	See Cookie.setPath(java.lang.String)
CookieBuilder	secure(boolean flag)	See Cookie.setSecure(boolean)
CookieBuilder	value(String newValue)	See Cookie.setValue(java.lang.String)

Methods inherited from class java.lang.Object

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

Constructor Details

CookieBuilder

public CookieBuilder(String name,
 String value)

Starts building a new Cookie.

The path will automatically be set to "/" since that is the most common cookie usage. If the blank or empty path is needed, it can explicitly be set to null with path(String)

Parameters:

name - the name of the Cookie

value - the value of the Cookie

Since:

1.0

Method Details

cookie

public Cookie cookie()

Returns the Cookie

Returns:

the Cookie instance that being built

Since:

1.0

domain

public CookieBuilder domain(String domain)

See Cookie.setDomain(java.lang.String)

Returns:

the CookieBuilder instance

Since:

1.0

maxAge

public CookieBuilder maxAge(int expiry)

See Cookie.setMaxAge(int)

Returns:

the CookieBuilder instance

Since:

1.0

path

public CookieBuilder path(String uri)

See Cookie.setPath(java.lang.String)

Returns:

the CookieBuilder instance

Since:

1.0

secure

public CookieBuilder secure(boolean flag)

See Cookie.setSecure(boolean)

Returns:

the CookieBuilder instance

Since:

1.0

value

public CookieBuilder value(String newValue)

See Cookie.setValue(java.lang.String)

Returns:

the CookieBuilder instance

Since:

1.0

httpOnly

public CookieBuilder httpOnly(boolean isHttpOnly)

See Cookie.setHttpOnly(boolean)

Returns:

the CookieBuilder instance

Since:

1.0

attribute

public CookieBuilder attribute(String name,
 String value)

See Cookie.setAttribute(String, String)

Returns:

the CookieBuilder instance

Since:

1.8.0