Package org.takes.facets.auth

Class PsBasic

java.lang.Object

org.takes.facets.auth.PsBasic

All Implemented Interfaces:

Pass

public final class PsBasic
extends Object
implements Pass

Pass that checks the user according RFC-2617.

The class is immutable and thread-safe.

Since:

0.20

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PsBasic.Default	Default entry.
static class	PsBasic.Empty	Empty check.
static interface	PsBasic.Entry	Entry interface that is used to check if the received information is valid.
static class	PsBasic.Fake	Fake implementation of PsBasic.Entry.

Constructor Summary

Constructors

Constructor	Description
PsBasic(String rlm, PsBasic.Entry basic)	Ctor.

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

PsBasic

public PsBasic(String rlm,
               PsBasic.Entry basic)

Ctor.

Parameters:

rlm - Realm

basic - Entry

Method Detail

enter

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

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

Throws:

IOException

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