com.okta.authn.sdk

Interface AuthenticationStateHandler

All Known Implementing Classes:

AuthenticationStateHandlerAdapter

public interface AuthenticationStateHandler

Each method of AuthenticationStateHandler 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 the warnBeforePasswordExpired flag was set when calling AuthenticationClient.authenticate(com.okta.authn.sdk.resource.AuthenticationRequest, AuthenticationStateHandler)

You must implement 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

For multi-factor flows you must implement:

• handleMfaRequired
• handleMfaEnroll
• handleMfaEnrollActivate
• handleMfaChallenge

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
void	handleLockedOut(@NotNull AuthenticationResponse lockedOut)
void	handleMfaChallenge(@NotNull AuthenticationResponse mfaChallengeResponse)
void	handleMfaEnroll(@NotNull AuthenticationResponse mfaEnroll)
void	handleMfaEnrollActivate(@NotNull AuthenticationResponse mfaEnrollActivate)
void	handleMfaRequired(@NotNull AuthenticationResponse mfaRequiredResponse)
void	handlePasswordExpired(@NotNull AuthenticationResponse passwordExpired)
void	handlePasswordReset(@NotNull AuthenticationResponse passwordReset)
void	handlePasswordWarning(@NotNull AuthenticationResponse passwordWarning)
void	handleRecovery(@NotNull AuthenticationResponse recovery)
void	handleRecoveryChallenge(@NotNull AuthenticationResponse recoveryChallenge)
void	handleSuccess(@NotNull AuthenticationResponse successResponse)
void	handleUnauthenticated(@NotNull AuthenticationResponse unauthenticatedResponse)
void	handleUnknown(@NotNull AuthenticationResponse unknownResponse)

Method Detail

handleUnauthenticated

void handleUnauthenticated(@NotNull
                           @NotNull AuthenticationResponse unauthenticatedResponse)

handlePasswordWarning

void handlePasswordWarning(@NotNull
                           @NotNull AuthenticationResponse passwordWarning)

handlePasswordExpired

void handlePasswordExpired(@NotNull
                           @NotNull AuthenticationResponse passwordExpired)

handleRecovery

void handleRecovery(@NotNull
                    @NotNull AuthenticationResponse recovery)

handleRecoveryChallenge

void handleRecoveryChallenge(@NotNull
                             @NotNull AuthenticationResponse recoveryChallenge)

handlePasswordReset

void handlePasswordReset(@NotNull
                         @NotNull AuthenticationResponse passwordReset)

handleLockedOut

void handleLockedOut(@NotNull
                     @NotNull AuthenticationResponse lockedOut)

handleMfaRequired

void handleMfaRequired(@NotNull
                       @NotNull AuthenticationResponse mfaRequiredResponse)

handleMfaEnroll

void handleMfaEnroll(@NotNull
                     @NotNull AuthenticationResponse mfaEnroll)

handleMfaEnrollActivate

void handleMfaEnrollActivate(@NotNull
                             @NotNull AuthenticationResponse mfaEnrollActivate)

handleMfaChallenge

void handleMfaChallenge(@NotNull
                        @NotNull AuthenticationResponse mfaChallengeResponse)

handleSuccess

void handleSuccess(@NotNull
                   @NotNull AuthenticationResponse successResponse)

handleUnknown

void handleUnknown(@NotNull
                   @NotNull AuthenticationResponse unknownResponse)