org.jbei.ice.services.rest

Class ApiKeyResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.ApiKeyResource

@Path(value="/api-keys")
public class ApiKeyResource
extends RestResource

REST Resource for api-keys that enable third-party application access to ice

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
ApiKeyResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createApiKey(String clientId) creates an api-key for the specified client id
javax.ws.rs.core.Response	deleteApiKey(String secret, String clientId, long id) Delete a specified API key
javax.ws.rs.core.Response	getApiKeys(int offset, int limit, boolean asc, String sort, boolean getAll) retrieves list of api keys created by user

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKeyResource

public ApiKeyResource()

Method Detail

createApiKey

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createApiKey(@QueryParam(value="client_id")
                                                                                                                              String clientId)

creates an api-key for the specified client id

getApiKeys

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getApiKeys(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                      int offset,
                                                                                      @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                      int limit,
                                                                                      @DefaultValue(value="true") @QueryParam(value="asc")
                                                                                      boolean asc,
                                                                                      @DefaultValue(value="creationTime") @QueryParam(value="sort")
                                                                                      String sort,
                                                                                      @DefaultValue(value="false") @QueryParam(value="getAll")
                                                                                      boolean getAll)

retrieves list of api keys created by user

deleteApiKey

@DELETE
 @Path(value="/{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteApiKey(@QueryParam(value="secret")
                                                                                                                 String secret,
                                                                                                                 @QueryParam(value="clientId")
                                                                                                                 String clientId,
                                                                                                                 @PathParam(value="id")
                                                                                                                 long id)

Delete a specified API key

Parameters:

secret -

clientId -

id -

Returns: