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

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

公開メンバ関数
ResourceRepresentation	create (final ResourceRepresentation resource)
void	update (final ResourceRepresentation resource)
ResourceRepresentation	findById (final String id)
ResourceRepresentation	findByName (String name)
ResourceRepresentation	findByName (String name, String ownerId)
String []	find (final String id, final String name, final String uri, final String owner, final String type, final String scope, final boolean matchingUri, final Integer firstResult, final Integer maxResult)
String []	findAll ()
void	delete (final String id)
List< ResourceRepresentation >	findByUri (String uri)
List< ResourceRepresentation >	findByMatchingUri (String uri)

関数
	ProtectedResource (Http http, ServerConfiguration serverConfiguration, Configuration configuration, TokenCallable pat)
public< R > R	find (final String id, final String name, final String uri, final String owner, final String type, final String scope, final boolean matchingUri, final boolean deep, final Integer firstResult, final Integer maxResult)

非公開メンバ関数
HttpMethod	createFindRequest (String id, String name, String uri, String owner, String type, String scope, boolean matchingUri, boolean deep, Integer firstResult, Integer maxResult)

非公開変数類
final Http	http
ServerConfiguration	serverConfiguration
final Configuration	configuration
final TokenCallable	pat

詳解

An entry point for managing resources using the Protection API.

著者

Pedro Igor

構築子と解体子

ProtectedResource()

org.keycloak.authorization.client.resource.ProtectedResource.ProtectedResource ( Http  http, ServerConfiguration  serverConfiguration, Configuration  configuration, TokenCallable  pat  )

inlinepackage

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

関数詳解

create()

ResourceRepresentation org.keycloak.authorization.client.resource.ProtectedResource.create ( final ResourceRepresentation  resource )

inline

Creates a new resource.

引数

resource

the resource data

戻り値

a RegistrationResponse

                                                                                {
        Callable<ResourceRepresentation> callable = new Callable<ResourceRepresentation>() {
            @Override
            public ResourceRepresentation call() throws Exception {
                return http.<ResourceRepresentation>post(serverConfiguration.getResourceRegistrationEndpoint())
                        .authorizationBearer(pat.call())
                        .json(JsonSerialization.writeValueAsBytes(resource))
                        .response().json(ResourceRepresentation.class).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Could not create resource", cause);
        }
    }

createFindRequest()

HttpMethod org.keycloak.authorization.client.resource.ProtectedResource.createFindRequest ( String  id, String  name, String  uri, String  owner, String  type, String  scope, boolean  matchingUri, boolean  deep, Integer  firstResult, Integer  maxResult  )

inlineprivate

                                                                                                                                                                                                 {
        return http.get(serverConfiguration.getResourceRegistrationEndpoint())
                .authorizationBearer(pat.call())
                .param("_id", id)
                .param("name", name)
                .param("uri", uri)
                .param("owner", owner)
                .param("type", type)
                .param("scope", scope)
                .param("matchingUri", Boolean.valueOf(matchingUri).toString())
                .param("deep", Boolean.toString(deep))
                .param("first", firstResult != null ? firstResult.toString() : null)
                .param("max", maxResult != null ? maxResult.toString() : null);
    }

delete()

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

inline

Deletes a resource with the given id.

引数

id	the resource id

                                        {
        Callable callable = new Callable() {
            @Override
            public Object call() throws Exception {
                http.delete(serverConfiguration.getResourceRegistrationEndpoint() + "/" + id)
                        .authorizationBearer(pat.call())
                        .execute();
                return null;
            }
        };
        try {
            callable.call();
        } catch (Exception cause) {
            Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "", cause);
        }
    }

find() [1/2]

String [] org.keycloak.authorization.client.resource.ProtectedResource.find ( final String  id, final String  name, final String  uri, final String  owner, final String  type, final String  scope, final boolean  matchingUri, final Integer  firstResult, final Integer  maxResult  )

inline

Query the server for any resource with the matching arguments.

引数

id	the resource id
name	the resource name
uri	the resource uri
owner	the resource owner
type	the resource type
scope	the resource scope
matchingUri	the resource uri. Use this parameter to lookup a resource that best match the given uri
firstResult	the position of the first resource to retrieve
maxResult	the maximum number of resources to retrieve

戻り値

