Package org.takes.facets.auth

Class PsLogout

java.lang.Object

org.takes.facets.auth.PsLogout

All Implemented Interfaces:

Pass

public final class PsLogout
extends Object
implements Pass

Logout.

The class is immutable and thread-safe.

Since:

0.5

Constructor Summary

Constructors

Constructor	Description
PsLogout()

Method Summary

Modifier and Type	Method	Description
Opt<Identity>	enter(Request request)	Authenticate the user by the request.
Response	exit(Response response, Identity identity)	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

PsLogout

public PsLogout()

Method Detail

enter

public Opt<Identity> enter(Request request)

Description copied from interface: Pass

Authenticate the user by the request.

Specified by:

enter in interface Pass

Parameters:

request - The request

Returns:

Identity of the user found

exit

public Response exit(Response response,
                     Identity identity)

Description copied from interface: Pass

Wrap the response with the user.

Specified by:

exit in interface Pass

Parameters:

response - Response

identity - Identity

Returns:

New response