org.keycloak.services.util.DefaultClientSessionContext クラス

org.keycloak.services.util.DefaultClientSessionContext の継承関係図

org.keycloak.services.util.DefaultClientSessionContext 連携図

公開メンバ関数
AuthenticatedClientSessionModel	getClientSession ()
Set< String >	getClientScopeIds ()
Set< ClientScopeModel >	getClientScopes ()
Set< RoleModel >	getRoles ()
Set< ProtocolMapperModel >	getProtocolMappers ()
String	getScopeString ()

静的公開メンバ関数
static DefaultClientSessionContext	fromClientSessionScopeParameter (AuthenticatedClientSessionModel clientSession)
static DefaultClientSessionContext	fromClientSessionAndScopeParameter (AuthenticatedClientSessionModel clientSession, String scopeParam)
static DefaultClientSessionContext	fromClientSessionAndClientScopeIds (AuthenticatedClientSessionModel clientSession, Set< String > clientScopeIds)
static DefaultClientSessionContext	fromClientSessionAndClientScopes (AuthenticatedClientSessionModel clientSession, Set< ClientScopeModel > clientScopes)

非公開メンバ関数
	DefaultClientSessionContext (AuthenticatedClientSessionModel clientSession, Set< String > clientScopeIds)
Set< ClientScopeModel >	loadClientScopes ()
Set< RoleModel >	loadRoles ()
Set< ProtocolMapperModel >	loadProtocolMappers ()

非公開変数類
final AuthenticatedClientSessionModel	clientSession
final Set< String >	clientScopeIds
Set< ClientScopeModel >	clientScopes
Set< RoleModel >	roles
Set< ProtocolMapperModel >	protocolMappers

静的非公開変数類
static Logger	logger = Logger.getLogger(DefaultClientSessionContext.class)

詳解

Not thread safe. It's per-request object

著者

Marek Posolda

構築子と解体子

DefaultClientSessionContext()

org.keycloak.services.util.DefaultClientSessionContext.DefaultClientSessionContext ( AuthenticatedClientSessionModel  clientSession, Set< String >  clientScopeIds  )

inlineprivate

                                                                                                                   {
        this.clientSession = clientSession;
        this.clientScopeIds = clientScopeIds;
    }

関数詳解

fromClientSessionAndClientScopeIds()

static DefaultClientSessionContext org.keycloak.services.util.DefaultClientSessionContext.fromClientSessionAndClientScopeIds ( AuthenticatedClientSessionModel  clientSession, Set< String >  clientScopeIds  )

inlinestatic

                                                                                                                                                            {
        return new DefaultClientSessionContext(clientSession, clientScopeIds);
    }

fromClientSessionAndClientScopes()

static DefaultClientSessionContext org.keycloak.services.util.DefaultClientSessionContext.fromClientSessionAndClientScopes ( AuthenticatedClientSessionModel  clientSession, Set< ClientScopeModel >  clientScopes  )

inlinestatic

                                                                                                                                                                  {
        Set<String> clientScopeIds = new HashSet<>();
        for (ClientScopeModel clientScope : clientScopes) {
            clientScopeIds.add(clientScope.getId());
        }

        DefaultClientSessionContext ctx = new DefaultClientSessionContext(clientSession, clientScopeIds);
        ctx.clientScopes = new HashSet<>(clientScopes);
        return ctx;
    }

fromClientSessionAndScopeParameter()

static DefaultClientSessionContext org.keycloak.services.util.DefaultClientSessionContext.fromClientSessionAndScopeParameter ( AuthenticatedClientSessionModel  clientSession, String  scopeParam  )

inlinestatic

                                                                                                                                                   {
        Set<ClientScopeModel> requestedClientScopes = TokenManager.getRequestedClientScopes(scopeParam, clientSession.getClient());
        return fromClientSessionAndClientScopes(clientSession, requestedClientScopes);
    }

fromClientSessionScopeParameter()

static DefaultClientSessionContext org.keycloak.services.util.DefaultClientSessionContext.fromClientSessionScopeParameter ( AuthenticatedClientSessionModel  clientSession )

inlinestatic

Useful if we want to "re-compute" client scopes based on the scope parameter

                                                                                                                             {
        return fromClientSessionAndScopeParameter(clientSession, clientSession.getNote(OAuth2Constants.SCOPE));
    }

getClientScopeIds()

Set<String> org.keycloak.services.util.DefaultClientSessionContext.getClientScopeIds ( )

inline

                                           {
        return clientScopeIds;
    }

getClientScopes()

Set<ClientScopeModel> org.keycloak.services.util.DefaultClientSessionContext.getClientScopes ( )

