net.krotscheck.kangaroo.authz.admin.v1.resource

Class ApplicationService

java.lang.Object

net.krotscheck.kangaroo.authz.admin.v1.resource.AbstractService

net.krotscheck.kangaroo.authz.admin.v1.resource.ApplicationService

@Path(value="/application")
 @ScopesAllowed(value={"kangaroo:application","kangaroo:application_admin"})
public final class ApplicationService
extends AbstractService

A RESTful API that permits the management of application resources.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
ApplicationService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	browseApplications(int offset, int limit, String sort, SortOrder order, BigInteger ownerId) Browse the applications in the system.
javax.ws.rs.core.Response	createResource(Application application) Create an application.
javax.ws.rs.core.Response	deleteResource(BigInteger id) Delete an application.
protected String	getAccessScope() Return the scope required to access resources on this service.
protected String	getAdminScope() Return the scope required to access ALL resources on this services.
javax.ws.rs.core.Response	getResource(BigInteger id) Returns a specific application.
javax.ws.rs.core.Response	search(Integer offset, Integer limit, String queryString, BigInteger ownerId) Search the applications in the system.
javax.ws.rs.core.Response	updateResource(BigInteger id, Application application) Update an application.

Methods inherited from class net.krotscheck.kangaroo.authz.admin.v1.resource.AbstractService

assertCanAccess, assertCanAccessSubresource, executeQuery, getAdminApplication, getConfig, getCurrentUser, getFullTextSession, getInjector, getSearchFactory, getSecurityContext, getSession, getUriInfo, requireEntityInput, resolveEntityInput, resolveEntityInput, resolveFilterEntity, resolveOwnershipFilter, setConfig, setFullTextSession, setInjector, setSearchFactory, setSecurityContext, setSession, setUriInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationService

public ApplicationService()

Method Detail

search

@GET
 @Path(value="/search")
 @Produces(value="application/json")
public javax.ws.rs.core.Response search(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                          Integer offset,
                                                                                                          @DefaultValue(value="10") @QueryParam(value="limit")
                                                                                                          Integer limit,
                                                                                                          @DefaultValue(value="") @QueryParam(value="q")
                                                                                                          String queryString,
                                                                                                          @Optional @QueryParam(value="owner")
                                                                                                          BigInteger ownerId)

Search the applications in the system.

Parameters:

offset - The offset of the first applications to fetch.

limit - The number of data sets to fetch.

queryString - The search term for the query.

ownerId - An optional user ID to filter by.

Returns:

A list of search results.

browseApplications

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response browseApplications(@QueryParam(value="offset") @DefaultValue(value="0")
                                                                                              int offset,
                                                                                              @QueryParam(value="limit") @DefaultValue(value="10")
                                                                                              int limit,
                                                                                              @QueryParam(value="sort") @DefaultValue(value="createdDate")
                                                                                              String sort,
                                                                                              @QueryParam(value="order") @DefaultValue(value="ASC")
                                                                                              SortOrder order,
                                                                                              @Optional @QueryParam(value="owner")
                                                                                              BigInteger ownerId)

Browse the applications in the system.

Parameters:

offset - The offset of the first applications to fetch.

limit - The number of data sets to fetch.

sort - The field on which the records should be sorted.

order - The sort order, ASC or DESC.

ownerId - An optional user ID to filter by.

Returns:

A list of search results.

getResource

@GET
 @Path(value="/{id: [a-f0-9]{32}}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getResource(@PathParam(value="id")
                                                                                                                           BigInteger id)

Returns a specific application.

Parameters:

id - The Unique Identifier for the application.

Returns:

A response with the application that was requested.

createResource

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createResource(Application application)

Create an application.

Parameters:

application - The application to create.

Returns:

A response with the application that was created.

updateResource

@PUT
 @Path(value="/{id: [a-f0-9]{32}}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateResource(@PathParam(value="id")
                                                                                                                                                                   BigInteger id,
                                                                                                                                                                   Application application)

Update an application.

Parameters:

id - The Unique Identifier for the application.

application - The application to update.

Returns:

A response with the application that was updated.

deleteResource

@DELETE
 @Path(value="/{id: [a-f0-9]{32}}")
public javax.ws.rs.core.Response deleteResource(@PathParam(value="id")
                                                                                            BigInteger id)

Delete an application.

Parameters:

id - The Unique Identifier for the application.

Returns:

A response that indicates the successs of this operation.

getAdminScope

protected String getAdminScope()

Return the scope required to access ALL resources on this services.

Specified by:

getAdminScope in class AbstractService

Returns:

A string naming the scope.

getAccessScope

protected String getAccessScope()

Return the scope required to access resources on this service.

Specified by:

getAccessScope in class AbstractService

Returns:

A string naming the scope.