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

org.keycloak.authorization.admin.PolicyResourceService の継承関係図

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

公開メンバ関数
	PolicyResourceService (Policy policy, ResourceServer resourceServer, AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
Response	update (String payload)
Response	delete ()
Response	findById ()
Response	getDependentPolicies ()
Response	getScopes ()
Response	getResources ()
Response	getAssociatedPolicies ()

限定公開メンバ関数
AbstractPolicyRepresentation	toRepresentation (Policy policy, AuthorizationProvider authorization)
AbstractPolicyRepresentation	doCreateRepresentation (String payload)
Policy	getPolicy ()

限定公開変数類
final ResourceServer	resourceServer
final AuthorizationProvider	authorization
final AdminPermissionEvaluator	auth

非公開メンバ関数
PolicyProviderFactory	getProviderFactory (String policyType)
void	audit (AbstractPolicyRepresentation policy, OperationType operation)

非公開変数類
KeycloakSession	session
final Policy	policy
final AdminEventBuilder	adminEvent

詳解

著者

Pedro Igor

構築子と解体子

PolicyResourceService()

org.keycloak.authorization.admin.PolicyResourceService.PolicyResourceService ( Policy  policy, ResourceServer  resourceServer, AuthorizationProvider  authorization, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                                                                                 {
        this.policy = policy;
        this.resourceServer = resourceServer;
        this.authorization = authorization;
        this.auth = auth;
        this.adminEvent = adminEvent.resource(ResourceType.AUTHORIZATION_POLICY);
    }

関数詳解

audit()

void org.keycloak.authorization.admin.PolicyResourceService.audit ( AbstractPolicyRepresentation  policy, OperationType  operation  )

inlineprivate

                                                                                     {
        if (authorization.getRealm().isAdminEventsEnabled()) {
            adminEvent.operation(operation).resourcePath(session.getContext().getUri()).representation(policy).success();
        }
    }

delete()

Response org.keycloak.authorization.admin.PolicyResourceService.delete ( )

inline

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

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

        StoreFactory storeFactory = authorization.getStoreFactory();
        PolicyStore policyStore = storeFactory.getPolicyStore();
        PolicyProviderFactory resource = getProviderFactory(policy.getType());

        resource.onRemove(policy, authorization);

        policyStore.delete(policy.getId());

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

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

doCreateRepresentation()

AbstractPolicyRepresentation org.keycloak.authorization.admin.PolicyResourceService.doCreateRepresentation ( String  payload )

inlineprotected

                                                                                  {
        PolicyRepresentation representation;

        try {
            representation = JsonSerialization.readValue(payload, PolicyRepresentation.class);
        } catch (IOException cause) {
            throw new RuntimeException("Failed to deserialize representation", cause);
        }

        return representation;
    }

findById()

Response org.keycloak.authorization.admin.PolicyResourceService.findById ( )

inline

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

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

        return Response.ok(toRepresentation(policy, authorization)).build();
    }

getAssociatedPolicies()

Response org.keycloak.authorization.admin.PolicyResourceService.getAssociatedPolicies ( )

inline

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

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

        return Response.ok(policy.getAssociatedPolicies().stream().map(policy -> {
            PolicyRepresentation representation1 = new PolicyRepresentation();

            representation1.setId(policy.getId());
            representation1.setName(policy.getName());
            representation1.setType(policy.getType());
            representation1.setDescription(policy.getDescription());

            return representation1;
        }).collect(Collectors.toList())).build();
    }

getDependentPolicies()

Response org.keycloak.authorization.admin.PolicyResourceService.getDependentPolicies ( )

inline

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

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

        List<Policy> policies = authorization.getStoreFactory().getPolicyStore().findDependentPolicies(policy.getId(), resourceServer.getId());

        return Response.ok(policies.stream().map(policy -> {
            PolicyRepresentation representation1 = new PolicyRepresentation();

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

            return representation1;
        }).collect(Collectors.toList())).build();
    }

getPolicy()

Policy org.keycloak.authorization.admin.PolicyResourceService.getPolicy ( )

inlineprotected

                                 {
        return policy;
    }

getProviderFactory()

PolicyProviderFactory org.keycloak.authorization.admin.PolicyResourceService.getProviderFactory ( String  policyType )

inlineprivate

                                                                        {
        return authorization.getProviderFactory(policyType);
    }

getResources()

Response org.keycloak.authorization.admin.PolicyResourceService.getResources ( )

inline

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

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

        return Response.ok(policy.getResources().stream().map(resource -> {
            ResourceRepresentation representation = new ResourceRepresentation();

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

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

getScopes()

Response org.keycloak.authorization.admin.PolicyResourceService.getScopes ( )

inline

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

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

        return Response.ok(policy.getScopes().stream().map(scope -> {
            ScopeRepresentation representation = new ScopeRepresentation();

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

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

toRepresentation()

AbstractPolicyRepresentation org.keycloak.authorization.admin.PolicyResourceService.toRepresentation ( Policy  policy, AuthorizationProvider  authorization  )

inlineprotected

                                                                                                                {
        return ModelToRepresentation.toRepresentation(policy, authorization, true, false);
    }

update()

Response org.keycloak.authorization.admin.PolicyResourceService.update ( String  payload )

inline

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

        AbstractPolicyRepresentation representation = doCreateRepresentation(payload);

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

        representation.setId(policy.getId());

        RepresentationToModel.toModel(representation, authorization, policy);


        audit(representation, OperationType.UPDATE);

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

メンバ詳解

adminEvent

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

private

auth

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

protected

authorization

final AuthorizationProvider org.keycloak.authorization.admin.PolicyResourceService.authorization

protected

policy

final Policy org.keycloak.authorization.admin.PolicyResourceService.policy

private

resourceServer

final ResourceServer org.keycloak.authorization.admin.PolicyResourceService.resourceServer

protected

session

KeycloakSession org.keycloak.authorization.admin.PolicyResourceService.session

private

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authorization/admin/PolicyResourceService.java