org.keycloak.services.resources.admin.AdminConsole クラス

org.keycloak.services.resources.admin.AdminConsole 連携図

クラス
class	WhoAmI

公開メンバ関数
	AdminConsole (RealmModel realm)
ClientManager.InstallationAdapterConfig	config ()
Response	whoAmI (final @Context HttpHeaders headers)
Response	logout ()
Response	getMainPage () throws URISyntaxException, IOException, FreeMarkerException
Response	getIndexHtmlRedirect ()
Properties	getMessages (@QueryParam("lang") String lang)

限定公開メンバ関数
RealmModel	getAdminstrationRealm (RealmManager realmManager)

限定公開変数類
ClientConnection	clientConnection
HttpRequest	request
HttpResponse	response
KeycloakSession	session
Providers	providers
KeycloakApplication	keycloak
AppAuthManager	authManager
RealmModel	realm

静的限定公開変数類
static final Logger	logger = Logger.getLogger(AdminConsole.class)

非公開メンバ関数
void	addRealmAccess (RealmModel realm, UserModel user, Map< String, Set< String >> realmAdminAccess)
void	addMasterRealmAccess (RealmModel masterRealm, UserModel user, Map< String, Set< String >> realmAdminAccess)

詳解

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AdminConsole()

org.keycloak.services.resources.admin.AdminConsole.AdminConsole ( RealmModel  realm )

inline

                                          {
        this.realm = realm;
        this.authManager = new AppAuthManager();
    }

関数詳解

addMasterRealmAccess()

void org.keycloak.services.resources.admin.AdminConsole.addMasterRealmAccess ( RealmModel  masterRealm, UserModel  user, Map< String, Set< String >>  realmAdminAccess  )

inlineprivate

                                                                                                                         {
        List<RealmModel> realms = session.realms().getRealms();
        for (RealmModel realm : realms) {
            ClientModel realmAdminApp = realm.getMasterAdminClient();
            Set<RoleModel> roles = realmAdminApp.getRoles();
            for (RoleModel role : roles) {
                if (!user.hasRole(role)) continue;
                if (!realmAdminAccess.containsKey(realm.getName())) {
                    realmAdminAccess.put(realm.getName(), new HashSet<String>());
                }
                realmAdminAccess.get(realm.getName()).add(role.getName());
            }
        }
    }

addRealmAccess()

void org.keycloak.services.resources.admin.AdminConsole.addRealmAccess ( RealmModel  realm, UserModel  user, Map< String, Set< String >>  realmAdminAccess  )

inlineprivate

                                                                                                             {
        RealmManager realmManager = new RealmManager(session);
        ClientModel realmAdminApp = realm.getClientByClientId(realmManager.getRealmAdminClientId(realm));
        Set<RoleModel> roles = realmAdminApp.getRoles();
        for (RoleModel role : roles) {
            if (!user.hasRole(role)) continue;
            if (!realmAdminAccess.containsKey(realm.getName())) {
                realmAdminAccess.put(realm.getName(), new HashSet<String>());
            }
            realmAdminAccess.get(realm.getName()).add(role.getName());
        }

    }

config()

ClientManager.InstallationAdapterConfig org.keycloak.services.resources.admin.AdminConsole.config ( )

inline

Adapter configuration for the admin console for this realm

戻り値

                                                            {
        ClientModel consoleApp = realm.getClientByClientId(Constants.ADMIN_CONSOLE_CLIENT_ID);
        if (consoleApp == null) {
            throw new NotFoundException("Could not find admin console client");
        }
        return new ClientManager(new RealmManager(session)).toInstallationRepresentation(realm, consoleApp, keycloak.getBaseUri(session.getContext().getUri()));

    }

getAdminstrationRealm()

RealmModel org.keycloak.services.resources.admin.AdminConsole.getAdminstrationRealm ( RealmManager  realmManager )

inlineprotected

                                                                          {
        return realmManager.getKeycloakAdminstrationRealm();
    }

getIndexHtmlRedirect()

Response org.keycloak.services.resources.admin.AdminConsole.getIndexHtmlRedirect ( )

inline

                                           {
        return Response.status(302).location(session.getContext().getUri().getRequestUriBuilder().path("../").build()).build();
    }

getMainPage()

Response org.keycloak.services.resources.admin.AdminConsole.getMainPage ( ) throws URISyntaxException, IOException, FreeMarkerException

inline

Main page of this realm's admin console

戻り値

例外

