org.keycloak.authentication.AuthenticationProcessor.Result クラス

org.keycloak.authentication.AuthenticationProcessor.Result の継承関係図

org.keycloak.authentication.AuthenticationProcessor.Result 連携図

公開メンバ関数
EventBuilder	newEvent ()
AuthenticationExecutionModel.Requirement	getCategoryRequirementFromCurrentFlow (String authenticatorCategory)
AuthenticationExecutionModel	getExecution ()
AuthenticatorConfigModel	getAuthenticatorConfig ()
Authenticator	getAuthenticator ()
FlowStatus	getStatus ()
ClientAuthenticator	getClientAuthenticator ()
void	success ()
void	failure (AuthenticationFlowError error)
void	challenge (Response challenge)
void	forceChallenge (Response challenge)
void	failureChallenge (AuthenticationFlowError error, Response challenge)
void	failure (AuthenticationFlowError error, Response challenge)
void	attempted ()
UserModel	getUser ()
void	setUser (UserModel user)
void	clearUser ()
RealmModel	getRealm ()
ClientModel	getClient ()
void	setClient (ClientModel client)
Map< String, String >	getClientAuthAttributes ()
AuthenticationSessionModel	getAuthenticationSession ()
ClientConnection	getConnection ()
UriInfo	getUriInfo ()
KeycloakSession	getSession ()
HttpRequest	getHttpRequest ()
void	attachUserSession (UserSessionModel userSession)
BruteForceProtector	getProtector ()
EventBuilder	getEvent ()
FormMessage	getForwardedErrorMessage ()
String	generateAccessCode ()
Response	getChallenge ()
AuthenticationFlowError	getError ()
LoginFormsProvider	form ()
URI	getActionUrl (String code)
URI	getActionTokenUrl (String tokenString)
URI	getActionUrl (String code, boolean authSessionIdParam)
URI	getRefreshExecutionUrl ()
URI	getRefreshUrl (boolean authSessionIdParam)
void	cancelLogin ()
void	resetFlow ()
void	resetFlow (Runnable afterResetListener)
void	fork ()
void	forkWithSuccessMessage (FormMessage message)
void	forkWithErrorMessage (FormMessage message)
FormMessage	getForwardedSuccessMessage ()
FormMessage	getErrorMessage ()
FormMessage	getSuccessMessage ()

変数
AuthenticatorConfigModel	authenticatorConfig
AuthenticationExecutionModel	execution
Authenticator	authenticator
FlowStatus	status
ClientAuthenticator	clientAuthenticator
Response	challenge
AuthenticationFlowError	error
List< AuthenticationExecutionModel >	currentExecutions
FormMessage	errorMessage
FormMessage	successMessage

非公開メンバ関数
	Result (AuthenticationExecutionModel execution, Authenticator authenticator, List< AuthenticationExecutionModel > currentExecutions)
	Result (AuthenticationExecutionModel execution, ClientAuthenticator clientAuthenticator, List< AuthenticationExecutionModel > currentExecutions)

詳解

構築子と解体子

Result() [1/2]

org.keycloak.authentication.AuthenticationProcessor.Result.Result ( AuthenticationExecutionModel  execution, Authenticator  authenticator, List< AuthenticationExecutionModel >  currentExecutions  )

inlineprivate

                                                                                                                                                  {
            this.execution = execution;
            this.authenticator = authenticator;
            this.currentExecutions = currentExecutions;
        }

Result() [2/2]

org.keycloak.authentication.AuthenticationProcessor.Result.Result ( AuthenticationExecutionModel  execution, ClientAuthenticator  clientAuthenticator, List< AuthenticationExecutionModel >  currentExecutions  )

inlineprivate

                                                                                                                                                              {
            this.execution = execution;
            this.clientAuthenticator = clientAuthenticator;
            this.currentExecutions = currentExecutions;
        }

関数詳解

attachUserSession()

void org.keycloak.authentication.AuthenticationProcessor.Result.attachUserSession ( UserSessionModel  userSession )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                                    {
            AuthenticationProcessor.this.userSession = userSession;
        }

attempted()

void org.keycloak.authentication.AuthenticationProcessor.Result.attempted ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                {
            this.status = FlowStatus.ATTEMPTED;

        }

cancelLogin()

void org.keycloak.authentication.AuthenticationProcessor.Result.cancelLogin ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                  {
            getEvent().error(Errors.REJECTED_BY_USER);
            LoginProtocol protocol = getSession().getProvider(LoginProtocol.class, getAuthenticationSession().getProtocol());
            protocol.setRealm(getRealm())
                    .setHttpHeaders(getHttpRequest().getHttpHeaders())
                    .setUriInfo(getUriInfo())
                    .setEventBuilder(event);
            Response response = protocol.sendError(getAuthenticationSession(), Error.CANCELLED_BY_USER);
            forceChallenge(response);
        }

