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

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

公開メンバ関数
	GroupsResource (RealmModel realm, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
List< GroupRepresentation >	getGroups (@QueryParam("search") String search, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)
GroupResource	getGroupById (@PathParam("id") String id)
Map< String, Long >	getGroupCount (@QueryParam("search") String search, @QueryParam("top") @DefaultValue("false") boolean onlyTopGroups)
Response	addTopLevelGroup (GroupRepresentation rep)

非公開変数類
final RealmModel	realm
final KeycloakSession	session
final AdminPermissionEvaluator	auth
final AdminEventBuilder	adminEvent

詳解

Groups

著者

Bill Burke

構築子と解体子

GroupsResource()

org.keycloak.services.resources.admin.GroupsResource.GroupsResource ( RealmModel  realm, KeycloakSession  session, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                                  {
        this.realm = realm;
        this.session = session;
        this.auth = auth;
        this.adminEvent = adminEvent.resource(ResourceType.GROUP);

    }

関数詳解

addTopLevelGroup()

Response org.keycloak.services.resources.admin.GroupsResource.addTopLevelGroup ( GroupRepresentation  rep )

inline

create or add a top level realm groupSet or create child. This will update the group and set the parent if it exists. Create it and set the parent if the group doesn't exist.

引数

rep

                                                              {
        auth.groups().requireManage();

        List<GroupRepresentation> search = ModelToRepresentation.searchForGroupByName(realm, rep.getName(), 0, 1);
        if (search != null && !search.isEmpty() && Objects.equals(search.get(0).getName(), rep.getName())) {
            return ErrorResponse.exists("Top level group named '" + rep.getName() + "' already exists.");
        }

        GroupModel child;
        Response.ResponseBuilder builder = Response.status(204);
        if (rep.getId() != null) {
            child = realm.getGroupById(rep.getId());
            if (child == null) {
                throw new NotFoundException("Could not find child by id");
            }
            adminEvent.operation(OperationType.UPDATE).resourcePath(session.getContext().getUri());
        } else {
            child = realm.createGroup(rep.getName());
            GroupResource.updateGroup(rep, child);
            URI uri = session.getContext().getUri().getAbsolutePathBuilder()
                    .path(child.getId()).build();
            builder.status(201).location(uri);

            rep.setId(child.getId());
            adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri(), child.getId());
        }
        realm.moveGroup(child, null);

        adminEvent.representation(rep).success();
        return builder.build();
    }

getGroupById()

GroupResource org.keycloak.services.resources.admin.GroupsResource.getGroupById ( @PathParam("id") String  id )

inline

Does not expand hierarchy. Subgroups will not be set.

引数

id

戻り値

                                                                  {
        GroupModel group = realm.getGroupById(id);
        if (group == null) {
            throw new NotFoundException("Could not find group by id");
        }
        GroupResource resource =  new GroupResource(realm, group, session, this.auth, adminEvent);
        ResteasyProviderFactory.getInstance().injectProperties(resource);
        return resource;
    }

getGroupCount()

Map<String, Long> org.keycloak.services.resources.admin.GroupsResource.getGroupCount ( @QueryParam("search") String  search, @QueryParam("top") @DefaultValue("false") boolean  onlyTopGroups  )

inline

Returns the groups counts.

戻り値

                                                                                                            {
        Long results;
        Map<String, Long> map = new HashMap<>();
        if (Objects.nonNull(search)) {
            results = realm.getGroupsCountByNameContaining(search);
        } else {
            results = realm.getGroupsCount(onlyTopGroups);
        }
        map.put("count", results);
        return map;
    }

getGroups()

List<GroupRepresentation> org.keycloak.services.resources.admin.GroupsResource.getGroups ( @QueryParam("search") String  search, @QueryParam("first") Integer  firstResult, @QueryParam("max") Integer  maxResults  )

inline

Get group hierarchy. Only name and ids are returned.

戻り値

                                                                                      {
        auth.groups().requireList();

        List<GroupRepresentation> results;

        if (Objects.nonNull(search)) {
            results = ModelToRepresentation.searchForGroupByName(realm, search.trim(), firstResult, maxResults);
        } else if(Objects.nonNull(firstResult) && Objects.nonNull(maxResults)) {
            results = ModelToRepresentation.toGroupHierarchy(realm, false, firstResult, maxResults);
        } else {
            results = ModelToRepresentation.toGroupHierarchy(realm, false);
        }

        return results;
    }

メンバ詳解

adminEvent

final AdminEventBuilder org.keycloak.services.resources.admin.GroupsResource.adminEvent

private

auth

final AdminPermissionEvaluator org.keycloak.services.resources.admin.GroupsResource.auth

private

realm

final RealmModel org.keycloak.services.resources.admin.GroupsResource.realm

private

session

final KeycloakSession org.keycloak.services.resources.admin.GroupsResource.session

private

---

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

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