org.keycloak.authorization.admin.ResourceSetService クラス

org.keycloak.authorization.admin.ResourceSetService 連携図

公開メンバ関数
	ResourceSetService (KeycloakSession session, ResourceServer resourceServer, AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
Response	createPost (ResourceRepresentation resource)
ResourceRepresentation	create (ResourceRepresentation resource)
Response	update (@PathParam("id") String id, ResourceRepresentation resource)
Response	delete (@PathParam("id") String id)
Response	findById (@PathParam("id") String id)
Response	findById (String id, Function< Resource, ? extends ResourceRepresentation > toRepresentation)
Response	getScopes (@PathParam("id") String id)
Response	getPermissions (@PathParam("id") String id)
Response	getAttributes (@PathParam("id") String id)
Response	find (@QueryParam("name") String name)
Response	find (@QueryParam("_id") String id, @QueryParam("name") String name, @QueryParam("uri") String uri, @QueryParam("owner") String owner, @QueryParam("type") String type, @QueryParam("scope") String scope, @QueryParam("matchingUri") Boolean matchingUri, @QueryParam("deep") Boolean deep, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResult)
Response	find (@QueryParam("_id") String id, @QueryParam("name") String name, @QueryParam("uri") String uri, @QueryParam("owner") String owner, @QueryParam("type") String type, @QueryParam("scope") String scope, @QueryParam("matchingUri") Boolean matchingUri, @QueryParam("deep") Boolean deep, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResult, BiFunction< Resource, Boolean, ?> toRepresentation)
void	audit (ResourceRepresentation resource, String id, OperationType operation)

非公開メンバ関数
void	requireView ()
void	requireManage ()
void	audit (ResourceRepresentation resource, OperationType operation)

非公開変数類
final AuthorizationProvider	authorization
final AdminPermissionEvaluator	auth
final AdminEventBuilder	adminEvent
KeycloakSession	session
ResourceServer	resourceServer

詳解

著者

Pedro Igor

構築子と解体子

ResourceSetService()

org.keycloak.authorization.admin.ResourceSetService.ResourceSetService ( KeycloakSession  session, ResourceServer  resourceServer, AuthorizationProvider  authorization, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                                                                                        {
        this.session = session;
        this.resourceServer = resourceServer;
        this.authorization = authorization;
        this.auth = auth;
        this.adminEvent = adminEvent.resource(ResourceType.AUTHORIZATION_RESOURCE);
    }

関数詳解

audit() [1/2]

void org.keycloak.authorization.admin.ResourceSetService.audit ( ResourceRepresentation  resource, OperationType  operation  )

inlineprivate

                                                                                 {
        audit(resource, null, operation);
    }

audit() [2/2]

void org.keycloak.authorization.admin.ResourceSetService.audit ( ResourceRepresentation  resource, String  id, OperationType  operation  )

inline

                                                                                           {
        if (authorization.getRealm().isAdminEventsEnabled()) {
            if (id != null) {
                adminEvent.operation(operation).resourcePath(session.getContext().getUri(), id).representation(resource).success();
            } else {
                adminEvent.operation(operation).resourcePath(session.getContext().getUri()).representation(resource).success();
            }
        }
    }

create()

ResourceRepresentation org.keycloak.authorization.admin.ResourceSetService.create ( ResourceRepresentation  resource )

inline

                                                                          {
        requireManage();
        StoreFactory storeFactory = this.authorization.getStoreFactory();
        ResourceOwnerRepresentation owner = resource.getOwner();

        if (owner == null) {
            owner = new ResourceOwnerRepresentation();
            owner.setId(resourceServer.getId());
            resource.setOwner(owner);
        }

        String ownerId = owner.getId();

        if (ownerId == null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "You must specify the resource owner.", Status.BAD_REQUEST);
        }

        Resource existingResource = storeFactory.getResourceStore().findByName(resource.getName(), ownerId, this.resourceServer.getId());

        if (existingResource != null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "Resource with name [" + resource.getName() + "] already exists.", Status.CONFLICT);
        }

        return toRepresentation(toModel(resource, this.resourceServer, authorization), resourceServer, authorization);
    }

createPost()