challenge()

void org.keycloak.authentication.AuthenticationProcessor.Result.challenge ( Response  challenge )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                  {
            this.status = FlowStatus.CHALLENGE;
            this.challenge = challenge;

        }

clearUser()

void org.keycloak.authentication.AuthenticationProcessor.Result.clearUser ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                {
            clearAuthenticatedUser();
        }

failure() [1/2]

void org.keycloak.authentication.AuthenticationProcessor.Result.failure ( AuthenticationFlowError  error )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                           {
            status = FlowStatus.FAILED;
            this.error = error;

        }

failure() [2/2]

void org.keycloak.authentication.AuthenticationProcessor.Result.failure ( AuthenticationFlowError  error, Response  challenge  )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                                               {
            this.error = error;
            this.status = FlowStatus.FAILED;
            this.challenge = challenge;

        }

failureChallenge()

void org.keycloak.authentication.AuthenticationProcessor.Result.failureChallenge ( AuthenticationFlowError  error, Response  challenge  )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                                                        {
            this.error = error;
            this.status = FlowStatus.FAILURE_CHALLENGE;
            this.challenge = challenge;

        }

forceChallenge()

void org.keycloak.authentication.AuthenticationProcessor.Result.forceChallenge ( Response  challenge )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                       {
            this.status = FlowStatus.FORCE_CHALLENGE;
            this.challenge = challenge;

        }

fork()

void org.keycloak.authentication.AuthenticationProcessor.Result.fork ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                           {
            this.status = FlowStatus.FORK;
        }

forkWithErrorMessage()

void org.keycloak.authentication.AuthenticationProcessor.Result.forkWithErrorMessage ( FormMessage  message )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                              {
            this.status = FlowStatus.FORK;
            this.errorMessage = message;

        }

forkWithSuccessMessage()

void org.keycloak.authentication.AuthenticationProcessor.Result.forkWithSuccessMessage ( FormMessage  message )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                                {
            this.status = FlowStatus.FORK;
            this.successMessage = message;

        }

form()

LoginFormsProvider org.keycloak.authentication.AuthenticationProcessor.Result.form ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                         {
            String accessCode = generateAccessCode();
            URI action = getActionUrl(accessCode);
            LoginFormsProvider provider = getSession().getProvider(LoginFormsProvider.class)
                    .setAuthenticationSession(getAuthenticationSession())
                    .setUser(getUser())
                    .setActionUri(action)
                    .setExecution(getExecution().getId())
                    .setFormData(request.getDecodedFormParameters())
                    .setClientSessionCode(accessCode);
            if (getForwardedErrorMessage() != null) {
                provider.addError(getForwardedErrorMessage());
            } else if (getForwardedSuccessMessage() != null) {
                provider.addSuccess(getForwardedSuccessMessage());
            }
            return provider;
        }

generateAccessCode()

String org.keycloak.authentication.AuthenticationProcessor.Result.generateAccessCode ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                           {
            return generateCode();
        }

getActionTokenUrl()

URI org.keycloak.authentication.AuthenticationProcessor.Result.getActionTokenUrl ( String  tokenString )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                         {
            UriBuilder uriBuilder = LoginActionsService.actionTokenProcessor(getUriInfo())
                    .queryParam(Constants.KEY, tokenString)
                    .queryParam(Constants.EXECUTION, getExecution().getId())
                    .queryParam(Constants.CLIENT_ID, getAuthenticationSession().getClient().getClientId())
                    .queryParam(Constants.TAB_ID, getAuthenticationSession().getTabId());
            if (getUriInfo().getQueryParameters().containsKey(LoginActionsService.AUTH_SESSION_ID)) {
                uriBuilder.queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId());
            }
            return uriBuilder
                    .build(getRealm().getName());
        }

getActionUrl() [1/2]

URI org.keycloak.authentication.AuthenticationProcessor.Result.getActionUrl ( String  code )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                             {
            UriBuilder uriBuilder = LoginActionsService.loginActionsBaseUrl(getUriInfo())
                    .path(AuthenticationProcessor.this.flowPath)
                    .queryParam(LoginActionsService.SESSION_CODE, code)
                    .queryParam(Constants.EXECUTION, getExecution().getId())
                    .queryParam(Constants.CLIENT_ID, getAuthenticationSession().getClient().getClientId())
                    .queryParam(Constants.TAB_ID, getAuthenticationSession().getTabId());
            if (getUriInfo().getQueryParameters().containsKey(LoginActionsService.AUTH_SESSION_ID)) {
                uriBuilder.queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId());
            }
            return uriBuilder
                    .build(getRealm().getName());
        }

