Package com.okta.authn.sdk
Interface AuthenticationStateHandler
-
- All Known Implementing Classes:
AuthenticationStateHandlerAdapter,ExampleAuthenticationStateHandler
public interface AuthenticationStateHandlerEach method ofAuthenticationStateHandlercorresponds to a state of Okta's Authentication state machine. Each method in @AuthenticationClientmay 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:handleUnknownhandleSuccesshandlePasswordExpiredhandlePasswordWarning(unless thewarnBeforePasswordExpiredflag 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:handleRecoveryhandleRecoveryChallengehandlePasswordReset
handleMfaRequiredhandleMfaEnrollhandleMfaEnrollActivatehandleMfaChallenge
- Since:
- 0.1.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidhandleLockedOut(AuthenticationResponse lockedOut)voidhandleMfaChallenge(AuthenticationResponse mfaChallengeResponse)voidhandleMfaEnroll(AuthenticationResponse mfaEnroll)voidhandleMfaEnrollActivate(AuthenticationResponse mfaEnrollActivate)voidhandleMfaRequired(AuthenticationResponse mfaRequiredResponse)voidhandlePasswordExpired(AuthenticationResponse passwordExpired)voidhandlePasswordReset(AuthenticationResponse passwordReset)voidhandlePasswordWarning(AuthenticationResponse passwordWarning)voidhandleRecovery(AuthenticationResponse recovery)voidhandleRecoveryChallenge(AuthenticationResponse recoveryChallenge)voidhandleSuccess(AuthenticationResponse successResponse)voidhandleUnauthenticated(AuthenticationResponse unauthenticatedResponse)voidhandleUnknown(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)
-
-