org.keycloak.authentication.RequiredActionContextResult クラス

org.keycloak.authentication.RequiredActionContextResult の継承関係図

org.keycloak.authentication.RequiredActionContextResult 連携図

公開メンバ関数
	RequiredActionContextResult (AuthenticationSessionModel authSession, RealmModel realm, EventBuilder eventBuilder, KeycloakSession session, HttpRequest httpRequest, UserModel user, RequiredActionFactory factory)
RequiredActionFactory	getFactory ()
EventBuilder	getEvent ()
UserModel	getUser ()
RealmModel	getRealm ()
AuthenticationSessionModel	getAuthenticationSession ()
ClientConnection	getConnection ()
UriInfo	getUriInfo ()
KeycloakSession	getSession ()
HttpRequest	getHttpRequest ()
Status	getStatus ()
void	challenge (Response response)
void	failure ()
void	success ()
void	ignore ()
URI	getActionUrl (String code)
String	generateCode ()
URI	getActionUrl ()
URI	getActionUrl (boolean authSessionIdParam)
LoginFormsProvider	form ()
Response	getChallenge ()

限定公開変数類
AuthenticationSessionModel	authenticationSession
RealmModel	realm
EventBuilder	eventBuilder
KeycloakSession	session
Status	status
Response	challenge
HttpRequest	httpRequest
UserModel	user
RequiredActionFactory	factory

非公開メンバ関数
String	getExecution ()

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

RequiredActionContextResult()

org.keycloak.authentication.RequiredActionContextResult.RequiredActionContextResult ( AuthenticationSessionModel  authSession, RealmModel  realm, EventBuilder  eventBuilder, KeycloakSession  session, HttpRequest  httpRequest, UserModel  user, RequiredActionFactory  factory  )

inline

                                                                                      {
        this.authenticationSession = authSession;
        this.realm = realm;
        this.eventBuilder = eventBuilder;
        this.session = session;
        this.httpRequest = httpRequest;
        this.user = user;
        this.factory = factory;
    }

関数詳解

challenge()

void org.keycloak.authentication.RequiredActionContextResult.challenge ( Response  response )

inline

                                             {
        status = Status.CHALLENGE;
        challenge = response;

    }

failure()

void org.keycloak.authentication.RequiredActionContextResult.failure ( )

inline

                          {
        status = Status.FAILURE;
    }

form()

LoginFormsProvider org.keycloak.authentication.RequiredActionContextResult.form ( )

inline

                                     {
        String accessCode = generateCode();
        URI action = getActionUrl(accessCode);
        LoginFormsProvider provider = getSession().getProvider(LoginFormsProvider.class)
                .setAuthenticationSession(getAuthenticationSession())
                .setUser(getUser())
                .setActionUri(action)
                .setExecution(getExecution())
                .setClientSessionCode(accessCode);
        return provider;
    }

generateCode()

String org.keycloak.authentication.RequiredActionContextResult.generateCode ( )

inline

                                 {
        ClientSessionCode<AuthenticationSessionModel> accessCode = new ClientSessionCode<>(session, getRealm(), getAuthenticationSession());
        authenticationSession.getParentSession().setTimestamp(Time.currentTime());
        return accessCode.getOrGenerateCode();
    }

getActionUrl() [1/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( String  code )

inline

                                         {
        ClientModel client = authenticationSession.getClient();
        return LoginActionsService.requiredActionProcessor(getUriInfo())
                .queryParam(LoginActionsService.SESSION_CODE, code)
                .queryParam(Constants.EXECUTION, getExecution())
                .queryParam(Constants.CLIENT_ID, client.getClientId())
                .queryParam(Constants.TAB_ID, authenticationSession.getTabId())
                .build(getRealm().getName());
    }

getActionUrl() [2/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( )

inline

                              {
        String accessCode = generateCode();
        return getActionUrl(accessCode);

    }

getActionUrl() [3/3]

URI org.keycloak.authentication.RequiredActionContextResult.getActionUrl ( boolean  authSessionIdParam )

inline

                                                        {
        URI uri = getActionUrl();
        if (authSessionIdParam) {
            uri = UriBuilder.fromUri(uri).queryParam(LoginActionsService.AUTH_SESSION_ID, getAuthenticationSession().getParentSession().getId()).build();
        }
        return uri;
    }

getAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.RequiredActionContextResult.getAuthenticationSession ( )

inline

                                                                 {
        return authenticationSession;
    }

getChallenge()

Response org.keycloak.authentication.RequiredActionContextResult.getChallenge ( )

inline

                                   {
        return challenge;
    }

getConnection()

ClientConnection org.keycloak.authentication.RequiredActionContextResult.getConnection ( )

inline

                                            {
        return session.getContext().getConnection();
    }

getEvent()

EventBuilder org.keycloak.authentication.RequiredActionContextResult.getEvent ( )

inline

                                   {
        return eventBuilder;
    }

getExecution()

String org.keycloak.authentication.RequiredActionContextResult.getExecution ( )

inlineprivate

                                  {
        return factory.getId();
    }

getFactory()

RequiredActionFactory org.keycloak.authentication.RequiredActionContextResult.getFactory ( )

inline

                                              {
        return factory;
    }

getHttpRequest()

HttpRequest org.keycloak.authentication.RequiredActionContextResult.getHttpRequest ( )

inline

                                        {
        return httpRequest;
    }

getRealm()

RealmModel org.keycloak.authentication.RequiredActionContextResult.getRealm ( )

inline

                                 {
        return realm;
    }

getSession()

KeycloakSession org.keycloak.authentication.RequiredActionContextResult.getSession ( )

inline

                                        {
        return session;
    }

getStatus()

Status org.keycloak.authentication.RequiredActionContextResult.getStatus ( )

inline

                              {
        return status;
    }

getUriInfo()

UriInfo org.keycloak.authentication.RequiredActionContextResult.getUriInfo ( )

inline

                                {
        return session.getContext().getUri();
    }

getUser()

UserModel org.keycloak.authentication.RequiredActionContextResult.getUser ( )

inline

                               {
        return user;
    }

ignore()

void org.keycloak.authentication.RequiredActionContextResult.ignore ( )

inline

                         {
        status = Status.IGNORE;
    }

success()

void org.keycloak.authentication.RequiredActionContextResult.success ( )

inline

                          {
        status = Status.SUCCESS;

    }

メンバ詳解

authenticationSession

AuthenticationSessionModel org.keycloak.authentication.RequiredActionContextResult.authenticationSession

protected

challenge

Response org.keycloak.authentication.RequiredActionContextResult.challenge

protected

eventBuilder

EventBuilder org.keycloak.authentication.RequiredActionContextResult.eventBuilder

protected

factory

RequiredActionFactory org.keycloak.authentication.RequiredActionContextResult.factory

protected

httpRequest

HttpRequest org.keycloak.authentication.RequiredActionContextResult.httpRequest

protected

realm

RealmModel org.keycloak.authentication.RequiredActionContextResult.realm

protected

session

KeycloakSession org.keycloak.authentication.RequiredActionContextResult.session

protected

status

Status org.keycloak.authentication.RequiredActionContextResult.status

protected

user

UserModel org.keycloak.authentication.RequiredActionContextResult.user

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/RequiredActionContextResult.java