org.jbei.ice.services.rest

Class RestResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

Direct Known Subclasses:

AccessTokenResource, AnnotationResource, ApiKeyResource, BulkUploadResource, CollectionResource, ConfigResource, CustomFieldResource, FileResource, FolderResource, GroupResource, ManuscriptResource, MessageResource, PartnerResource, PartResource, PermissionResource, SampleResource, SearchResource, UserResource, WebResource

public class RestResource
extends Object

Parent class for all rest resource objects. Handles session validation as well as return responses based on specific values

Author:

Hector Plahar

Field Summary

Fields

Modifier and Type	Field and Description
protected String	API_KEY_CLIENT_ID
protected String	API_KEY_TOKEN
protected String	API_KEY_USER
protected String	apiClientId
protected String	apiToken
protected String	apiUser
protected String	AUTHENTICATION_PARAM_NAME
protected String	hmacHeader
protected String	querySessionId
protected String	REMOTE_USER_ID
protected String	REMOTE_USER_TOKEN
protected String	remoteUserId
protected String	remoteUserToken
protected javax.servlet.http.HttpServletRequest	request
protected String	sessionId
protected String	WOR_PARTNER_TOKEN
protected String	worPartnerToken

Constructor Summary

Constructors

Constructor and Description
RestResource()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	addHeaders(javax.ws.rs.core.Response.ResponseBuilder response, String fileName)
protected String	getThisServer(boolean includeContext)
protected String	getUserId() Extract the User ID from header values in the resource request.
protected String	getUserId(String sessionId) Extract the User ID from a query parameter value or header values in the resource request.
protected RegistryPartner	getWebPartner()
protected void	log(String userId, String message) Used to log user actions
protected String	requireUserId() Attempts to retrieve the identifier for the specific user
protected void	requireUserIdOrWebPartner(String logMessage) Requires either a valid user request or request from a web partner
protected RegistryPartner	requireWebPartner()
protected javax.ws.rs.core.Response	respond(boolean success) Create an empty Response object.
protected javax.ws.rs.core.Response	respond(Object object) Create a Response object from an entity object.
protected javax.ws.rs.core.Response	respond(javax.ws.rs.core.Response.Status status) Create an empty Response object.
protected javax.ws.rs.core.Response	respond(javax.ws.rs.core.Response.Status status, Object obj) Create a Response object from an entity object.

Methods inherited from class java.lang.Object

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

Field Detail

AUTHENTICATION_PARAM_NAME

protected final String AUTHENTICATION_PARAM_NAME

See Also:

Constant Field Values

WOR_PARTNER_TOKEN

protected final String WOR_PARTNER_TOKEN

See Also:

Constant Field Values

API_KEY_TOKEN

protected final String API_KEY_TOKEN

See Also:

Constant Field Values

API_KEY_USER

protected final String API_KEY_USER

See Also:

Constant Field Values

API_KEY_CLIENT_ID

protected final String API_KEY_CLIENT_ID

See Also:

Constant Field Values

REMOTE_USER_TOKEN

protected final String REMOTE_USER_TOKEN

See Also:

Constant Field Values

REMOTE_USER_ID

protected final String REMOTE_USER_ID

See Also:

Constant Field Values

worPartnerToken

@HeaderParam(value="X-ICE-WOR-Token")
protected String worPartnerToken

apiClientId

@HeaderParam(value="X-ICE-API-Token-Client")
protected String apiClientId

apiUser

@HeaderParam(value="X-ICE-API-Token-User")
protected String apiUser

apiToken

@HeaderParam(value="X-ICE-API-Token")
protected String apiToken

sessionId

@HeaderParam(value="X-ICE-Authentication-SessionId")
protected String sessionId

remoteUserToken

@HeaderParam(value="X-ICE-Remote-User-Token")
protected String remoteUserToken

remoteUserId

@HeaderParam(value="X-ICE-Remote-User-ID")
protected String remoteUserId

hmacHeader

@HeaderParam(value="Authorization")
protected String hmacHeader

querySessionId

@QueryParam(value="sid")
protected String querySessionId

request

@Context
protected javax.servlet.http.HttpServletRequest request

Constructor Detail

RestResource

public RestResource()

Method Detail

getUserId

protected String getUserId()

Extract the User ID from header values in the resource request. This can either be the session id or API keys

Returns:

a string User ID

Throws:

javax.ws.rs.WebApplicationException - for unauthorized access

requireUserId

protected String requireUserId()

Attempts to retrieve the identifier for the specific user

Returns:

valid user identifier

Throws:

javax.ws.rs.WebApplicationException - with status 401 if the user id cannot be retrieved

requireUserIdOrWebPartner

protected void requireUserIdOrWebPartner(String logMessage)

Requires either a valid user request or request from a web partner

Parameters:

logMessage - log message for request

getThisServer

protected String getThisServer(boolean includeContext)

getUserId

protected String getUserId(String sessionId)

Extract the User ID from a query parameter value or header values in the resource request.

requireWebPartner

protected RegistryPartner requireWebPartner()

getWebPartner

protected RegistryPartner getWebPartner()

respond

protected javax.ws.rs.core.Response respond(javax.ws.rs.core.Response.Status status,
                                            Object obj)

Create a Response object from an entity object.

Parameters:

status - HTTP status code

obj - entity in response

Returns:

a Response object for the resource request, uses 500 error response if entity is null

respond

protected javax.ws.rs.core.Response respond(Object object)

Create a Response object from an entity object.

Parameters:

object - entity in response

Returns:

a 404 NOT FOUND if object is null, else a 200 OK response with the entity

respond

protected javax.ws.rs.core.Response respond(javax.ws.rs.core.Response.Status status)

Create an empty Response object.

Parameters:

status - HTTP status code to use on the Response

Returns:

a Response object for the resource request

respond

protected javax.ws.rs.core.Response respond(boolean success)

Create an empty Response object.

Parameters:

success - success/failure flag

Returns:

a 200 OK response if success is true, otherwise a 500 error response

log

protected void log(String userId,
                   String message)

Used to log user actions

Parameters:

userId - unique user identifier

message - log message

addHeaders

protected javax.ws.rs.core.Response addHeaders(javax.ws.rs.core.Response.ResponseBuilder response,
                                               String fileName)