inline

                                                   {
        // Load client scopes if not yet present
        if (clientScopes == null) {
            clientScopes = loadClientScopes();
        }
        return clientScopes;
    }

getClientSession()

AuthenticatedClientSessionModel org.keycloak.services.util.DefaultClientSessionContext.getClientSession ( )

inline

                                                              {
        return clientSession;
    }

getProtocolMappers()

Set<ProtocolMapperModel> org.keycloak.services.util.DefaultClientSessionContext.getProtocolMappers ( )

inline

                                                         {
        // Load roles if not yet present
        if (protocolMappers == null) {
            protocolMappers = loadProtocolMappers();
        }
        return protocolMappers;
    }

getRoles()

Set<RoleModel> org.keycloak.services.util.DefaultClientSessionContext.getRoles ( )

inline

                                     {
        // Load roles if not yet present
        if (roles == null) {
            roles = loadRoles();
        }
        return roles;
    }

getScopeString()

String org.keycloak.services.util.DefaultClientSessionContext.getScopeString ( )

inline

                                   {
        StringBuilder builder = new StringBuilder();

        // Add both default and optional scopes to scope parameter. Don't add client itself
        boolean first = true;
        for (ClientScopeModel clientScope : getClientScopes()) {
            if (clientScope instanceof ClientModel) {
                continue;
            }

            if (first) {
                first = false;
            } else {
                builder.append(" ");
            }
            builder.append(clientScope.getName());
        }

        String scopeParam = builder.toString();

        // See if "openid" scope is requested
        String scopeSent = clientSession.getNote(OAuth2Constants.SCOPE);
        if (TokenUtil.isOIDCRequest(scopeSent)) {
            scopeParam = TokenUtil.attachOIDCScope(scopeParam);
        }

        return scopeParam;
    }

loadClientScopes()

Set<ClientScopeModel> org.keycloak.services.util.DefaultClientSessionContext.loadClientScopes ( )

inlineprivate

                                                     {
        Set<ClientScopeModel> clientScopes = new HashSet<>();
        for (String scopeId : clientScopeIds) {
            ClientScopeModel clientScope = KeycloakModelUtils.findClientScopeById(clientSession.getClient().getRealm(), scopeId);
            if (clientScope != null) {
                clientScopes.add(clientScope);
            }
        }
        return clientScopes;
    }

loadProtocolMappers()

Set<ProtocolMapperModel> org.keycloak.services.util.DefaultClientSessionContext.loadProtocolMappers ( )

inlineprivate

                                                           {
        Set<ClientScopeModel> clientScopes = getClientScopes();
        String protocol = clientSession.getClient().getProtocol();

        // Being rather defensive. But protocol should normally always be there
        if (protocol == null) {
            logger.warnf("Client '%s' doesn't have protocol set. Fallback to openid-connect. Please fix client configuration", clientSession.getClient().getClientId());
            protocol = OIDCLoginProtocol.LOGIN_PROTOCOL;
        }

        Set<ProtocolMapperModel> protocolMappers = new HashSet<>();
        for (ClientScopeModel clientScope : clientScopes) {
            Set<ProtocolMapperModel> currentMappers = clientScope.getProtocolMappers();
            for (ProtocolMapperModel currentMapper : currentMappers) {
                if (protocol.equals(currentMapper.getProtocol())) {
                    protocolMappers.add(currentMapper);
                }
            }
        }

        return protocolMappers;
    }

loadRoles()

Set<RoleModel> org.keycloak.services.util.DefaultClientSessionContext.loadRoles ( )

inlineprivate

                                       {
        UserModel user = clientSession.getUserSession().getUser();
        ClientModel client = clientSession.getClient();

        Set<ClientScopeModel> clientScopes = getClientScopes();

        return TokenManager.getAccess(user, client, clientScopes);
    }

メンバ詳解

clientScopeIds

final Set<String> org.keycloak.services.util.DefaultClientSessionContext.clientScopeIds

private

clientScopes

Set<ClientScopeModel> org.keycloak.services.util.DefaultClientSessionContext.clientScopes

private

clientSession

final AuthenticatedClientSessionModel org.keycloak.services.util.DefaultClientSessionContext.clientSession

private

logger

Logger org.keycloak.services.util.DefaultClientSessionContext.logger = Logger.getLogger(DefaultClientSessionContext.class)

staticprivate

protocolMappers

Set<ProtocolMapperModel> org.keycloak.services.util.DefaultClientSessionContext.protocolMappers

private

roles

Set<RoleModel> org.keycloak.services.util.DefaultClientSessionContext.roles

private

---

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

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