Package io.jans.as.server.uma.ws.rs

Class UmaResourceRegistrationWS

java.lang.Object

io.jans.as.server.uma.ws.rs.UmaResourceRegistrationWS

@Path("/host/rsrc/resource_set")
public class UmaResourceRegistrationWS
extends Object

The API available at the resource registration endpoint enables the resource server to put resources under the protection of an authorization server on behalf of the resource owner and manage them over time. Protection of a resource at the authorization server begins on successful registration and ends on successful deregistration.

The resource server uses a RESTful API at the authorization server's resource registration endpoint to create, read, update, and delete resource descriptions, along with retrieving lists of such descriptions. The descriptions consist of JSON documents that are maintained as web resources at the authorization server. (Note carefully the similar but distinct senses in which the word "resource" is used in this section.)

Author:

Yuriy Zabrovarnyy, Yuriy Movchan Date: 02/12/2015

Constructor Summary

Constructors

Constructor	Description
UmaResourceRegistrationWS()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createResource(String authorization, io.jans.as.model.uma.UmaResource resource)
jakarta.ws.rs.core.Response	deleteResource(String authorization, String rsid)
jakarta.ws.rs.core.Response	getResource(String authorization, String rsid)
List<String>	getResourceList(String authorization, String scope)	Gets resource set lists.
jakarta.ws.rs.core.Response	unsupportedHeadMethod()
jakarta.ws.rs.core.Response	unsupportedOptionsMethod()
jakarta.ws.rs.core.Response	updateResource(String authorization, String rsid, io.jans.as.model.uma.UmaResource resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

UmaResourceRegistrationWS

public UmaResourceRegistrationWS()

Method Detail

createResource

@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response createResource(@HeaderParam("Authorization")
                                                  String authorization,
                                                  io.jans.as.model.uma.UmaResource resource)

updateResource

@PUT
@Path("{rsid}")
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response updateResource(@HeaderParam("Authorization")
                                                  String authorization,
                                                  @PathParam("rsid")
                                                  String rsid,
                                                  io.jans.as.model.uma.UmaResource resource)

getResource

@GET
@Path("{rsid}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getResource(@HeaderParam("Authorization")
                                               String authorization,
                                               @PathParam("rsid")
                                               String rsid)

getResourceList

@GET
@Produces("application/json")
public List<String> getResourceList(@HeaderParam("Authorization")
                                    String authorization,
                                    @QueryParam("scope")
                                    String scope)

Gets resource set lists. ATTENTION: "scope" is parameter added by gluu to have additional filtering. There is no such parameter in UMA specification.

Parameters:

authorization - authorization

scope - scope of resource set for additional filtering, can blank string.

Returns:

resource set ids.

deleteResource

@DELETE
@Path("{rsid}")
public jakarta.ws.rs.core.Response deleteResource(@HeaderParam("Authorization")
                                                  String authorization,
                                                  @PathParam("rsid")
                                                  String rsid)

unsupportedHeadMethod

@HEAD
public jakarta.ws.rs.core.Response unsupportedHeadMethod()

unsupportedOptionsMethod

@OPTIONS
public jakarta.ws.rs.core.Response unsupportedOptionsMethod()