URISyntaxException

                                                                                              {
        if (!session.getContext().getUri().getRequestUri().getPath().endsWith("/")) {
            return Response.status(302).location(session.getContext().getUri().getRequestUriBuilder().path("/").build()).build();
        } else {
            Theme theme = AdminRoot.getTheme(session, realm);

            Map<String, Object> map = new HashMap<>();

            URI baseUri = session.getContext().getUri().getBaseUri();

            map.put("authUrl", session.getContext().getContextPath());
            map.put("consoleBaseUrl", Urls.adminConsoleRoot(baseUri, realm.getName()).getPath());
            map.put("resourceUrl", Urls.themeRoot(baseUri).getPath() + "/admin/" + theme.getName());
            map.put("masterRealm", Config.getAdminRealm());
            map.put("resourceVersion", Version.RESOURCES_VERSION);
            map.put("properties", theme.getProperties());

            FreeMarkerUtil freeMarkerUtil = new FreeMarkerUtil();
            String result = freeMarkerUtil.processTemplate(map, "index.ftl", theme);
            Response.ResponseBuilder builder = Response.status(Response.Status.OK).type(MediaType.TEXT_HTML_UTF_8).language(Locale.ENGLISH).entity(result);
            BrowserSecurityHeaderSetup.headers(builder, realm);
            return builder.build();
        }
    }

getMessages()

Properties org.keycloak.services.resources.admin.AdminConsole.getMessages ( @QueryParam("lang") String  lang )

inline

                                                                   {
        return AdminRoot.getMessages(session, realm, lang, "admin-messages");
    }

logout()

Response org.keycloak.services.resources.admin.AdminConsole.logout ( )

inline

Logout from the admin console

戻り値

                             {
        URI redirect = AdminRoot.adminConsoleUrl(session.getContext().getUri()).build(realm.getName());

        return Response.status(302).location(
                OIDCLoginProtocolService.logoutUrl(session.getContext().getUri()).queryParam("redirect_uri", redirect.toString()).build(realm.getName())
        ).build();
    }

whoAmI()

Response org.keycloak.services.resources.admin.AdminConsole.whoAmI ( final @Context HttpHeaders  headers )

inline

Permission information

引数

headers

戻り値

                                                               {
        RealmManager realmManager = new RealmManager(session);
        AuthenticationManager.AuthResult authResult = authManager.authenticateBearerToken(session, realm, session.getContext().getUri(), clientConnection, headers);
        if (authResult == null) {
            return Response.status(401).build();
        }
        UserModel user= authResult.getUser();
        String displayName;
        if ((user.getFirstName() != null && !user.getFirstName().trim().equals("")) || (user.getLastName() != null && !user.getLastName().trim().equals(""))) {
            displayName = user.getFirstName();
            if (user.getLastName() != null) {
                displayName = displayName != null ? displayName + " " + user.getLastName() : user.getLastName();
            }
        } else {
            displayName = user.getUsername();
        }

        RealmModel masterRealm = getAdminstrationRealm(realmManager);
        Map<String, Set<String>> realmAccess = new HashMap<String, Set<String>>();
        if (masterRealm == null)
            throw new NotFoundException("No realm found");
        boolean createRealm = false;
        if (realm.equals(masterRealm)) {
            logger.debug("setting up realm access for a master realm user");
            createRealm = user.hasRole(masterRealm.getRole(AdminRoles.CREATE_REALM));
            addMasterRealmAccess(realm, user, realmAccess);
        } else {
            logger.debug("setting up realm access for a realm user");
            addRealmAccess(realm, user, realmAccess);
        }

        return Response.ok(new WhoAmI(user.getId(), realm.getName(), displayName, createRealm, realmAccess)).build();
    }

メンバ詳解

authManager

AppAuthManager org.keycloak.services.resources.admin.AdminConsole.authManager

protected

clientConnection

ClientConnection org.keycloak.services.resources.admin.AdminConsole.clientConnection

protected

keycloak

KeycloakApplication org.keycloak.services.resources.admin.AdminConsole.keycloak

protected

logger

final Logger org.keycloak.services.resources.admin.AdminConsole.logger = Logger.getLogger(AdminConsole.class)

staticprotected

providers

Providers org.keycloak.services.resources.admin.AdminConsole.providers

protected

realm

RealmModel org.keycloak.services.resources.admin.AdminConsole.realm

protected

request

HttpRequest org.keycloak.services.resources.admin.AdminConsole.request

protected

response

HttpResponse org.keycloak.services.resources.admin.AdminConsole.response

protected

session

KeycloakSession org.keycloak.services.resources.admin.AdminConsole.session

protected

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/AdminConsole.java