org.apache.shiro.authc
Interface RememberMeAuthenticationToken

All Superinterfaces:

AuthenticationToken, Serializable

All Known Implementing Classes:

UsernamePasswordToken

public interface RememberMeAuthenticationToken
extends AuthenticationToken

An AuthenticationToken that indicates if the user wishes their identity to be remembered across sessions.

Note however that when a new session is created for the corresponding user, that user's identity would be remembered, but they are NOT considered authenticated. Please see the Subject.isRemembered() JavaDoc for an in-depth explanation of the semantic differences of what it means to be remembered vs. authenticated.

Since:

0.9

See Also:

Subject.isRemembered()

Method Summary

boolean

isRememberMe() Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.

Methods inherited from interface org.apache.shiro.authc.AuthenticationToken

getCredentials, getPrincipal

Method Detail

isRememberMe

boolean isRememberMe()

Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.

Returns:

true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.