org.wso2.carbon.auth.scope.registration.rest.api

Class ScopesApi

java.lang.Object

org.wso2.carbon.auth.scope.registration.rest.api.ScopesApi

All Implemented Interfaces:

org.wso2.msf4j.Microservice

@Path(value="/api/auth/scope-registration/v1.[\\d]+/scopes")
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @ApplicationPath(value="/scopes")
public class ScopesApi
extends Object
implements org.wso2.msf4j.Microservice

Constructor Summary

Constructors

Constructor and Description
ScopesApi()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteScope(String name, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	getScope(String name, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	getScopes(Integer offset, Integer limit, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	isScopeExists(String name, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	registerScope(ScopeDTO scope, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	updateScope(ScopeDTO scope, String name, org.wso2.msf4j.Request request)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopesApi

public ScopesApi()

Method Detail

deleteScope

@DELETE
 @Path(value="/{name}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteScope(@PathParam(value="name")
                                                                                                                                                       String name,
                                                                                                                                                       @Context
                                                                                                                                                       org.wso2.msf4j.Request request)
                                                                                                                                                throws NotFoundException

Throws:

NotFoundException

getScope

@GET
 @Path(value="/{name}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getScope(@PathParam(value="name")
                                                                                                                                                 String name,
                                                                                                                                                 @Context
                                                                                                                                                 org.wso2.msf4j.Request request)
                                                                                                                                          throws NotFoundException

Throws:

NotFoundException

getScopes

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getScopes(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                          Integer offset,
                                                                                                                          @DefaultValue(value="25") @QueryParam(value="limit")
                                                                                                                          Integer limit,
                                                                                                                          @Context
                                                                                                                          org.wso2.msf4j.Request request)
                                                                                                                   throws NotFoundException

Throws:

NotFoundException

isScopeExists

@HEAD
 @Path(value="/{name}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response isScopeExists(@PathParam(value="name")
                                                                                                                                                       String name,
                                                                                                                                                       @Context
                                                                                                                                                       org.wso2.msf4j.Request request)
                                                                                                                                                throws NotFoundException

Throws:

NotFoundException

registerScope

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response registerScope(ScopeDTO scope,
                                                                                                                               @Context
                                                                                                                               org.wso2.msf4j.Request request)
                                                                                                                        throws NotFoundException

Throws:

NotFoundException

updateScope

@PUT
 @Path(value="/{name}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateScope(ScopeDTO scope,
                                                                                                                                                    @PathParam(value="name")
                                                                                                                                                    String name,
                                                                                                                                                    @Context
                                                                                                                                                    org.wso2.msf4j.Request request)
                                                                                                                                             throws NotFoundException

Throws:

NotFoundException