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

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

公開メンバ関数
	AdminRoot ()
Response	masterRealmAdminConsoleRedirect ()
Response	masterRealmAdminConsoleRedirectHtml ()
AdminConsole	getAdminConsole (final @PathParam("realm") String name)
Object	getRealmsAdmin (@Context final HttpHeaders headers)
Object	getServerInfo (@Context final HttpHeaders headers)

静的公開メンバ関数
static UriBuilder	adminBaseUrl (UriInfo uriInfo)
static UriBuilder	adminBaseUrl (UriBuilder base)
static UriBuilder	adminConsoleUrl (UriInfo uriInfo)
static UriBuilder	adminConsoleUrl (UriBuilder base)
static UriBuilder	realmsUrl (UriInfo uriInfo)
static UriBuilder	realmsUrl (UriBuilder base)
static Theme	getTheme (KeycloakSession session, RealmModel realm) throws IOException
static Properties	getMessages (KeycloakSession session, RealmModel realm, String lang)
static Properties	getMessages (KeycloakSession session, RealmModel realm, String lang, String... bundles)

限定公開メンバ関数
RealmModel	locateRealm (String name, RealmManager realmManager)
AdminAuth	authenticateRealmAdminRequest (HttpHeaders headers)

限定公開変数類
ClientConnection	clientConnection
HttpRequest	request
HttpResponse	response
AppAuthManager	authManager
TokenManager	tokenManager
KeycloakSession	session

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

静的非公開メンバ関数
static Properties	getMessages (KeycloakSession session, RealmModel realm, String lang, String bundle)

詳解

Root resource for admin console and admin REST API

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

AdminRoot()

org.keycloak.services.resources.admin.AdminRoot.AdminRoot ( )

inline

                       {
        this.tokenManager = new TokenManager();
        this.authManager = new AppAuthManager();
    }

関数詳解

