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

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

公開メンバ関数
	RealmsAdminResource (AdminAuth auth, TokenManager tokenManager)
List< RealmRepresentation >	getRealms ()
Response	importRealm (final RealmRepresentation rep)
RealmAdminResource	getRealmAdmin (@Context final HttpHeaders headers, @PathParam("realm") final String name)

静的公開変数類
static final CacheControl	noCache = new CacheControl()

限定公開メンバ関数
void	addRealmRep (List< RealmRepresentation > reps, RealmModel realm)

限定公開変数類
AdminAuth	auth
TokenManager	tokenManager
KeycloakSession	session
KeycloakApplication	keycloak
ClientConnection	clientConnection

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

静的関数
	[static initializer]

非公開メンバ関数
void	grantPermissionsToRealmCreator (RealmModel realm)

詳解

Top level resource for Admin REST API

Realms Admin

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

RealmsAdminResource()

org.keycloak.services.resources.admin.RealmsAdminResource.RealmsAdminResource ( AdminAuth  auth, TokenManager  tokenManager  )

inline

                                                                          {
        this.auth = auth;
        this.tokenManager = tokenManager;
    }

関数詳解

[static initializer]()

org.keycloak.services.resources.admin.RealmsAdminResource.[static initializer] ( )

inlinestaticpackage

addRealmRep()

void org.keycloak.services.resources.admin.RealmsAdminResource.addRealmRep ( List< RealmRepresentation >  reps, RealmModel  realm  )

inlineprotected

                                                                                 {
        if (AdminPermissions.realms(session, auth).canView(realm)) {
            reps.add(ModelToRepresentation.toRepresentation(realm, false));
        } else if (AdminPermissions.realms(session, auth).isAdmin(realm)) {
            RealmRepresentation rep = new RealmRepresentation();
            rep.setRealm(realm.getName());
            reps.add(rep);
        }
    }

getRealmAdmin()

RealmAdminResource org.keycloak.services.resources.admin.RealmsAdminResource.getRealmAdmin ( @Context final HttpHeaders  headers, @PathParam("realm") final String  name  )

inline

Base path for the admin REST API for one particular realm.

引数

headers
name	realm name (not id!)

戻り値

                                                                                   {
        RealmManager realmManager = new RealmManager(session);
        RealmModel realm = realmManager.getRealmByName(name);
        if (realm == null) throw new NotFoundException("Realm not found.");

        if (!auth.getRealm().equals(realmManager.getKeycloakAdminstrationRealm())
                && !auth.getRealm().equals(realm)) {
            throw new ForbiddenException();
        }
        AdminPermissionEvaluator realmAuth = AdminPermissions.evaluator(session, realm, auth);

        AdminEventBuilder adminEvent = new AdminEventBuilder(realm, auth, session, clientConnection);
        session.getContext().setRealm(realm);

        RealmAdminResource adminResource = new RealmAdminResource(realmAuth, realm, tokenManager, adminEvent);
        ResteasyProviderFactory.getInstance().injectProperties(adminResource);
        //resourceContext.initResource(adminResource);
        return adminResource;
    }

getRealms()

List<RealmRepresentation> org.keycloak.services.resources.admin.RealmsAdminResource.getRealms ( )

inline

Get accessible realms

Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

戻り値

                                                 {
        List<RealmRepresentation> reps = new ArrayList<RealmRepresentation>();
        List<RealmModel> realms = session.realms().getRealms();
        for (RealmModel realm : realms) {
            addRealmRep(reps, realm);
        }
        if (reps.isEmpty()) {
            throw new ForbiddenException();
        }

        logger.debug(("getRealms()"));
        return reps;
    }

grantPermissionsToRealmCreator()

void org.keycloak.services.resources.admin.RealmsAdminResource.grantPermissionsToRealmCreator ( RealmModel  realm )

inlineprivate

                                                                  {
        if (auth.hasRealmRole(AdminRoles.ADMIN)) {
            return;
        }

        RealmModel adminRealm = new RealmManager(session).getKeycloakAdminstrationRealm();
        ClientModel realmAdminApp = realm.getMasterAdminClient();
        for (String r : AdminRoles.ALL_REALM_ROLES) {
            RoleModel role = realmAdminApp.getRole(r);
            auth.getUser().grantRole(role);
        }
    }

importRealm()

Response org.keycloak.services.resources.admin.RealmsAdminResource.importRealm ( final RealmRepresentation  rep )

inline

Import a realm

Imports a realm from a full representation of that realm. Realm name must be unique.

引数

rep	JSON representation of the realm

戻り値

                                                               {
        RealmManager realmManager = new RealmManager(session);
        realmManager.setContextPath(keycloak.getContextPath());
        AdminPermissions.realms(session, auth).requireCreateRealm();

        logger.debugv("importRealm: {0}", rep.getRealm());

        try {
            RealmModel realm = realmManager.importRealm(rep);
            grantPermissionsToRealmCreator(realm);

            URI location = AdminRoot.realmsUrl(session.getContext().getUri()).path(realm.getName()).build();
            logger.debugv("imported realm success, sending back: {0}", location.toString());

            return Response.created(location).build();
        } catch (ModelDuplicateException e) {
            logger.error("Conflict detected", e);
            return ErrorResponse.exists("Conflict detected. See logs for details");
        } catch (PasswordPolicyNotMetException e) {
            logger.error("Password policy not met for user " + e.getUsername(), e);
            if (session.getTransactionManager().isActive()) session.getTransactionManager().setRollbackOnly();
            return ErrorResponse.error("Password policy not met. See logs for details", Response.Status.BAD_REQUEST);
        }
    }

メンバ詳解

auth

AdminAuth org.keycloak.services.resources.admin.RealmsAdminResource.auth

protected

clientConnection

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

protected

keycloak

KeycloakApplication org.keycloak.services.resources.admin.RealmsAdminResource.keycloak

protected

logger

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

staticprotected

noCache

final CacheControl org.keycloak.services.resources.admin.RealmsAdminResource.noCache = new CacheControl()

static

session

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

protected

tokenManager

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

protected

---

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

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