org.keycloak.adapters.undertow.ServletSessionTokenStore クラス

org.keycloak.adapters.undertow.ServletSessionTokenStore の継承関係図

org.keycloak.adapters.undertow.ServletSessionTokenStore 連携図

公開メンバ関数
	ServletSessionTokenStore (HttpServerExchange exchange, KeycloakDeployment deployment, UndertowUserSessionManagement sessionManagement, SecurityContext securityContext)
void	checkCurrentToken ()
boolean	isCached (RequestAuthenticator authenticator)
void	saveAccountInfo (OidcKeycloakAccount account)
void	logout ()
void	refreshCallback (RefreshableKeycloakSecurityContext securityContext)
void	saveRequest ()
boolean	restoreRequest ()

限定公開メンバ関数
HttpSession	getSession (boolean create)

静的限定公開変数類
static Logger	log = Logger.getLogger(ServletSessionTokenStore.class)

非公開変数類
final HttpServerExchange	exchange
final KeycloakDeployment	deployment
final UndertowUserSessionManagement	sessionManagement
final SecurityContext	securityContext

詳解

Per-request object. Storage of tokens in servlet HTTP session.

著者

Marek Posolda

構築子と解体子

ServletSessionTokenStore()

org.keycloak.adapters.undertow.ServletSessionTokenStore.ServletSessionTokenStore ( HttpServerExchange  exchange, KeycloakDeployment  deployment, UndertowUserSessionManagement  sessionManagement, SecurityContext  securityContext  )

inline

                                                                     {
        this.exchange = exchange;
        this.deployment = deployment;
        this.sessionManagement = sessionManagement;
        this.securityContext = securityContext;
    }

関数詳解

checkCurrentToken()

void org.keycloak.adapters.undertow.ServletSessionTokenStore.checkCurrentToken ( )

inline

org.keycloak.adapters.AdapterTokenStoreを実装しています。

                                    {
        // no-op on undertow
    }

getSession()

HttpSession org.keycloak.adapters.undertow.ServletSessionTokenStore.getSession ( boolean  create )

inlineprotected

                                                     {
        final ServletRequestContext servletRequestContext = exchange.getAttachment(ServletRequestContext.ATTACHMENT_KEY);
        HttpServletRequest req = (HttpServletRequest) servletRequestContext.getServletRequest();
        return req.getSession(create);
    }

isCached()

boolean org.keycloak.adapters.undertow.ServletSessionTokenStore.isCached ( RequestAuthenticator  authenticator )

inline

org.keycloak.adapters.AdapterTokenStoreを実装しています。

                                                                {
        HttpSession session = getSession(false);
        if (session == null) {
            log.debug("session was null, returning null");
            return false;
        }
        KeycloakUndertowAccount account = null;
        try {
            account = (KeycloakUndertowAccount)session.getAttribute(KeycloakUndertowAccount.class.getName());
        } catch (IllegalStateException e) {
            log.debug("session was invalidated.  Return false.");
            return false;
        }
        if (account == null) {
            log.debug("Account was not in session, returning null");
            return false;
        }

        if (!deployment.getRealm().equals(account.getKeycloakSecurityContext().getRealm())) {
            log.debug("Account in session belongs to a different realm than for this request.");
            return false;
        }

        account.setCurrentRequestInfo(deployment, this);
        if (account.checkActive()) {
            log.debug("Cached account found");
            securityContext.authenticationComplete(account, "KEYCLOAK", false);
            ((AbstractUndertowRequestAuthenticator)authenticator).propagateKeycloakContext(account);
            restoreRequest();
            return true;
        } else {
            log.debug("Refresh failed. Account was not active. Returning null and invalidating Http session");
            try {
                session.removeAttribute(KeycloakUndertowAccount.class.getName());
                session.removeAttribute(KeycloakSecurityContext.class.getName());
                session.invalidate();
            } catch (Exception e) {
                log.debug("Failed to invalidate session, might already be invalidated");
            }
            return false;
        }
    }

logout()

void org.keycloak.adapters.undertow.ServletSessionTokenStore.logout ( )

inline

org.keycloak.adapters.AdapterTokenStoreを実装しています。

                         {
        final ServletRequestContext servletRequestContext = exchange.getAttachment(ServletRequestContext.ATTACHMENT_KEY);
        HttpServletRequest req = (HttpServletRequest) servletRequestContext.getServletRequest();
        req.removeAttribute(KeycloakUndertowAccount.class.getName());
        req.removeAttribute(KeycloakSecurityContext.class.getName());
        HttpSession session = req.getSession(false);
        if (session == null) return;
        try {
            KeycloakUndertowAccount account = (KeycloakUndertowAccount) session.getAttribute(KeycloakUndertowAccount.class.getName());
            if (account == null) return;
            session.removeAttribute(KeycloakSecurityContext.class.getName());
            session.removeAttribute(KeycloakUndertowAccount.class.getName());
        } catch (IllegalStateException ise) {
            // Session may be already logged-out in case that app has adminUrl
            log.debugf("Session %s logged-out already", session.getId());
        }
    }

refreshCallback()

void org.keycloak.adapters.undertow.ServletSessionTokenStore.refreshCallback ( RefreshableKeycloakSecurityContext  securityContext )

inline

org.keycloak.adapters.AdapterTokenStoreを実装しています。

                                                                                    {
        // no-op
    }

restoreRequest()

boolean org.keycloak.adapters.undertow.ServletSessionTokenStore.restoreRequest ( )

inline

                                    {
        HttpSession session = getSession(false);
        if (session == null) return false;
        SavedRequest.tryRestoreRequest(exchange, session);
        return false;
    }

saveAccountInfo()

void org.keycloak.adapters.undertow.ServletSessionTokenStore.saveAccountInfo ( OidcKeycloakAccount  account )

inline

org.keycloak.adapters.AdapterTokenStoreを実装しています。

                                                             {
        final ServletRequestContext servletRequestContext = exchange.getAttachment(ServletRequestContext.ATTACHMENT_KEY);
        HttpSession session = getSession(true);
        session.setAttribute(KeycloakUndertowAccount.class.getName(), account);
        session.setAttribute(KeycloakSecurityContext.class.getName(), account.getKeycloakSecurityContext());
        sessionManagement.login(servletRequestContext.getDeployment().getSessionManager());
    }

saveRequest()

void org.keycloak.adapters.undertow.ServletSessionTokenStore.saveRequest ( )

inline

                              {
        SavedRequest.trySaveRequest(exchange);

    }

メンバ詳解

deployment

final KeycloakDeployment org.keycloak.adapters.undertow.ServletSessionTokenStore.deployment

private

exchange

final HttpServerExchange org.keycloak.adapters.undertow.ServletSessionTokenStore.exchange

private

log

Logger org.keycloak.adapters.undertow.ServletSessionTokenStore.log = Logger.getLogger(ServletSessionTokenStore.class)

staticprotected

securityContext

final SecurityContext org.keycloak.adapters.undertow.ServletSessionTokenStore.securityContext

private

sessionManagement

final UndertowUserSessionManagement org.keycloak.adapters.undertow.ServletSessionTokenStore.sessionManagement

private

---

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

• D:/AppData/OpenId/keycloak/doxygen/src/adapters/oidc/undertow/src/main/java/org/keycloak/adapters/undertow/ServletSessionTokenStore.java