org.jbei.ice.services.rest

Class AccessTokenResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.AccessTokenResource

@Path(value="/accesstokens")
public class AccessTokenResource
extends RestResource

API for access tokens (also session id for the user interface)

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
AccessTokenResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(AccountTransfer transfer) Creates a new access token for the user referenced in the parameter, after the credentials (username and password) are validated.
javax.ws.rs.core.Response	deleteToken() Invalidates the current session information.
javax.ws.rs.core.Response	get() Retrieve account information for user referenced by session id
javax.ws.rs.core.Response	getWebPartner(String url) Validates web of registries access token (api key)

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

AccessTokenResource

public AccessTokenResource()

Method Detail

create

@POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response create(AccountTransfer transfer)

Creates a new access token for the user referenced in the parameter, after the credentials (username and password) are validated. If one already exists, it is invalidated

Parameters:

transfer - wraps username and password

Returns:

account information including a valid session id if credentials validate

deleteToken

@DELETE
public javax.ws.rs.core.Response deleteToken()

Invalidates the current session information.

get

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response get()

Retrieve account information for user referenced by session id

Returns:

account information for session if session is valid, null otherwise

getWebPartner

@GET
 @Path(value="/web")
public javax.ws.rs.core.Response getWebPartner(@QueryParam(value="url")
                                                                         String url)

Validates web of registries access token (api key)