com.okta.authn.sdk.AuthenticationStateHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-authn-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 3.0.0

Show newest version

/*
 * Copyright 2018 Okta, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.okta.authn.sdk;

import com.okta.authn.sdk.resource.AuthenticationResponse;

/**
 * Each method of {@code AuthenticationStateHandler} corresponds to a state of Okta's Authentication state machine. Each
 * method in @{@link com.okta.authn.sdk.client.AuthenticationClient 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:
 * 
 *     {@code handleUnknown}
 *     {@code handleSuccess}
 *     {@code handlePasswordExpired}
 *     {@code handlePasswordWarning} (unless the {@code warnBeforePasswordExpired} flag was set when calling {@link com.okta.authn.sdk.client.AuthenticationClient#authenticate(com.okta.authn.sdk.resource.AuthenticationRequest, AuthenticationStateHandler)}
 * 
 * You must implement {@code handleLockedOut}, if self-service unlock is enabled for your Okta organization.
 * If you want to support password recovery flows you must implement:
 * 
 *     {@code handleRecovery}
 *     {@code handleRecoveryChallenge}
 *     {@code handlePasswordReset}
 * 
 *
 * For multi-factor flows you must implement:
 * 
 *     {@code handleMfaRequired}
 *     {@code handleMfaEnroll}
 *     {@code handleMfaEnrollActivate}
 *     {@code handleMfaChallenge}
 * 
 *
 * @since 0.1.0
 */
public interface AuthenticationStateHandler {

    void handleUnauthenticated(AuthenticationResponse unauthenticatedResponse);

    void handlePasswordWarning(AuthenticationResponse passwordWarning);

    void handlePasswordExpired(AuthenticationResponse passwordExpired);

    void handleRecovery(AuthenticationResponse recovery);

    void handleRecoveryChallenge(AuthenticationResponse recoveryChallenge);

    void handlePasswordReset(AuthenticationResponse passwordReset);

    void handleLockedOut(AuthenticationResponse lockedOut);

    void handleMfaRequired(AuthenticationResponse mfaRequiredResponse);

    void handleMfaEnroll(AuthenticationResponse mfaEnroll);

    void handleMfaEnrollActivate(AuthenticationResponse mfaEnrollActivate);

    void handleMfaChallenge(AuthenticationResponse mfaChallengeResponse);

    void handleSuccess(AuthenticationResponse successResponse);

    void handleUnknown(AuthenticationResponse unknownResponse);
}