Package org.takes.facets.auth

Class PsCookie

java.lang.Object

org.takes.facets.auth.PsCookie

All Implemented Interfaces:

Pass

public final class PsCookie
extends Object
implements Pass

Pass via cookie information.

The class is immutable and thread-safe.

Since:

0.1

Constructor Summary

Constructors

Constructor	Description
PsCookie(Codec cdc)	Ctor.
PsCookie(Codec cdc, String name)	Ctor.
PsCookie(Codec cdc, String name, long days)	Ctor.

Method Summary

Modifier and Type	Method	Description
Opt<Identity>	enter(Request req)	Authenticate the user by the request.
Response	exit(Response res, Identity idt)	Wrap the response with the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

PsCookie

public PsCookie(Codec cdc)

Ctor.

Parameters:

cdc - Codec

PsCookie

public PsCookie(Codec cdc,
                String name)

Ctor.

Parameters:

cdc - Codec

name - Cookie name

PsCookie

public PsCookie(Codec cdc,
                String name,
                long days)

Ctor.

Parameters:

cdc - Codec

name - Cookie name

days - Max age in days

Since:

0.9.6

Method Detail

enter

public Opt<Identity> enter(Request req)
                    throws IOException

Description copied from interface: Pass

Authenticate the user by the request.

Specified by:

enter in interface Pass

Parameters:

req - The request

Returns:

Identity of the user found

Throws:

IOException

exit

public Response exit(Response res,
                     Identity idt)
              throws IOException

Description copied from interface: Pass

Wrap the response with the user.

Specified by:

exit in interface Pass

Parameters:

res - Response

idt - Identity

Returns:

New response

Throws:

IOException