adminBaseUrl() [1/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.adminBaseUrl ( UriInfo  uriInfo )

inlinestatic

                                                           {
        return adminBaseUrl(uriInfo.getBaseUriBuilder());
    }

adminBaseUrl() [2/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.adminBaseUrl ( UriBuilder  base )

inlinestatic

                                                           {
        return base.path(AdminRoot.class);
    }

adminConsoleUrl() [1/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.adminConsoleUrl ( UriInfo  uriInfo )

inlinestatic

                                                              {
        return adminConsoleUrl(uriInfo.getBaseUriBuilder());
    }

adminConsoleUrl() [2/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.adminConsoleUrl ( UriBuilder  base )

inlinestatic

                                                              {
        return adminBaseUrl(base).path(AdminRoot.class, "getAdminConsole");
    }

authenticateRealmAdminRequest()

AdminAuth org.keycloak.services.resources.admin.AdminRoot.authenticateRealmAdminRequest ( HttpHeaders  headers )

inlineprotected

                                                                           {
        String tokenString = authManager.extractAuthorizationHeaderToken(headers);
        if (tokenString == null) throw new UnauthorizedException("Bearer");
        AccessToken token;
        try {
            JWSInput input = new JWSInput(tokenString);
            token = input.readJsonContent(AccessToken.class);
        } catch (JWSInputException e) {
            throw new UnauthorizedException("Bearer token format error");
        }
        String realmName = token.getIssuer().substring(token.getIssuer().lastIndexOf('/') + 1);
        RealmManager realmManager = new RealmManager(session);
        RealmModel realm = realmManager.getRealmByName(realmName);
        if (realm == null) {
            throw new UnauthorizedException("Unknown realm in token");
        }
        session.getContext().setRealm(realm);
        AuthenticationManager.AuthResult authResult = authManager.authenticateBearerToken(session, realm, session.getContext().getUri(), clientConnection, headers);
        if (authResult == null) {
            logger.debug("Token not valid");
            throw new UnauthorizedException("Bearer");
        }

        ClientModel client = realm.getClientByClientId(token.getIssuedFor());
        if (client == null) {
            throw new NotFoundException("Could not find client for authorization");

        }

        return new AdminAuth(realm, authResult.getToken(), authResult.getUser(), client);
    }

getAdminConsole()

AdminConsole org.keycloak.services.resources.admin.AdminRoot.getAdminConsole ( final @PathParam("realm") String  name )

inline

path to realm admin console ui

引数

name	Realm name (not id!)

戻り値

                                                                               {
        RealmManager realmManager = new RealmManager(session);
        RealmModel realm = locateRealm(name, realmManager);
        AdminConsole service = new AdminConsole(realm);
        ResteasyProviderFactory.getInstance().injectProperties(service);
        return service;
    }

getMessages() [1/3]

static Properties org.keycloak.services.resources.admin.AdminRoot.getMessages ( KeycloakSession  session, RealmModel  realm, String  lang  )

inlinestatic

                                                                                                 {
        try {
            Theme theme = getTheme(session, realm);
            Locale locale = lang != null ? Locale.forLanguageTag(lang) : Locale.ENGLISH;
            return theme.getMessages(locale);
        } catch (IOException e) {
            logger.error("Failed to load messages from theme", e);
            return new Properties();
        }
    }

getMessages() [2/3]

static Properties org.keycloak.services.resources.admin.AdminRoot.getMessages ( KeycloakSession  session, RealmModel  realm, String  lang, String...  bundles  )

inlinestatic

                                                                                                                    {
        Properties compound = new Properties();
        for (String bundle : bundles) {
            Properties current = getMessages(session, realm, lang, bundle);
            compound.putAll(current);
        }
        return compound;
    }

getMessages() [3/3]

static Properties org.keycloak.services.resources.admin.AdminRoot.getMessages ( KeycloakSession  session, RealmModel  realm, String  lang, String  bundle  )

inlinestaticprivate

                                                                                                                 {
        try {
            Theme theme = getTheme(session, realm);
            Locale locale = lang != null ? Locale.forLanguageTag(lang) : Locale.ENGLISH;
            return theme.getMessages(bundle, locale);
        } catch (IOException e) {
            logger.error("Failed to load messages from theme", e);
            return new Properties();
        }
    }

getRealmsAdmin()

Object org.keycloak.services.resources.admin.AdminRoot.getRealmsAdmin ( @Context final HttpHeaders  headers )

inline

Base Path to realm admin REST interface

引数

headers

戻り値

                                                                     {
        if (request.getHttpMethod().equals(HttpMethod.OPTIONS)) {
            return new AdminCorsPreflightService(request);
        }

        AdminAuth auth = authenticateRealmAdminRequest(headers);
        if (auth != null) {
            logger.debug("authenticated admin access for: " + auth.getUser().getUsername());
        }

        Cors.add(request).allowedOrigins(auth.getToken()).allowedMethods("GET", "PUT", "POST", "DELETE").exposedHeaders("Location").auth().build(response);

        RealmsAdminResource adminResource = new RealmsAdminResource(auth, tokenManager);
        ResteasyProviderFactory.getInstance().injectProperties(adminResource);
        return adminResource;
    }

getServerInfo()

Object org.keycloak.services.resources.admin.AdminRoot.getServerInfo ( @Context final HttpHeaders  headers )

inline

General information about the server

引数

headers

戻り値

                                                                    {
        if (request.getHttpMethod().equals(HttpMethod.OPTIONS)) {
            return new AdminCorsPreflightService(request);
        }

        AdminAuth auth = authenticateRealmAdminRequest(headers);
        if (!AdminPermissions.realms(session, auth).isAdmin()) {
            throw new ForbiddenException();
        }

        if (auth != null) {
            logger.debug("authenticated admin access for: " + auth.getUser().getUsername());
        }

        Cors.add(request).allowedOrigins(auth.getToken()).allowedMethods("GET", "PUT", "POST", "DELETE").auth().build(response);

        ServerInfoAdminResource adminResource = new ServerInfoAdminResource();
        ResteasyProviderFactory.getInstance().injectProperties(adminResource);
        return adminResource;
    }

getTheme()

static Theme org.keycloak.services.resources.admin.AdminRoot.getTheme ( KeycloakSession  session, RealmModel  realm  ) throws IOException

inlinestatic

                                                                                               {
        return session.theme().getTheme(Theme.Type.ADMIN);
    }

locateRealm()

RealmModel org.keycloak.services.resources.admin.AdminRoot.locateRealm ( String  name, RealmManager  realmManager  )

inlineprotected

                                                                             {
        RealmModel realm = realmManager.getRealmByName(name);
        if (realm == null) {
            throw new NotFoundException("Realm not found.  Did you type in a bad URL?");
        }
        session.getContext().setRealm(realm);
        return realm;
    }

masterRealmAdminConsoleRedirect()

Response org.keycloak.services.resources.admin.AdminRoot.masterRealmAdminConsoleRedirect ( )

inline

Convenience path to master realm admin console

戻り値

                                                      {
        RealmModel master = new RealmManager(session).getKeycloakAdminstrationRealm();
        return Response.status(302).location(
                session.getContext().getUri().getBaseUriBuilder().path(AdminRoot.class).path(AdminRoot.class, "getAdminConsole").path("/").build(master.getName())
        ).build();
    }

masterRealmAdminConsoleRedirectHtml()

Response org.keycloak.services.resources.admin.AdminRoot.masterRealmAdminConsoleRedirectHtml ( )

inline

Convenience path to master realm admin console

戻り値

                                                          {
        return masterRealmAdminConsoleRedirect();
    }

realmsUrl() [1/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.realmsUrl ( UriInfo  uriInfo )

inlinestatic

                                                        {
        return realmsUrl(uriInfo.getBaseUriBuilder());
    }

realmsUrl() [2/2]

static UriBuilder org.keycloak.services.resources.admin.AdminRoot.realmsUrl ( UriBuilder  base )

inlinestatic

                                                        {
        return adminBaseUrl(base).path(AdminRoot.class, "getRealmsAdmin");
    }

メンバ詳解

authManager

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

protected

clientConnection

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

protected

logger

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

staticprotected

request

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

protected

response

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

protected

session

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

protected

tokenManager

TokenManager org.keycloak.services.resources.admin.AdminRoot.tokenManager

protected

---

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

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