org.jbei.ice.services.rest

Class WebResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.WebResource

@Path(value="/web")
public class WebResource
extends RestResource

Resource for web of registries requests

This is particularly useful for third party tools to tap into the web of registries functionality without having specific API keys to each of the instances

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

Method Summary

Modifier and Type	Method and Description
List<AttachmentInfo>	getAttachments(long partnerId, long partId)
javax.ws.rs.core.Response	getStatistics(long partnerId, long entryId)
javax.ws.rs.core.Response	getWebEntries(boolean download, int limit, int offset)
javax.ws.rs.core.Response	getWebEntry(long partnerId, long entryId)
javax.ws.rs.core.Response	getWebEntry(String entryId)
javax.ws.rs.core.Response	getWebEntrySequence(long partnerId, String entryId)
javax.ws.rs.core.Response	getWebEntryTooltip(long partnerId, long entryId)
javax.ws.rs.core.Response	query(boolean approvedOnly) Retrieves information on other ice instances that is in a web of registries configuration with this instance; also know as registry partners
javax.ws.rs.core.Response	remoteWebPartnerRemoveRequest(String worToken, String url)
javax.ws.rs.core.Response	removeWebPartner(String url)
javax.ws.rs.core.Response	searchWebEntries(SearchQuery query, boolean includeLocal)
javax.ws.rs.core.Response	updateWebPartner(String url, RegistryPartner partner)

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

WebResource

public WebResource()

Method Detail

query

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response query(@DefaultValue(value="true") @QueryParam(value="approved_only")
                                                                                 boolean approvedOnly)

Retrieves information on other ice instances that is in a web of registries configuration with this instance; also know as registry partners

Parameters:

approvedOnly - if true, only instances that have been approved are returned; defaults to true

Returns:

wrapper around the list of registry partners

getAttachments

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries/{entryId}/attachments")
public List<AttachmentInfo> getAttachments(@PathParam(value="id")
                                                                                                                                         long partnerId,
                                                                                                                                         @PathParam(value="entryId")
                                                                                                                                         long partId)

getWebEntry

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries/{entryId}")
public javax.ws.rs.core.Response getWebEntry(@PathParam(value="id")
                                                                                                                               long partnerId,
                                                                                                                               @PathParam(value="entryId")
                                                                                                                               long entryId)

getWebEntryTooltip

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries/{entryId}/tooltip")
public javax.ws.rs.core.Response getWebEntryTooltip(@PathParam(value="id")
                                                                                                                                              long partnerId,
                                                                                                                                              @PathParam(value="entryId")
                                                                                                                                              long entryId)

getStatistics

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries/{entryId}/statistics")
public javax.ws.rs.core.Response getStatistics(@PathParam(value="id")
                                                                                                                                            long partnerId,
                                                                                                                                            @PathParam(value="entryId")
                                                                                                                                            long entryId)

getWebEntrySequence

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries/{entryId}/sequence")
public javax.ws.rs.core.Response getWebEntrySequence(@PathParam(value="id")
                                                                                                                                                long partnerId,
                                                                                                                                                @PathParam(value="entryId")
                                                                                                                                                String entryId)

remoteWebPartnerRemoveRequest

@DELETE
 @Path(value="/partner/remote")
public javax.ws.rs.core.Response remoteWebPartnerRemoveRequest(@HeaderParam(value="X-ICE-WOR-Token")
                                                                                                       String worToken,
                                                                                                       @QueryParam(value="url")
                                                                                                       String url)

updateWebPartner

@PUT
 @Path(value="/partner/{url}")
public javax.ws.rs.core.Response updateWebPartner(@PathParam(value="url")
                                                                                      String url,
                                                                                      RegistryPartner partner)

removeWebPartner

@DELETE
 @Path(value="/partner/{url}")
public javax.ws.rs.core.Response removeWebPartner(@PathParam(value="url")
                                                                                         String url)

getWebEntries

@GET
 @Path(value="/entries")
public javax.ws.rs.core.Response getWebEntries(@QueryParam(value="download")
                                                                             boolean download,
                                                                             @QueryParam(value="limit")
                                                                             int limit,
                                                                             @QueryParam(value="offset")
                                                                             int offset)

searchWebEntries

@POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/entries")
public javax.ws.rs.core.Response searchWebEntries(SearchQuery query,
                                                                                                                                                           @DefaultValue(value="true") @QueryParam(value="includeLocal")
                                                                                                                                                           boolean includeLocal)

getWebEntry

@GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/entries/{id}")
public javax.ws.rs.core.Response getWebEntry(@PathParam(value="id")
                                                                                                                                                          String entryId)