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

Class ClientRedirectService

java.lang.Object

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

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

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

A RESTful API that permits the management of a client's redirect URI's.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
ClientRedirectService(BigInteger clientId) Create a new instance of this redirect service.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	browse(int offset, int limit, String sort, SortOrder order) Browse the redirects for this client.
javax.ws.rs.core.Response	createResource(ClientRedirect redirect) Create a new redirect for this client.
javax.ws.rs.core.Response	deleteResource(BigInteger redirectId) Delete a redirect from a client.
protected String	getAccessScope() Return the redirect required to access resources on this service.
protected String	getAdminScope() Return the redirect required to access ALL resources on this services.
javax.ws.rs.core.Response	getResource(BigInteger id) Returns a specific redirect.
javax.ws.rs.core.Response	updateResource(BigInteger id, ClientRedirect redirect) Update a redirect for this 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

ClientRedirectService

@Inject
public ClientRedirectService(@PathParam(value="clientId")
                                     BigInteger clientId)

Create a new instance of this redirect service.

Parameters:

clientId - The client id, provided by the routed path.

Method Detail

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)

Browse the redirects for this client.

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.

Returns:

A list of browse 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 redirect.

Parameters:

id - The Unique Identifier for the redirect.

Returns:

A response with the redirect that was requested.

createResource

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

Create a new redirect for this client.

Parameters:

redirect - The redirect entity 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,
                                                                                                                                                                   ClientRedirect redirect)

Update a redirect for this client.

Parameters:

id - The Unique Identifier for the redirect.

redirect - The redirect to update.

Returns:

A response with the redirect that was updated.

deleteResource

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

Delete a redirect from a client.

Parameters:

redirectId - The Unique Identifier for the redirect.

Returns:

A response that indicates the success of this operation.

getAdminScope

protected String getAdminScope()

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

Specified by:

getAdminScope in class AbstractService

Returns:

A string naming the redirect.

getAccessScope

protected String getAccessScope()

Return the redirect required to access resources on this service.

Specified by:

getAccessScope in class AbstractService

Returns:

A string naming the redirect.