RememberMeAuthenticationToken

An {@code AuthenticationToken} that indicates if the user wishes their identity to be remembered across sessions. <p/> Note however that when a new session is created for the corresponding user, that user's identity would be remembered, but they are <em>NOT</em> considered authenticated. Please see the {@link hunt.shiro.subject.Subject#isRemembered()} JavaDoc for an in-depth explanation of the semantic differences of what it means to be remembered vs. authenticated.

@see hunt.shiro.subject.Subject#isRemembered()

interface RememberMeAuthenticationToken : AuthenticationToken {}

Members

Functions

isRememberMe
bool isRememberMe()

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

Inherited Members

From AuthenticationToken

getPrincipal
string getPrincipal()

Returns the account identity submitted during the authentication process. <p/> <p>Most application authentications are username/password based and have this object represent a username. If this is the case for your application, take a look at the {@link UsernamePasswordToken UsernamePasswordToken}, as it is probably sufficient for your use. <p/> <p>Ultimately, the object returned is application specific and can represent any account identity (user id, X.509 certificate, etc).

getCredentials
char[] getCredentials()

Returns the credentials submitted by the user during the authentication process that verifies the submitted {@link #getPrincipal() account identity}. <p/> <p>Most application authentications are username/password based and have this object represent a submitted password. If this is the case for your application, take a look at the {@link UsernamePasswordToken UsernamePasswordToken}, as it is probably sufficient for your use. <p/> <p>Ultimately, the credentials Object returned is application specific and can represent any credential mechanism.

Meta