org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel > クラステンプレート

org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel > 連携図

クラス
enum	ActionType
class	ParseResult

公開メンバ関数
	ClientSessionCode (KeycloakSession session, RealmModel realm, CLIENT_SESSION commonLoginSession)
CLIENT_SESSION	getClientSession ()
boolean	isValid (String requestedAction, ActionType actionType)
boolean	isActionActive (ActionType actionType)
boolean	isValidAction (String requestedAction)
void	removeExpiredClientSession ()
void	setAction (String action)
String	getOrGenerateCode ()

静的公開メンバ関数
static< CLIENT_SESSION extends CommonClientSessionModel > ParseResult< CLIENT_SESSION >	parseResult (String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class< CLIENT_SESSION > sessionClass)
static< CLIENT_SESSION extends CommonClientSessionModel > ParseResult< CLIENT_SESSION >	parseResult (String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, CLIENT_SESSION clientSession)
static< CLIENT_SESSION extends CommonClientSessionModel > CLIENT_SESSION	getClientSession (String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class< CLIENT_SESSION > sessionClass)

静的非公開メンバ関数
static< CLIENT_SESSION extends CommonClientSessionModel > ParseResult< CLIENT_SESSION >	parseResult (String code, KeycloakSession session, RealmModel realm, ParseResult< CLIENT_SESSION > result, CodeGenerateUtil.ClientSessionParser< CLIENT_SESSION > clientSessionParser)
static< CLIENT_SESSION extends CommonClientSessionModel > CLIENT_SESSION	getClientSession (String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, CodeGenerateUtil.ClientSessionParser< CLIENT_SESSION > clientSessionParser)

非公開変数類
KeycloakSession	session
final RealmModel	realm
final CLIENT_SESSION	commonLoginSession

詳解

著者

Bill Burke

バージョン

Revision

1

---

クラス詳解

org::keycloak::services::managers::ClientSessionCode::ActionType

enum org::keycloak::services::managers::ClientSessionCode::ActionType

org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.ActionType 連携図

列挙値
CLIENT
LOGIN
USER

構築子と解体子

ClientSessionCode()

org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.ClientSessionCode ( KeycloakSession  session, RealmModel  realm, CLIENT_SESSION  commonLoginSession  )

inline

                                                                                                           {
        this.session = session;
        this.realm = realm;
        this.commonLoginSession = commonLoginSession;
    }

関数詳解

getClientSession() [1/3]

static <CLIENT_SESSION extends CommonClientSessionModel> CLIENT_SESSION org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.getClientSession ( String  code, String  tabId, KeycloakSession  session, RealmModel  realm, ClientModel  client, EventBuilder  event, Class< CLIENT_SESSION >  sessionClass  )

inlinestatic

                                                                                                                                                            {
        CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION> clientSessionParser = CodeGenerateUtil.getParser(sessionClass);
        return getClientSession(code, tabId, session, realm, client, event, clientSessionParser);
    }

getClientSession() [2/3]

static <CLIENT_SESSION extends CommonClientSessionModel> CLIENT_SESSION org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.getClientSession ( String  code, String  tabId, KeycloakSession  session, RealmModel  realm, ClientModel  client, EventBuilder  event, CodeGenerateUtil.ClientSessionParser< CLIENT_SESSION >  clientSessionParser  )

inlinestaticprivate

                                                                                                                                                                               {
        return clientSessionParser.parseSession(code, tabId, session, realm, client, event);
    }

getClientSession() [3/3]

CLIENT_SESSION org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.getClientSession ( )

inline

                                             {
        return commonLoginSession;
    }

getOrGenerateCode()

String org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.getOrGenerateCode ( )

inline

                                      {
        CodeGenerateUtil.ClientSessionParser parser = CodeGenerateUtil.getParser(commonLoginSession.getClass());
        return parser.retrieveCode(session, commonLoginSession);
    }

isActionActive()

boolean org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.isActionActive ( ActionType  actionType )

inline

                                                         {
        CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION> clientSessionParser = (CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION>) CodeGenerateUtil.getParser(commonLoginSession.getClass());
        int timestamp = clientSessionParser.getTimestamp(commonLoginSession);

        int lifespan;
        switch (actionType) {
            case CLIENT:
                lifespan = realm.getAccessCodeLifespan();
                break;
            case LOGIN:
                lifespan = realm.getAccessCodeLifespanLogin() > 0 ? realm.getAccessCodeLifespanLogin() : realm.getAccessCodeLifespanUserAction();
                break;
            case USER:
                lifespan = realm.getAccessCodeLifespanUserAction();
                break;
            default:
                throw new IllegalArgumentException();
        }

        return timestamp + lifespan > Time.currentTime();
    }

