Package com.okta.authn.sdk
Interface AuthenticationStateHandler
-
- All Known Implementing Classes:
AuthenticationStateHandlerAdapter
,ExampleAuthenticationStateHandler
public interface AuthenticationStateHandler
Each method ofAuthenticationStateHandler
corresponds to a state of Okta's Authentication state machine. Each method in @AuthenticationClient
may return a different result depending on the current state of the user (password locked, etc) and the current configuration of your Okta organization.Implementation Notes:
Your Okta organization MAY not be configured to enter all of these states. At minimum you should implement:handleUnknown
handleSuccess
handlePasswordExpired
handlePasswordWarning
(unless thewarnBeforePasswordExpired
flag was set when callingAuthenticationClient.authenticate(com.okta.authn.sdk.resource.AuthenticationRequest, AuthenticationStateHandler)
handleLockedOut
, if self-service unlock is enabled for your Okta organization. If you want to support password recovery flows you must implement:handleRecovery
handleRecoveryChallenge
handlePasswordReset
handleMfaRequired
handleMfaEnroll
handleMfaEnrollActivate
handleMfaChallenge
- Since:
- 0.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
handleLockedOut(AuthenticationResponse lockedOut)
void
handleMfaChallenge(AuthenticationResponse mfaChallengeResponse)
void
handleMfaEnroll(AuthenticationResponse mfaEnroll)
void
handleMfaEnrollActivate(AuthenticationResponse mfaEnrollActivate)
void
handleMfaRequired(AuthenticationResponse mfaRequiredResponse)
void
handlePasswordExpired(AuthenticationResponse passwordExpired)
void
handlePasswordReset(AuthenticationResponse passwordReset)
void
handlePasswordWarning(AuthenticationResponse passwordWarning)
void
handleRecovery(AuthenticationResponse recovery)
void
handleRecoveryChallenge(AuthenticationResponse recoveryChallenge)
void
handleSuccess(AuthenticationResponse successResponse)
void
handleUnauthenticated(AuthenticationResponse unauthenticatedResponse)
void
handleUnknown(AuthenticationResponse unknownResponse)
-
-
-
Method Detail
-
handleUnauthenticated
void handleUnauthenticated(AuthenticationResponse unauthenticatedResponse)
-
handlePasswordWarning
void handlePasswordWarning(AuthenticationResponse passwordWarning)
-
handlePasswordExpired
void handlePasswordExpired(AuthenticationResponse passwordExpired)
-
handleRecovery
void handleRecovery(AuthenticationResponse recovery)
-
handleRecoveryChallenge
void handleRecoveryChallenge(AuthenticationResponse recoveryChallenge)
-
handlePasswordReset
void handlePasswordReset(AuthenticationResponse passwordReset)
-
handleLockedOut
void handleLockedOut(AuthenticationResponse lockedOut)
-
handleMfaRequired
void handleMfaRequired(AuthenticationResponse mfaRequiredResponse)
-
handleMfaEnroll
void handleMfaEnroll(AuthenticationResponse mfaEnroll)
-
handleMfaEnrollActivate
void handleMfaEnrollActivate(AuthenticationResponse mfaEnrollActivate)
-
handleMfaChallenge
void handleMfaChallenge(AuthenticationResponse mfaChallengeResponse)
-
handleSuccess
void handleSuccess(AuthenticationResponse successResponse)
-
handleUnknown
void handleUnknown(AuthenticationResponse unknownResponse)
-
-