Interface RememberMeServices

All Known Implementing Classes:

PersistentTokenBasedRememberMeServices

public interface RememberMeServices

What remembers a user between sessions: issues the cookie at sign-in, and recognizes it on a request nobody has signed in for.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUESTED_ATTRIBUTE	The attribute of the request's SecurityExchange that says the user asked to be remembered, when the request that completes the sign-in is not the one that carried the checkbox: set to Boolean.TRUE before loginSuccess(HttpServer.Request, Authentication) by whatever finishes a sign-in in a second step.
static final String	SECOND_FACTOR_ATTRIBUTE	The attribute of the request's SecurityExchange that says the sign-in being completed passed a second factor: set to Boolean.TRUE before loginSuccess(HttpServer.Request, Authentication).

Method Summary

Modifier and Type	Method	Description
Authentication	autoLogin(HttpServer.Request request)	Recognizes the user from the request's cookie.
void	loginFail(HttpServer.Request request)	A sign-in was refused: withdraws the cookie.
void	loginSuccess(HttpServer.Request request, Authentication successfulAuthentication)	A user signed in: issues the cookie, if they asked to be remembered.

Field Details

REQUESTED_ATTRIBUTE

static final String REQUESTED_ATTRIBUTE

The attribute of the request's SecurityExchange that says the user asked to be remembered, when the request that completes the sign-in is not the one that carried the checkbox: set to Boolean.TRUE before loginSuccess(HttpServer.Request, Authentication) by whatever finishes a sign-in in a second step.

See Also:

• Constant Field Values

SECOND_FACTOR_ATTRIBUTE

static final String SECOND_FACTOR_ATTRIBUTE

The attribute of the request's SecurityExchange that says the sign-in being completed passed a second factor: set to Boolean.TRUE before loginSuccess(HttpServer.Request, Authentication). A cookie issued then may sign a user who has a second factor in later; one issued without it may not. Services that issue cookies of their own carry this over, and say so on what autoLogin(HttpServer.Request) returns -- see RememberMeAuthenticationToken.isAfterSecondFactor().

See Also:

• Constant Field Values

Method Details

autoLogin

Authentication autoLogin(HttpServer.Request request)

Recognizes the user from the request's cookie.

Returns:

who it is, or null when the request carries no cookie this accepts -- in which case the cookie, if there was one, is withdrawn

loginFail

void loginFail(HttpServer.Request request)

A sign-in was refused: withdraws the cookie.

loginSuccess

void loginSuccess(HttpServer.Request request,
 Authentication successfulAuthentication)

A user signed in: issues the cookie, if they asked to be remembered. Public so that a sign-in an application completes itself -- after a step of its own -- can issue it too.