Class UmaResourceRegistrationWS


  • @Path("/host/rsrc/resource_set")
    public class UmaResourceRegistrationWS
    extends java.lang.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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response createResource​(java.lang.String authorization, UmaResource resource)  
      javax.ws.rs.core.Response deleteResource​(java.lang.String authorization, java.lang.String rsid)  
      javax.ws.rs.core.Response getResource​(java.lang.String authorization, java.lang.String rsid)  
      java.util.List<java.lang.String> getResourceList​(java.lang.String authorization, java.lang.String scope)
      Gets resource set lists.
      javax.ws.rs.core.Response unsupportedHeadMethod()  
      javax.ws.rs.core.Response unsupportedOptionsMethod()  
      javax.ws.rs.core.Response updateResource​(java.lang.String authorization, java.lang.String rsid, 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 javax.ws.rs.core.Response createResource​(@HeaderParam("Authorization")
                                                        java.lang.String authorization,
                                                        UmaResource resource)
      • updateResource

        @PUT
        @Path("{rsid}")
        @Consumes("application/json")
        @Produces("application/json")
        public javax.ws.rs.core.Response updateResource​(@HeaderParam("Authorization")
                                                        java.lang.String authorization,
                                                        @PathParam("rsid")
                                                        java.lang.String rsid,
                                                        UmaResource resource)
      • getResource

        @GET
        @Path("{rsid}")
        @Produces("application/json")
        public javax.ws.rs.core.Response getResource​(@HeaderParam("Authorization")
                                                     java.lang.String authorization,
                                                     @PathParam("rsid")
                                                     java.lang.String rsid)
      • getResourceList

        @GET
        @Produces("application/json")
        public java.util.List<java.lang.String> getResourceList​(@HeaderParam("Authorization")
                                                                java.lang.String authorization,
                                                                @QueryParam("scope")
                                                                java.lang.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 javax.ws.rs.core.Response deleteResource​(@HeaderParam("Authorization")
                                                        java.lang.String authorization,
                                                        @PathParam("rsid")
                                                        java.lang.String rsid)
      • unsupportedHeadMethod

        @HEAD
        public javax.ws.rs.core.Response unsupportedHeadMethod()
      • unsupportedOptionsMethod

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