org.keycloak.authorization.client.resource.PolicyResource クラス

org.keycloak.authorization.client.resource.PolicyResource 連携図

公開メンバ関数
	PolicyResource (String resourceId, Http http, ServerConfiguration serverConfiguration, TokenCallable pat)
UmaPermissionRepresentation	create (final UmaPermissionRepresentation permission)
void	update (final UmaPermissionRepresentation permission)
void	delete (final String id)
List< UmaPermissionRepresentation >	find (final String name, final String scope, final Integer firstResult, final Integer maxResult)
UmaPermissionRepresentation	findById (final String id)

非公開変数類
String	resourceId
final Http	http
final ServerConfiguration	serverConfiguration
final TokenCallable	pat

詳解

An entry point for managing user-managed permissions for a particular resource

著者

Pedro Igor

構築子と解体子

PolicyResource()

org.keycloak.authorization.client.resource.PolicyResource.PolicyResource ( String  resourceId, Http  http, ServerConfiguration  serverConfiguration, TokenCallable  pat  )

inline

                                                                                                                    {
        this.resourceId = resourceId;
        this.http = http;
        this.serverConfiguration = serverConfiguration;
        this.pat = pat;
    }

関数詳解

create()

UmaPermissionRepresentation org.keycloak.authorization.client.resource.PolicyResource.create ( final UmaPermissionRepresentation  permission )

inline

Creates a new user-managed permission as represented by the given

permission 

.

引数

permission

the permission to create

戻り値

if successful, the permission created

                                                                                            {
        if (permission == null) {
            throw new IllegalArgumentException("Permission must not be null");
        }

        Callable<UmaPermissionRepresentation> callable = new Callable<UmaPermissionRepresentation>() {
            @Override
            public UmaPermissionRepresentation call() throws Exception {
                return http.<UmaPermissionRepresentation>post(serverConfiguration.getPolicyEndpoint() + "/" + resourceId)
                        .authorizationBearer(pat.call())
                        .json(JsonSerialization.writeValueAsBytes(permission))
                        .response().json(UmaPermissionRepresentation.class).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Error creating policy for resource [" + resourceId + "]", cause);
        }
    }

delete()

void org.keycloak.authorization.client.resource.PolicyResource.delete ( final String  id )

inline

Deletes an existing user-managed permission

引数

id	the permission id

                                        {
        Callable<Void> callable = new Callable<Void>() {
            @Override
            public Void call() {
                http.<UmaPermissionRepresentation>delete(serverConfiguration.getPolicyEndpoint() + "/" + id)
                        .authorizationBearer(pat.call())
                        .response().execute();
                return null;
            }
        };
        try {
            callable.call();
        } catch (Exception cause) {
            Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Error updating policy for resource [" + resourceId + "]", cause);
        }
    }

find()

List<UmaPermissionRepresentation> org.keycloak.authorization.client.resource.PolicyResource.find ( final String  name, final String  scope, final Integer  firstResult, final Integer  maxResult  )

inline

Queries the server for permission matching the given parameters.

引数

id	the permission id
name	the name of the permission
scope	the scope associated with the permission
firstResult	the position of the first resource to retrieve
maxResult	the maximum number of resources to retrieve

戻り値

the permissions matching the given parameters

                                                                           {
        Callable<List<UmaPermissionRepresentation>> callable = new Callable<List<UmaPermissionRepresentation>>() {
            @Override
            public List<UmaPermissionRepresentation> call() {
                return http.<List<UmaPermissionRepresentation>>get(serverConfiguration.getPolicyEndpoint())
                        .authorizationBearer(pat.call())
                        .param("name", name)
                        .param("resource", resourceId)
                        .param("scope", scope)
                        .param("first", firstResult == null ? null : firstResult.toString())
                        .param("max", maxResult == null ? null : maxResult.toString())
                        .response().json(new TypeReference<List<UmaPermissionRepresentation>>(){}).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Error querying policies for resource [" + resourceId + "]", cause);
        }
    }

findById()

UmaPermissionRepresentation org.keycloak.authorization.client.resource.PolicyResource.findById ( final String  id )

inline

Queries the server for a permission with the given

id 

.

引数

id	the permission id

戻り値

the permission with the given id

                                                                 {
        if (id == null) {
            throw new IllegalArgumentException("Permission id must not be null");
        }

        Callable<UmaPermissionRepresentation> callable = new Callable<UmaPermissionRepresentation>() {
            @Override
            public UmaPermissionRepresentation call() {
                return http.<UmaPermissionRepresentation>get(serverConfiguration.getPolicyEndpoint() + "/" + id)
                        .authorizationBearer(pat.call())
                        .response().json(UmaPermissionRepresentation.class).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Error creating policy for resource [" + resourceId + "]", cause);
        }
    }

update()

void org.keycloak.authorization.client.resource.PolicyResource.update ( final UmaPermissionRepresentation  permission )

inline

Updates an existing user-managed permission

引数

permission

the permission to update

                                                                     {
        if (permission == null) {
            throw new IllegalArgumentException("Permission must not be null");
        }

        if (permission.getId() == null) {
            throw new IllegalArgumentException("Permission id must not be null");
        }

        Callable<Void> callable = new Callable<Void>() {
            @Override
            public Void call() throws Exception {
                http.<Void>put(serverConfiguration.getPolicyEndpoint() + "/"+ permission.getId())
                        .authorizationBearer(pat.call())
                        .json(JsonSerialization.writeValueAsBytes(permission)).execute();
                return null;
            }
        };
        try {
            callable.call();
        } catch (Exception cause) {
            Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Error updating policy for resource [" + resourceId + "]", cause);
        }
    }

メンバ詳解

http

final Http org.keycloak.authorization.client.resource.PolicyResource.http

private

pat

final TokenCallable org.keycloak.authorization.client.resource.PolicyResource.pat

private

resourceId

String org.keycloak.authorization.client.resource.PolicyResource.resourceId

private

serverConfiguration

final ServerConfiguration org.keycloak.authorization.client.resource.PolicyResource.serverConfiguration

private

---

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

• D:/AppData/OpenId/keycloak/doxygen/src/authz/client/src/main/java/org/keycloak/authorization/client/resource/PolicyResource.java