com.okta.authn.sdk.impl.client

Class DefaultAuthenticationClient

java.lang.Object

com.okta.sdk.impl.client.BaseClient

com.okta.authn.sdk.impl.client.DefaultAuthenticationClient

All Implemented Interfaces:

AuthenticationClient, com.okta.sdk.ds.DataStore

public class DefaultAuthenticationClient
extends com.okta.sdk.impl.client.BaseClient
implements AuthenticationClient

Constructor Summary

Constructors

Constructor and Description
DefaultAuthenticationClient(com.okta.sdk.impl.config.ClientConfiguration clientConfiguration) Instantiates a new AuthenticationClient instance that will communicate with the Okta REST API.

Method Summary

Modifier and Type	Method and Description
AuthenticationResponse	activateFactor(String factorId, ActivateFactorRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	answerRecoveryQuestion(RecoveryQuestionAnswerRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	answerRecoveryQuestion(String answer, String stateToken, AuthenticationStateHandler stateHandler)
AuthenticationResponse	authenticate(AuthenticationRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	authenticate(String username, char[] password, String relayState, AuthenticationStateHandler stateHandler)
AuthenticationResponse	cancel(String stateToken, RequestContext requestContext)
AuthenticationResponse	challengeFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	changePassword(ChangePasswordRequest changePasswordRequest, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	changePassword(char[] oldPassword, char[] newPassword, String stateToken, AuthenticationStateHandler stateHandler)
AuthenticationResponse	enrollFactor(FactorEnrollRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	enrollFactor(FactorType type, FactorProvider provider, FactorProfile factorProfile, String stateToken, AuthenticationStateHandler stateHandler)
AuthenticationResponse	previous(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	recoverPassword(RecoverPasswordRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	recoverPassword(String username, FactorType factorType, String relayState, AuthenticationStateHandler stateHandler)
AuthenticationResponse	resendActivateFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	resendVerifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	resetPassword(ChangePasswordRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	resetPassword(char[] newPassword, String stateToken, AuthenticationStateHandler stateHandler)
AuthenticationResponse	skip(String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	unlockAccount(String username, FactorType factorType, String relayState, AuthenticationStateHandler stateHandler)
AuthenticationResponse	unlockAccount(UnlockAccountRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	verifyActivation(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	verifyFactor(String factorId, String stateToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	verifyFactor(String factorId, VerifyFactorRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	verifyRecoveryToken(String recoveryToken, RequestContext requestContext, AuthenticationStateHandler stateHandler)
AuthenticationResponse	verifyUnlockAccount(FactorType factorType, VerifyRecoveryRequest request, RequestContext requestContext, AuthenticationStateHandler stateHandler)

Methods inherited from class com.okta.sdk.impl.client.BaseClient

create, createDataStore, createRequestExecutor, delete, getCacheManager, getClientCredentials, getDataStore, getResource, http, instantiate, save

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.okta.authn.sdk.client.AuthenticationClient

activateFactor, answerRecoveryQuestion, authenticate, cancel, challengeFactor, changePassword, enrollFactor, getDataStore, instantiate, previous, recoverPassword, resendActivateFactor, resendVerifyFactor, resetPassword, skip, unlockAccount, verifyActivation, verifyFactor, verifyFactor, verifyRecoveryToken, verifyUnlockAccount

Constructor Detail

DefaultAuthenticationClient

public DefaultAuthenticationClient(com.okta.sdk.impl.config.ClientConfiguration clientConfiguration)

Instantiates a new AuthenticationClient instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.

Parameters:

clientConfiguration - the ClientConfiguration containing the connection information

Method Detail

authenticate

public AuthenticationResponse authenticate(String username,
                                           char[] password,
                                           String relayState,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

authenticate in interface AuthenticationClient

Throws:

AuthenticationException

authenticate

public AuthenticationResponse authenticate(AuthenticationRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

authenticate in interface AuthenticationClient

Throws:

AuthenticationException

changePassword

public AuthenticationResponse changePassword(char[] oldPassword,
                                             char[] newPassword,
                                             String stateToken,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Specified by:

changePassword in interface AuthenticationClient

Throws:

AuthenticationException

changePassword

public AuthenticationResponse changePassword(ChangePasswordRequest changePasswordRequest,
                                             RequestContext requestContext,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Specified by:

changePassword in interface AuthenticationClient

Throws:

AuthenticationException

resetPassword

public AuthenticationResponse resetPassword(char[] newPassword,
                                            String stateToken,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Specified by:

resetPassword in interface AuthenticationClient

Throws:

AuthenticationException

resetPassword

public AuthenticationResponse resetPassword(ChangePasswordRequest request,
                                            RequestContext requestContext,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Specified by:

resetPassword in interface AuthenticationClient

Throws:

AuthenticationException

recoverPassword

public AuthenticationResponse recoverPassword(String username,
                                              FactorType factorType,
                                              String relayState,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Specified by:

recoverPassword in interface AuthenticationClient

Throws:

AuthenticationException

recoverPassword

public AuthenticationResponse recoverPassword(RecoverPasswordRequest request,
                                              RequestContext requestContext,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Specified by:

recoverPassword in interface AuthenticationClient

Throws:

AuthenticationException

challengeFactor

public AuthenticationResponse challengeFactor(String factorId,
                                              String stateToken,
                                              RequestContext requestContext,
                                              AuthenticationStateHandler stateHandler)
                                       throws AuthenticationException

Specified by:

challengeFactor in interface AuthenticationClient

Throws:

AuthenticationException

verifyFactor

public AuthenticationResponse verifyFactor(String factorId,
                                           String stateToken,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

verifyFactor in interface AuthenticationClient

Throws:

AuthenticationException

verifyFactor

public AuthenticationResponse verifyFactor(String factorId,
                                           VerifyFactorRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

verifyFactor in interface AuthenticationClient

Throws:

AuthenticationException

activateFactor

public AuthenticationResponse activateFactor(String factorId,
                                             ActivateFactorRequest request,
                                             RequestContext requestContext,
                                             AuthenticationStateHandler stateHandler)
                                      throws AuthenticationException

Specified by:

activateFactor in interface AuthenticationClient

Throws:

AuthenticationException

verifyUnlockAccount

public AuthenticationResponse verifyUnlockAccount(FactorType factorType,
                                                  VerifyRecoveryRequest request,
                                                  RequestContext requestContext,
                                                  AuthenticationStateHandler stateHandler)
                                           throws AuthenticationException

Specified by:

verifyUnlockAccount in interface AuthenticationClient

Throws:

AuthenticationException

unlockAccount

public AuthenticationResponse unlockAccount(String username,
                                            FactorType factorType,
                                            String relayState,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Specified by:

unlockAccount in interface AuthenticationClient

Throws:

AuthenticationException

unlockAccount

public AuthenticationResponse unlockAccount(UnlockAccountRequest request,
                                            RequestContext requestContext,
                                            AuthenticationStateHandler stateHandler)
                                     throws AuthenticationException

Specified by:

unlockAccount in interface AuthenticationClient

Throws:

AuthenticationException

answerRecoveryQuestion

public AuthenticationResponse answerRecoveryQuestion(String answer,
                                                     String stateToken,
                                                     AuthenticationStateHandler stateHandler)
                                              throws AuthenticationException

Specified by:

answerRecoveryQuestion in interface AuthenticationClient

Throws:

AuthenticationException

answerRecoveryQuestion

public AuthenticationResponse answerRecoveryQuestion(RecoveryQuestionAnswerRequest request,
                                                     RequestContext requestContext,
                                                     AuthenticationStateHandler stateHandler)
                                              throws AuthenticationException

Specified by:

answerRecoveryQuestion in interface AuthenticationClient

Throws:

AuthenticationException

enrollFactor

public AuthenticationResponse enrollFactor(FactorType type,
                                           FactorProvider provider,
                                           FactorProfile factorProfile,
                                           String stateToken,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

enrollFactor in interface AuthenticationClient

Throws:

AuthenticationException

enrollFactor

public AuthenticationResponse enrollFactor(FactorEnrollRequest request,
                                           RequestContext requestContext,
                                           AuthenticationStateHandler stateHandler)
                                    throws AuthenticationException

Specified by:

enrollFactor in interface AuthenticationClient

Throws:

AuthenticationException

previous

public AuthenticationResponse previous(String stateToken,
                                       RequestContext requestContext,
                                       AuthenticationStateHandler stateHandler)
                                throws AuthenticationException

Specified by:

previous in interface AuthenticationClient

Throws:

AuthenticationException

skip

public AuthenticationResponse skip(String stateToken,
                                   RequestContext requestContext,
                                   AuthenticationStateHandler stateHandler)
                            throws AuthenticationException

Specified by:

skip in interface AuthenticationClient

Throws:

AuthenticationException

cancel

public AuthenticationResponse cancel(String stateToken,
                                     RequestContext requestContext)
                              throws AuthenticationException

Specified by:

cancel in interface AuthenticationClient

Throws:

AuthenticationException

resendActivateFactor

public AuthenticationResponse resendActivateFactor(String factorId,
                                                   String stateToken,
                                                   RequestContext requestContext,
                                                   AuthenticationStateHandler stateHandler)
                                            throws AuthenticationException

Specified by:

resendActivateFactor in interface AuthenticationClient

Throws:

AuthenticationException

resendVerifyFactor

public AuthenticationResponse resendVerifyFactor(String factorId,
                                                 String stateToken,
                                                 RequestContext requestContext,
                                                 AuthenticationStateHandler stateHandler)
                                          throws AuthenticationException

Specified by:

resendVerifyFactor in interface AuthenticationClient

Throws:

AuthenticationException

verifyActivation

public AuthenticationResponse verifyActivation(String factorId,
                                               String stateToken,
                                               RequestContext requestContext,
                                               AuthenticationStateHandler stateHandler)
                                        throws AuthenticationException

Specified by:

verifyActivation in interface AuthenticationClient

Throws:

AuthenticationException

verifyRecoveryToken

public AuthenticationResponse verifyRecoveryToken(String recoveryToken,
                                                  RequestContext requestContext,
                                                  AuthenticationStateHandler stateHandler)
                                           throws AuthenticationException

Specified by:

verifyRecoveryToken in interface AuthenticationClient

Throws:

AuthenticationException