|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RememberMeManager
A RememberMeManager is responsible for remembering a Subject's identity across that Subject's sessions with the application.
Method Summary | |
---|---|
void |
forgetIdentity(SubjectContext subjectContext)
Forgets any remembered identity corresponding to the subject context map being used to build a subject instance. |
PrincipalCollection |
getRememberedPrincipals(SubjectContext subjectContext)
Based on the specified subject context map being used to build a Subject instance, returns any previously remembered principals for the subject for automatic identity association (aka 'Remember Me'). |
void |
onFailedLogin(Subject subject,
AuthenticationToken token,
AuthenticationException ae)
Reacts to a failed authentication attempt, typically by forgetting any previously remembered principals for the Subject. |
void |
onLogout(Subject subject)
Reacts to a Subject logging out of the application, typically by forgetting any previously remembered principals for the Subject. |
void |
onSuccessfulLogin(Subject subject,
AuthenticationToken token,
AuthenticationInfo info)
Reacts to a successful authentication attempt, typically saving the principals to be retrieved ('remembered') for future system access. |
Method Detail |
---|
PrincipalCollection getRememberedPrincipals(SubjectContext subjectContext)
Subject.Builder
implementation.
See the SubjectFactory
class constants for Shiro's known map keys.
subjectContext
- the contextual data, usually provided by a Subject.Builder
implementation, that
is being used to construct a Subject
instance.
null
if none could be acquired.void forgetIdentity(SubjectContext subjectContext)
Subject.Builder
implementation.
See the SubjectFactory
class constants for Shiro's known map keys.
subjectContext
- the contextual data, usually provided by a Subject.Builder
implementation, that
is being used to construct a Subject
instance.void onSuccessfulLogin(Subject subject, AuthenticationToken token, AuthenticationInfo info)
subject
- the subject that executed a successful authentication attempttoken
- the authentication token submitted resulting in a successful authentication attemptinfo
- the authenticationInfo returned as a result of the successful authentication attemptvoid onFailedLogin(Subject subject, AuthenticationToken token, AuthenticationException ae)
subject
- the subject that executed the failed authentication attempttoken
- the authentication token submitted resulting in the failed authentication attemptae
- the authentication exception thrown as a result of the failed authentication attemptvoid onLogout(Subject subject)
subject
- the subject logging out.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |