com.rexsl.page

Class CookieBuilder

java.lang.Object

com.rexsl.page.CookieBuilder

@Loggable(value=1)
public final class CookieBuilder
extends Object

Cookie builder.

It is a convenient cookie builder for JAX-RS responses, for example:

 Response.ok().cookie(
   new CookieBuilder(this.uriInfo().getBaseUri())
     .name("my-cookie")
     .value("some value of the cookie")
     .temporary()
     .build()
 );

When you want to instruct the client to delete the cookie:

 Response.ok().cookie(
   new CookieBuilder(this.uriInfo().getBaseUri())
     .name("my-cookie")
     .build()
 );

It is much more convenient than new NewCookie(..) from JAX-RS.

The class is mutable and thread-safe.

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

RFC6265

Constructor Summary

Constructors

Constructor and Description
CookieBuilder(URI uri) Public ctor.
CookieBuilder(javax.ws.rs.core.UriBuilder builder) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.NewCookie	build() Build cookie.
CookieBuilder	days(int days) Make this cookie temporary, with certain pre-defined age in days.
CookieBuilder	name(String txt) Named like this.
CookieBuilder	path(String txt) Set path.
CookieBuilder	temporary() Make this cookie temporary, with 90 days age.
CookieBuilder	value(Object object) With value like this.

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieBuilder

public CookieBuilder(@NotNull
             URI uri)

Public ctor.

Parameters:

uri - The URI

CookieBuilder

public CookieBuilder(@NotNull
             javax.ws.rs.core.UriBuilder builder)

Public ctor.

Parameters:

builder - The URI builder

Method Detail

name

public CookieBuilder name(@NotNull
                 String txt)

Named like this.

Parameters:

txt - The name

Returns:

This object

See Also:

RFC2616

value

public CookieBuilder value(@NotNull
                  Object object)

With value like this.

Parameters:

object - The value

Returns:

This object

See Also:

RFC2616

path

public CookieBuilder path(@NotNull
                 String txt)

Set path.

Parameters:

txt - The path

Returns:

This object

See Also:

RFC2616

temporary

public CookieBuilder temporary()

Make this cookie temporary, with 90 days age.

Returns:

This object

days

public CookieBuilder days(int days)

Make this cookie temporary, with certain pre-defined age in days.

Parameters:

days - How many days to live

Returns:

This object

build

public javax.ws.rs.core.NewCookie build()

Build cookie.

Returns:

The cookie string to be used in "Set-cookie" header.