getActionUrl() [2/2]

URI org.keycloak.authentication.AuthenticationProcessor.Result.getActionUrl ( String  code, boolean  authSessionIdParam  )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                                         {
            UriBuilder uriBuilder = LoginActionsService.loginActionsBaseUrl(getUriInfo())
                    .path(AuthenticationProcessor.this.flowPath)
                    .queryParam(LoginActionsService.SESSION_CODE, code)
                    .queryParam(Constants.EXECUTION, getExecution().getId())
                    .queryParam(Constants.CLIENT_ID, getAuthenticationSession().getClient().getClientId())
                    .queryParam(Constants.TAB_ID, getAuthenticationSession().getTabId());
            if (authSessionIdParam) {
                uriBuilder.queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId());
            }
            return uriBuilder
                    .build(getRealm().getName());
        }

getAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.AuthenticationProcessor.Result.getAuthenticationSession ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                                     {
            return AuthenticationProcessor.this.getAuthenticationSession();
        }

getAuthenticator()

Authenticator org.keycloak.authentication.AuthenticationProcessor.Result.getAuthenticator ( )

inline

                                                {
            return authenticator;
        }

getAuthenticatorConfig()

AuthenticatorConfigModel org.keycloak.authentication.AuthenticationProcessor.Result.getAuthenticatorConfig ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                                 {
            if (execution.getAuthenticatorConfig() == null) return null;
            if (authenticatorConfig != null) return authenticatorConfig;
            authenticatorConfig = realm.getAuthenticatorConfigById(execution.getAuthenticatorConfig());
            return authenticatorConfig;
        }

getCategoryRequirementFromCurrentFlow()

AuthenticationExecutionModel.Requirement org.keycloak.authentication.AuthenticationProcessor.Result.getCategoryRequirementFromCurrentFlow ( String  authenticatorCategory )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                                                                                            {
            List<AuthenticationExecutionModel> executions = realm.getAuthenticationExecutions(execution.getParentFlow());
            for (AuthenticationExecutionModel exe : executions) {
                AuthenticatorFactory factory = (AuthenticatorFactory) getSession().getKeycloakSessionFactory().getProviderFactory(Authenticator.class, exe.getAuthenticator());
                if (factory != null && factory.getReferenceCategory().equals(authenticatorCategory)) {
                    return exe.getRequirement();
                }

            }
            return null;
        }

getChallenge()

Response org.keycloak.authentication.AuthenticationProcessor.Result.getChallenge ( )

inline

                                       {
            return challenge;
        }

getClient()

ClientModel org.keycloak.authentication.AuthenticationProcessor.Result.getClient ( )

inline

org.keycloak.authentication.ClientAuthenticationFlowContextを実装しています。

                                       {
            return AuthenticationProcessor.this.getClient();
        }

getClientAuthAttributes()

Map<String, String> org.keycloak.authentication.AuthenticationProcessor.Result.getClientAuthAttributes ( )

inline

org.keycloak.authentication.ClientAuthenticationFlowContextを実装しています。

                                                             {
            return AuthenticationProcessor.this.getClientAuthAttributes();
        }

getClientAuthenticator()

ClientAuthenticator org.keycloak.authentication.AuthenticationProcessor.Result.getClientAuthenticator ( )

inline

                                                            {
            return clientAuthenticator;
        }

getConnection()

ClientConnection org.keycloak.authentication.AuthenticationProcessor.Result.getConnection ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                {
            return AuthenticationProcessor.this.getConnection();
        }

getError()

AuthenticationFlowError org.keycloak.authentication.AuthenticationProcessor.Result.getError ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                  {
            return error;
        }

getErrorMessage()

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.getErrorMessage ( )

inline

                                             {
            return errorMessage;
        }

getEvent()

EventBuilder org.keycloak.authentication.AuthenticationProcessor.Result.getEvent ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                       {
            return AuthenticationProcessor.this.event;
        }

getExecution()

AuthenticationExecutionModel org.keycloak.authentication.AuthenticationProcessor.Result.getExecution ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                           {
            return execution;
        }

getForwardedErrorMessage()

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.getForwardedErrorMessage ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                      {
            return AuthenticationProcessor.this.forwardedErrorMessage;
        }

getForwardedSuccessMessage()

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.getForwardedSuccessMessage ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                        {
            return AuthenticationProcessor.this.forwardedSuccessMessage;
        }

getHttpRequest()

HttpRequest org.keycloak.authentication.AuthenticationProcessor.Result.getHttpRequest ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                            {
            return AuthenticationProcessor.this.request;
        }

getProtector()