Response org.keycloak.authorization.admin.ResourceSetService.createPost ( ResourceRepresentation  resource )

inline

                                                                {
        if (resource == null) {
            return Response.status(Status.BAD_REQUEST).build();
        }

        ResourceRepresentation newResource = create(resource);

        audit(resource, resource.getId(), OperationType.CREATE);

        return Response.status(Status.CREATED).entity(newResource).build();
    }

delete()

Response org.keycloak.authorization.admin.ResourceSetService.delete ( @PathParam("id") String  id )

inline

                                                       {
        requireManage();
        StoreFactory storeFactory = authorization.getStoreFactory();
        Resource resource = storeFactory.getResourceStore().findById(id, resourceServer.getId());

        if (resource == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        storeFactory.getResourceStore().delete(id);

        if (authorization.getRealm().isAdminEventsEnabled()) {
            audit(toRepresentation(resource, resourceServer, authorization), OperationType.DELETE);
        }

        return Response.noContent().build();
    }

find() [1/3]

Response org.keycloak.authorization.admin.ResourceSetService.find ( @QueryParam("name") String  name )

inline

                                                          {
        this.auth.realm().requireViewAuthorization();
        StoreFactory storeFactory = authorization.getStoreFactory();

        if (name == null) {
            return Response.status(Status.BAD_REQUEST).build();
        }

        Resource model = storeFactory.getResourceStore().findByName(name, this.resourceServer.getId());

        if (model == null) {
            return Response.status(Status.OK).build();
        }

        return Response.ok(toRepresentation(model, this.resourceServer, authorization)).build();
    }

find() [2/3]

Response org.keycloak.authorization.admin.ResourceSetService.find ( @QueryParam("_id") String  id, @QueryParam("name") String  name, @QueryParam("uri") String  uri, @QueryParam("owner") String  owner, @QueryParam("type") String  type, @QueryParam("scope") String  scope, @QueryParam("matchingUri") Boolean  matchingUri, @QueryParam("deep") Boolean  deep, @QueryParam("first") Integer  firstResult, @QueryParam("max") Integer  maxResult  )

inline

                                                               {
        return find(id, name, uri, owner, type, scope, matchingUri, deep, firstResult, maxResult, (BiFunction<Resource, Boolean, ResourceRepresentation>) (resource, deep1) -> toRepresentation(resource, resourceServer, authorization, deep1));
    }

find() [3/3]

Response org.keycloak.authorization.admin.ResourceSetService.find ( @QueryParam("_id") String  id, @QueryParam("name") String  name, @QueryParam("uri") String  uri, @QueryParam("owner") String  owner, @QueryParam("type") String  type, @QueryParam("scope") String  scope, @QueryParam("matchingUri") Boolean  matchingUri, @QueryParam("deep") Boolean  deep, @QueryParam("first") Integer  firstResult, @QueryParam("max") Integer  maxResult, BiFunction< Resource, Boolean, ?>  toRepresentation  )

inline

                                                                            {
        requireView();

        StoreFactory storeFactory = authorization.getStoreFactory();

        if (deep == null) {
            deep = true;
        }

        Map<String, String[]> search = new HashMap<>();

        if (id != null && !"".equals(id.trim())) {
            search.put("id", new String[] {id});
        }

        if (name != null && !"".equals(name.trim())) {
            search.put("name", new String[] {name});
        }

        if (uri != null && !"".equals(uri.trim())) {
            search.put("uri", new String[] {uri});
        }

        if (owner != null && !"".equals(owner.trim())) {
            RealmModel realm = authorization.getKeycloakSession().getContext().getRealm();
            ClientModel clientModel = realm.getClientByClientId(owner);

            if (clientModel != null) {
                owner = clientModel.getId();
            } else {
                UserModel user = authorization.getKeycloakSession().users().getUserByUsername(owner, realm);

                if (user != null) {
                    owner = user.getId();
                }
            }

            search.put("owner", new String[] {owner});
        }

        if (type != null && !"".equals(type.trim())) {
            search.put("type", new String[] {type});
        }

        if (scope != null && !"".equals(scope.trim())) {
            HashMap<String, String[]> scopeFilter = new HashMap<>();

            scopeFilter.put("name", new String[] {scope});

            List<Scope> scopes = authorization.getStoreFactory().getScopeStore().findByResourceServer(scopeFilter, resourceServer.getId(), -1, -1);

            if (scopes.isEmpty()) {
                return Response.ok(Collections.emptyList()).build();
            }

            search.put("scope", scopes.stream().map(Scope::getId).toArray(String[]::new));
        }

        List<Resource> resources = storeFactory.getResourceStore().findByResourceServer(search, this.resourceServer.getId(), firstResult != null ? firstResult : -1, maxResult != null ? maxResult : Constants.DEFAULT_MAX_RESULTS);

        if (matchingUri != null && matchingUri && resources.isEmpty()) {
            HashMap<String, String[]> attributes = new HashMap<>();

            attributes.put("uri_not_null", new String[] {"true"});
            attributes.put("owner", new String[] {resourceServer.getId()});

            List<Resource> serverResources = storeFactory.getResourceStore().findByResourceServer(attributes, this.resourceServer.getId(), firstResult != null ? firstResult : -1, maxResult != null ? maxResult : Constants.DEFAULT_MAX_RESULTS);

            PathMatcher<Map.Entry<String, Resource>> pathMatcher = new PathMatcher<Map.Entry<String, Resource>>() {
                @Override
                protected String getPath(Map.Entry<String, Resource> entry) {
                    return entry.getKey();
                }

                @Override
                protected Collection<Map.Entry<String, Resource>> getPaths() {
                    Map<String, Resource> result = new HashMap<>();
                    serverResources.forEach(resource -> resource.getUris().forEach(uri -> {
                        result.put(uri, resource);
                    }));

                    return result.entrySet();
                }
            };

            Map.Entry<String, Resource> matches = pathMatcher.matches(uri);

            if (matches != null) {
                resources = Collections.singletonList(matches.getValue());
            }
        }

        Boolean finalDeep = deep;

        return Response.ok(
                resources.stream()
                        .map(resource -> toRepresentation.apply(resource, finalDeep))
                        .collect(Collectors.toList()))
                .build();
    }

findById() [1/2]

Response org.keycloak.authorization.admin.ResourceSetService.findById ( @PathParam("id") String  id )

inline

                                                         {
        return findById(id, resource -> toRepresentation(resource, resourceServer, authorization, true));
    }

findById() [2/2]

Response org.keycloak.authorization.admin.ResourceSetService.findById ( String  id, Function< Resource, ? extends ResourceRepresentation >  toRepresentation  )

inline

                                                                                                               {
        requireView();
        StoreFactory storeFactory = authorization.getStoreFactory();
        Resource model = storeFactory.getResourceStore().findById(id, resourceServer.getId());

        if (model == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        return Response.ok(toRepresentation.apply(model)).build();
    }

getAttributes()

Response org.keycloak.authorization.admin.ResourceSetService.getAttributes ( @PathParam("id") String  id )

inline

                                                              {
        requireView();
        StoreFactory storeFactory = authorization.getStoreFactory();
        Resource model = storeFactory.getResourceStore().findById(id, resourceServer.getId());

        if (model == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        return Response.ok(model.getAttributes()).build();
    }

getPermissions()

Response org.keycloak.authorization.admin.ResourceSetService.getPermissions ( @PathParam("id") String  id )

inline

                                                               {
        requireView();
        StoreFactory storeFactory = authorization.getStoreFactory();
        ResourceStore resourceStore = storeFactory.getResourceStore();
        Resource model = resourceStore.findById(id, resourceServer.getId());

        if (model == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        PolicyStore policyStore = authorization.getStoreFactory().getPolicyStore();
        Set<Policy> policies = new HashSet<>();

        policies.addAll(policyStore.findByResource(model.getId(), resourceServer.getId()));

        if (model.getType() != null) {
            policies.addAll(policyStore.findByResourceType(model.getType(), resourceServer.getId()));

            HashMap<String, String[]> resourceFilter = new HashMap<>();

            resourceFilter.put("owner", new String[]{resourceServer.getId()});
            resourceFilter.put("type", new String[]{model.getType()});

            for (Resource resourceType : resourceStore.findByResourceServer(resourceFilter, resourceServer.getId(), -1, -1)) {
                policies.addAll(policyStore.findByResource(resourceType.getId(), resourceServer.getId()));
            }
        }

        policies.addAll(policyStore.findByScopeIds(model.getScopes().stream().map(scope -> scope.getId()).collect(Collectors.toList()), id, resourceServer.getId()));
        policies.addAll(policyStore.findByScopeIds(model.getScopes().stream().map(scope -> scope.getId()).collect(Collectors.toList()), null, resourceServer.getId()));

        List<PolicyRepresentation> representation = new ArrayList<>();

        for (Policy policyModel : policies) {
            if (!"uma".equalsIgnoreCase(policyModel.getType())) {
                PolicyRepresentation policy = new PolicyRepresentation();

                policy.setId(policyModel.getId());
                policy.setName(policyModel.getName());
                policy.setType(policyModel.getType());

                if (!representation.contains(policy)) {
                    representation.add(policy);
                }
            }
        }

        return Response.ok(representation).build();
    }

getScopes()

Response org.keycloak.authorization.admin.ResourceSetService.getScopes ( @PathParam("id") String  id )

inline

                                                          {
        requireView();
        StoreFactory storeFactory = authorization.getStoreFactory();
        Resource model = storeFactory.getResourceStore().findById(id, resourceServer.getId());

        if (model == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        List<ScopeRepresentation> scopes = model.getScopes().stream().map(scope -> {
            ScopeRepresentation representation = new ScopeRepresentation();

            representation.setId(scope.getId());
            representation.setName(scope.getName());

            return representation;
        }).collect(Collectors.toList());

        if (model.getType() != null && !model.getOwner().equals(resourceServer.getId())) {
            ResourceStore resourceStore = authorization.getStoreFactory().getResourceStore();
            for (Resource typed : resourceStore.findByType(model.getType(), resourceServer.getId())) {
                if (typed.getOwner().equals(resourceServer.getId()) && !typed.getId().equals(model.getId())) {
                    scopes.addAll(typed.getScopes().stream().map(model1 -> {
                        ScopeRepresentation scope = new ScopeRepresentation();
                        scope.setId(model1.getId());
                        scope.setName(model1.getName());
                        String iconUri = model1.getIconUri();
                        if (iconUri != null) {
                            scope.setIconUri(iconUri);
                        }
                        return scope;
                    }).filter(scopeRepresentation -> !scopes.contains(scopeRepresentation)).collect(Collectors.toList()));
                }
            }
        }

        return Response.ok(scopes).build();
    }

requireManage()

void org.keycloak.authorization.admin.ResourceSetService.requireManage ( )

inlineprivate

                                 {
        if (this.auth != null) {
            this.auth.realm().requireManageAuthorization();
        }
    }

requireView()

void org.keycloak.authorization.admin.ResourceSetService.requireView ( )

inlineprivate

                               {
        if (this.auth != null) {
            this.auth.realm().requireViewAuthorization();
        }
    }

update()

Response org.keycloak.authorization.admin.ResourceSetService.update ( @PathParam("id") String  id, ResourceRepresentation  resource  )

inline

                                                                                        {
        requireManage();
        resource.setId(id);
        StoreFactory storeFactory = this.authorization.getStoreFactory();
        ResourceStore resourceStore = storeFactory.getResourceStore();
        Resource model = resourceStore.findById(resource.getId(), resourceServer.getId());

        if (model == null) {
            return Response.status(Status.NOT_FOUND).build();
        }

        toModel(resource, resourceServer, authorization);

        audit(resource, OperationType.UPDATE);

        return Response.noContent().build();
    }

メンバ詳解

adminEvent

final AdminEventBuilder org.keycloak.authorization.admin.ResourceSetService.adminEvent

private

auth

final AdminPermissionEvaluator org.keycloak.authorization.admin.ResourceSetService.auth

private

authorization

final AuthorizationProvider org.keycloak.authorization.admin.ResourceSetService.authorization

private

resourceServer

ResourceServer org.keycloak.authorization.admin.ResourceSetService.resourceServer

private

session

KeycloakSession org.keycloak.authorization.admin.ResourceSetService.session

private

---

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

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