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

Class ClientService

java.lang.Object

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

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

@Path(value="/client")
 @ScopesAllowed(value={"kangaroo:client","kangaroo:client_admin"})
public final class ClientService
extends AbstractService

A RESTful API that permits the management of application client resources.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	browse(int offset, int limit, String sort, SortOrder order, BigInteger ownerId, BigInteger applicationId, ClientType clientType) Browse the clients in the system.
javax.ws.rs.core.Response	createResource(Client client) Create an client.
javax.ws.rs.core.Response	deleteResource(BigInteger id) Delete an scope.
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.
Class<ClientRedirectService>	getRedirectService(BigInteger clientId) Expose a subresource that manages the redirects on a client.
Class<ClientReferrerService>	getReferrerService(BigInteger clientId) Expose a subresource that manages the referrers on a client.
javax.ws.rs.core.Response	getResource(BigInteger id) Returns a specific scope.
javax.ws.rs.core.Response	search(Integer offset, Integer limit, String queryString, BigInteger ownerId, BigInteger applicationId) Search the clients in the system.
javax.ws.rs.core.Response	updateResource(BigInteger id, Client client) Update an client.

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

ClientService

public ClientService()

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,
                                                                                                          @Optional @QueryParam(value="application")
                                                                                                          BigInteger applicationId)

Search the clients in the system.

Parameters:

offset - The offset of the first scopes 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.

applicationId - An optional application ID to filter by.

Returns:

A list of search results.

browse

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response browse(@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,
                                                                                  @Optional @QueryParam(value="application")
                                                                                  BigInteger applicationId,
                                                                                  @Optional @QueryParam(value="type")
                                                                                  ClientType clientType)

Browse the clients in the system.

Parameters:

offset - The offset of the first scopes 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.

applicationId - An optional application ID to filter by.

clientType - An optional client type 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 scope.

Parameters:

id - The Unique Identifier for the scope.

Returns:

A response with the scope that was requested.

createResource

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

Create an client.

Parameters:

client - The client to create.

Returns:

A redirect to the location where the client 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,
                                                                                                                                                                   Client client)

Update an client.

Parameters:

id - The Unique Identifier for the client.

client - The client to update.

Returns:

A response with the client 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 scope.

Parameters:

id - The Unique Identifier for the scope.

Returns:

A response that indicates the successs of this operation.

getRedirectService

@Path(value="/{clientId: [a-f0-9]{32}}/redirect")
public Class<ClientRedirectService> getRedirectService(@PathParam(value="clientId")
                                                                                                         BigInteger clientId)

Expose a subresource that manages the redirects on a client. Note that the OAuth2 flow will not be initialized until the path fully resolves, so all auth checks have to happen in the child resource.

Parameters:

clientId - The ID of the client.

Returns:

The subresource.

getReferrerService

@Path(value="/{clientId: [a-f0-9]{32}}/referrer")
public Class<ClientReferrerService> getReferrerService(@PathParam(value="clientId")
                                                                                                         BigInteger clientId)

Expose a subresource that manages the referrers on a client. Note that the OAuth2 flow will not be initialized until the path fully resolves, so all auth checks have to happen in the child resource.

Parameters:

clientId - The ID of the client.

Returns:

The subresource.

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.