an array of strings with the resource ids

                                                                                                                                                                                                                         {
        Callable<String[]> callable = new Callable<String[]>() {
            @Override
            public String[] call() throws Exception {
                return (String[]) createFindRequest(id, name, uri, owner, type, scope, matchingUri, false, firstResult, maxResult).response().json(String[].class).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Could not find resource", cause);
        }
    }

find() [2/2]

public<R> R org.keycloak.authorization.client.resource.ProtectedResource.find ( final String  id, final String  name, final String  uri, final String  owner, final String  type, final String  scope, final boolean  matchingUri, final boolean  deep, final Integer  firstResult, final Integer  maxResult  )

inlinepackage

Query the server for any resource with the matching arguments.

引数

id	the resource id
name	the resource name
uri	the resource uri
owner	the resource owner
type	the resource type
scope	the resource scope
matchingUri	the resource uri. Use this parameter to lookup a resource that best match the given uri
deep	if the result should be a list of resource representations with details about the resource. If false, only ids are returned
firstResult	the position of the first resource to retrieve
maxResult	the maximum number of resources to retrieve

戻り値

a list of resource representations or an array of strings representing resource ids, depending on the generic type

                                                                                                                                                                                                                                          {
        if (deep) {
            Callable<List<ResourceRepresentation>> callable = new Callable<List<ResourceRepresentation>>() {
                @Override
                public List<ResourceRepresentation> call() {
                    return (List<ResourceRepresentation>) createFindRequest(id, name, uri, owner, type, scope, matchingUri, deep, firstResult, maxResult).response().json(new TypeReference<List<ResourceRepresentation>>() {
                    }).execute();
                }
            };
            try {
                return (R) callable.call();
            } catch (Exception cause) {
                return (R) Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Could not find resource", cause);
            }
        }

        return (R) find(id, name, uri, owner, type, scope, matchingUri, firstResult, maxResult);
    }

findAll()

String [] org.keycloak.authorization.client.resource.ProtectedResource.findAll ( )

inline

Query the server for all resources.

戻り値

an array of strings with the resource ids

                              {
        try {
            return find(null,null , null, null, null, null, false, null, null);
        } catch (Exception cause) {
            throw Throwables.handleWrapException("Could not find resource", cause);
        }
    }

findById()

ResourceRepresentation org.keycloak.authorization.client.resource.ProtectedResource.findById ( final String  id )

inline

Query the server for a resource given its id.

引数

id	the resource id

戻り値

a ResourceRepresentation

                                                            {
        Callable<ResourceRepresentation> callable = new Callable<ResourceRepresentation>() {
            @Override
            public ResourceRepresentation call() throws Exception {
                return http.<ResourceRepresentation>get(serverConfiguration.getResourceRegistrationEndpoint() + "/" + id)
                        .authorizationBearer(pat.call())
                        .response().json(ResourceRepresentation.class).execute();
            }
        };
        try {
            return callable.call();
        } catch (Exception cause) {
            return Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Could not find resource", cause);
        }
    }

findByMatchingUri()

List<ResourceRepresentation> org.keycloak.authorization.client.resource.ProtectedResource.findByMatchingUri ( String  uri )

inline

Returns a list of resources that best matches the given

uri 

. This method queries the server for resources whose ResourceRepresentation#uri best matches the given

uri 

.

引数

uri	the resource uri to match

戻り値

a list of resources

                                                                      {
        return find(null, null, uri, null, null, null, true, true,null, null);
    }

findByName() [1/2]

ResourceRepresentation org.keycloak.authorization.client.resource.ProtectedResource.findByName ( String  name )

inline

Query the server for a resource given its name where the owner is the resource server itself.

引数

name	the resource name

戻り値

a ResourceRepresentation

                                                          {
        List<ResourceRepresentation> representations = find(null, name, null, configuration.getResource(), null, null, false, true, null, null);

        if (representations.isEmpty()) {
            return null;
        }

        return representations.get(0);
    }

findByName() [2/2]

ResourceRepresentation org.keycloak.authorization.client.resource.ProtectedResource.findByName ( String  name, String  ownerId  )

inline

Query the server for a resource given its name and a given ownerId.

引数

name	the resource name
ownerId	the owner id

戻り値

a ResourceRepresentation

                                                                          {
        List<ResourceRepresentation> representations = find(null, name, null, ownerId, null, null, false, true,null, null);

        if (representations.isEmpty()) {
            return null;
        }

        return representations.get(0);
    }

findByUri()

List<ResourceRepresentation> org.keycloak.authorization.client.resource.ProtectedResource.findByUri ( String  uri )

inline

Query the server for all resources with the given uri.

引数

uri	the resource uri

                                                              {
        return find(null, null, uri, null, null, null, false, true, null, null);
    }

update()

void org.keycloak.authorization.client.resource.ProtectedResource.update ( final ResourceRepresentation  resource )

inline

Updates a resource.

引数

resource

the resource data

戻り値

a RegistrationResponse

                                                              {
        if (resource.getId() == null) {
            throw new IllegalArgumentException("You must provide the resource id");
        }

        Callable callable = new Callable() {
            @Override
            public Object call() throws Exception {
                http.<ResourceRepresentation>put(serverConfiguration.getResourceRegistrationEndpoint() + "/" + resource.getId())
                        .authorizationBearer(pat.call())
                        .json(JsonSerialization.writeValueAsBytes(resource)).execute();
                return null;
            }
        };
        try {
            callable.call();
        } catch (Exception cause) {
            Throwables.retryAndWrapExceptionIfNecessary(callable, pat, "Could not update resource", cause);
        }
    }

メンバ詳解

configuration

final Configuration org.keycloak.authorization.client.resource.ProtectedResource.configuration

private

http

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

private

pat

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

private

serverConfiguration

ServerConfiguration org.keycloak.authorization.client.resource.ProtectedResource.serverConfiguration

private

---

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

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