public interface RememberMeIdentityStore
RememberMeIdentityStore
is a mechanism for validating a caller's
credentials and accessing a caller's identity attributes that's specifically
tailored for the "remember me" feature.
This is not intended to be directly used by an authentication mechanism such as
the Jakarta Security HttpAuthenticationMechanism
or the Jakarta Authentication
ServerAuthModule
. Instead, the interceptor implementation backing the
RememberMe
annotation is intended to use this.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
generateLoginToken(CallerPrincipal callerPrincipal,
java.util.Set<java.lang.String> groups)
Associates the given principal and groups with a token.
|
void |
removeLoginToken(java.lang.String token)
Dissociates the principal and groups that were associated with the token before
and removes the token itself.
|
CredentialValidationResult |
validate(RememberMeCredential credential)
Validates the given credential.
|
CredentialValidationResult validate(RememberMeCredential credential)
credential
- The credential to validate.java.lang.String generateLoginToken(CallerPrincipal callerPrincipal, java.util.Set<java.lang.String> groups)
The token generated by this method is intended to be used with the
RememberMeCredential
and passed into the validate(RememberMeCredential)
method.
callerPrincipal
- The principal to be associated.groups
- The groups the principal is in.void removeLoginToken(java.lang.String token)
If the token did not exist (i.e. no principal and groups were associated with that token) no exception will be thrown.
token
- The token that is to be removed.