isValid()

boolean org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.isValid ( String  requestedAction, ActionType  actionType  )

inline

                                                                          {
        if (!isValidAction(requestedAction)) return false;
        return isActionActive(actionType);
    }

isValidAction()

boolean org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.isValidAction ( String  requestedAction )

inline

                                                         {
        String action = commonLoginSession.getAction();
        if (action == null) {
            return false;
        }
        if (!action.equals(requestedAction)) {
            return false;
        }
        return true;
    }

parseResult() [1/3]

static <CLIENT_SESSION extends CommonClientSessionModel> ParseResult<CLIENT_SESSION> org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.parseResult ( String  code, String  tabId, KeycloakSession  session, RealmModel  realm, ClientModel  client, EventBuilder  event, Class< CLIENT_SESSION >  sessionClass  )

inlinestatic

                                                                                                                                                                    {
        ParseResult<CLIENT_SESSION> result = new ParseResult<>();
        if (code == null) {
            result.illegalHash = true;
            return result;
        }
        try {
            CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION> clientSessionParser = CodeGenerateUtil.getParser(sessionClass);
            result.clientSession = getClientSession(code, tabId, session, realm, client, event, clientSessionParser);
            return parseResult(code, session, realm, result, clientSessionParser);
        } catch (RuntimeException e) {
            result.illegalHash = true;
            return result;
        }
    }

parseResult() [2/3]

static <CLIENT_SESSION extends CommonClientSessionModel> ParseResult<CLIENT_SESSION> org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.parseResult ( String  code, String  tabId, KeycloakSession  session, RealmModel  realm, ClientModel  client, EventBuilder  event, CLIENT_SESSION  clientSession  )

inlinestatic

                                                                                                                                                              {
        ParseResult<CLIENT_SESSION> result = new ParseResult<>();
        result.clientSession = clientSession;
        if (code == null) {
            result.illegalHash = true;
            return result;
        }
        try {
            CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION> clientSessionParser = CodeGenerateUtil.getParser((Class<CLIENT_SESSION>)clientSession.getClass());
            return parseResult(code, session, realm, result, clientSessionParser);
        } catch (RuntimeException e) {
            result.illegalHash = true;
            return result;
        }
    }

parseResult() [3/3]

static <CLIENT_SESSION extends CommonClientSessionModel> ParseResult<CLIENT_SESSION> org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.parseResult ( String  code, KeycloakSession  session, RealmModel  realm, ParseResult< CLIENT_SESSION >  result, CodeGenerateUtil.ClientSessionParser< CLIENT_SESSION >  clientSessionParser  )

inlinestaticprivate

                                                                                                                                                                                                                                                                                   {
        if (result.clientSession == null) {
            result.authSessionNotFound = true;
            return result;
        }

        if (!clientSessionParser.verifyCode(session, code, result.clientSession)) {
            result.illegalHash = true;
            return result;
        }

        if (clientSessionParser.isExpired(session, code, result.clientSession)) {
            result.expiredToken = true;
            return result;
        }

        result.code = new ClientSessionCode<CLIENT_SESSION>(session, realm, result.clientSession);
        return result;
    }

removeExpiredClientSession()

void org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.removeExpiredClientSession ( )

inline

                                             {
        CodeGenerateUtil.ClientSessionParser parser = CodeGenerateUtil.getParser(commonLoginSession.getClass());
        parser.removeExpiredSession(session, commonLoginSession);
    }

setAction()

void org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.setAction ( String  action )

inline

                                         {
        commonLoginSession.setAction(action);

        CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION> clientSessionParser = (CodeGenerateUtil.ClientSessionParser<CLIENT_SESSION>) CodeGenerateUtil.getParser(commonLoginSession.getClass());
        clientSessionParser.setTimestamp(commonLoginSession, Time.currentTime());
    }

メンバ詳解

commonLoginSession

final CLIENT_SESSION org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.commonLoginSession

private

realm

final RealmModel org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.realm

private

session

KeycloakSession org.keycloak.services.managers.ClientSessionCode< CLIENT_SESSION extends CommonClientSessionModel >.session

private

---

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

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