BruteForceProtector org.keycloak.authentication.AuthenticationProcessor.Result.getProtector ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                                  {
            return AuthenticationProcessor.this.getBruteForceProtector();
        }

getRealm()

RealmModel org.keycloak.authentication.AuthenticationProcessor.Result.getRealm ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                     {
            return AuthenticationProcessor.this.getRealm();
        }

getRefreshExecutionUrl()

URI org.keycloak.authentication.AuthenticationProcessor.Result.getRefreshExecutionUrl ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                            {
            UriBuilder uriBuilder = LoginActionsService.loginActionsBaseUrl(getUriInfo())
                    .path(AuthenticationProcessor.this.flowPath)
                    .queryParam(Constants.EXECUTION, getExecution().getId())
                    .queryParam(Constants.CLIENT_ID, getAuthenticationSession().getClient().getClientId())
                    .queryParam(Constants.TAB_ID, getAuthenticationSession().getTabId());
            if (getUriInfo().getQueryParameters().containsKey(LoginActionsService.AUTH_SESSION_ID)) {
                uriBuilder.queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId());
            }
            return uriBuilder
                    .build(getRealm().getName());
        }

getRefreshUrl()

URI org.keycloak.authentication.AuthenticationProcessor.Result.getRefreshUrl ( boolean  authSessionIdParam )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                             {
            return AuthenticationProcessor.this.getRefreshUrl(authSessionIdParam);
        }

getSession()

KeycloakSession org.keycloak.authentication.AuthenticationProcessor.Result.getSession ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                            {
            return AuthenticationProcessor.this.getSession();
        }

getStatus()

FlowStatus org.keycloak.authentication.AuthenticationProcessor.Result.getStatus ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                      {
            return status;
        }

getSuccessMessage()

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.getSuccessMessage ( )

inline

                                               {
            return successMessage;
        }

getUriInfo()

UriInfo org.keycloak.authentication.AuthenticationProcessor.Result.getUriInfo ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                    {
            return AuthenticationProcessor.this.getUriInfo();
        }

getUser()

UserModel org.keycloak.authentication.AuthenticationProcessor.Result.getUser ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                   {
            return getAuthenticationSession().getAuthenticatedUser();
        }

newEvent()

EventBuilder org.keycloak.authentication.AuthenticationProcessor.Result.newEvent ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                                       {
            return AuthenticationProcessor.this.newEvent();
        }

resetFlow() [1/2]

void org.keycloak.authentication.AuthenticationProcessor.Result.resetFlow ( )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                {
            this.status = FlowStatus.FLOW_RESET;
        }

resetFlow() [2/2]

void org.keycloak.authentication.AuthenticationProcessor.Result.resetFlow ( Runnable  afterResetListener )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                                           {
            this.status = FlowStatus.FLOW_RESET;
            AuthenticationProcessor.this.afterResetListener = afterResetListener;
        }

setClient()

void org.keycloak.authentication.AuthenticationProcessor.Result.setClient ( ClientModel  client )

inline

org.keycloak.authentication.ClientAuthenticationFlowContextを実装しています。

                                                  {
            AuthenticationProcessor.this.setClient(client);
        }

setUser()

void org.keycloak.authentication.AuthenticationProcessor.Result.setUser ( UserModel  user )

inline

org.keycloak.authentication.AuthenticationFlowContextを実装しています。

                                            {
            setAutheticatedUser(user);
        }

success()

void org.keycloak.authentication.AuthenticationProcessor.Result.success ( )

inline

org.keycloak.authentication.AbstractAuthenticationFlowContextを実装しています。

                              {
            this.status = FlowStatus.SUCCESS;
        }

メンバ詳解

authenticator

Authenticator org.keycloak.authentication.AuthenticationProcessor.Result.authenticator

package

authenticatorConfig

AuthenticatorConfigModel org.keycloak.authentication.AuthenticationProcessor.Result.authenticatorConfig

package

challenge

Response org.keycloak.authentication.AuthenticationProcessor.Result.challenge

package

clientAuthenticator

ClientAuthenticator org.keycloak.authentication.AuthenticationProcessor.Result.clientAuthenticator

package

currentExecutions

List<AuthenticationExecutionModel> org.keycloak.authentication.AuthenticationProcessor.Result.currentExecutions

package

error

AuthenticationFlowError org.keycloak.authentication.AuthenticationProcessor.Result.error

package

errorMessage

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.errorMessage

package

execution

AuthenticationExecutionModel org.keycloak.authentication.AuthenticationProcessor.Result.execution

package

status

FlowStatus org.keycloak.authentication.AuthenticationProcessor.Result.status

package

successMessage

FormMessage org.keycloak.authentication.AuthenticationProcessor.Result.successMessage

package

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/AuthenticationProcessor.java