Package org.keycloak.services.resources.account.resources

Class ResourcesService

java.lang.Object

org.keycloak.services.resources.account.resources.AbstractResourceService

org.keycloak.services.resources.account.resources.ResourcesService

public class ResourcesService
extends AbstractResourceService

Author:

Pedro Igor

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.services.resources.account.resources.AbstractResourceService

AbstractResourceService.Client, AbstractResourceService.Permission, AbstractResourceService.Resource, AbstractResourceService.ResourcePermission, AbstractResourceService.Scope

Field Summary

Fields inherited from class org.keycloak.services.resources.account.resources.AbstractResourceService

auth, provider, request, resourceStore, scopeStore, ticketStore, uriInfo, user

Constructor Summary

Constructors

Constructor	Description
ResourcesService(KeycloakSession session, UserModel user, Auth auth, HttpRequest request)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getPendingRequests()
Object	getResource(String id)
jakarta.ws.rs.core.Response	getResources(String name, Integer first, Integer max)	Returns a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner.
jakarta.ws.rs.core.Response	getSharedWithMe(String name, Integer first, Integer max)	Returns a list of AbstractResourceService.Resource shared with the AbstractResourceService.user
jakarta.ws.rs.core.Response	getSharedWithOthers(Integer first, Integer max)	Returns a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner and the resource is shared with other users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResourcesService

public ResourcesService(KeycloakSession session,
 UserModel user,
 Auth auth,
 HttpRequest request)

Method Details

getResources

@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getResources(@QueryParam("name")
 String name,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Returns a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner.

Parameters:

first - the first result

max - the max result

Returns:

a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner

getSharedWithMe

@GET
@Path("shared-with-me")
@Produces("application/json")
public jakarta.ws.rs.core.Response getSharedWithMe(@QueryParam("name")
 String name,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Returns a list of AbstractResourceService.Resource shared with the AbstractResourceService.user

Parameters:

first - the first result

max - the max result

Returns:

a list of AbstractResourceService.Resource shared with the AbstractResourceService.user

getSharedWithOthers

@GET
@Path("shared-with-others")
@Produces("application/json")
public jakarta.ws.rs.core.Response getSharedWithOthers(@QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Returns a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner and the resource is shared with other users.

Parameters:

first - the first result

max - the max result

Returns:

a list of AbstractResourceService.Resource where the AbstractResourceService.user is the resource owner and the resource is * shared with other users

getPendingRequests

@GET
@Path("pending-requests")
@Produces("application/json")
public jakarta.ws.rs.core.Response getPendingRequests()

getResource

@Path("{id}")
public Object getResource(@PathParam("id")
 String id)