PartnerResource (ice 5.3.1 API)

java.lang.Object
- org.jbei.ice.services.rest.RestResource
- - org.jbei.ice.services.rest.PartnerResource

```
@Path(value="/partners")
public class PartnerResource
extends RestResource
```
Resource for interacting with partners in the web of registries configuration with this instance

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

PartnerResource()

Constructors
Constructor and Description
`PartnerResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addNewPartner(RegistryPartner partner)` Adds a remote instance as a registry partner.
`List<AttachmentInfo>`	`getAttachments(long partnerId, long partId)`
`javax.ws.rs.core.Response`	`getPublicFolderEntries(long remoteId, long folderId, int offset, int limit, String sort, boolean asc)`
`javax.ws.rs.core.Response`	`getRemotePartComments(long remoteId, long partId)`
`javax.ws.rs.core.Response`	`getRemotePartSamples(long remoteId, long partId)`
`javax.ws.rs.core.Response`	`getRemoteUser(long remoteId, String email)`
`javax.ws.rs.core.Response`	`getSequence(long remoteId, long partId)`
`javax.ws.rs.core.Response`	`getSequenceTraces(long remoteId, long partId)`
`javax.ws.rs.core.Response`	`getWebEntries(long partnerId, int offset, int limit, String sort, boolean asc)` Retrieves entries for specified partner using the specified paging parameters
`javax.ws.rs.core.Response`	`getWebEntryTooltip(long partnerId, long entryId)`
`javax.ws.rs.core.Response`	`getWebPartner(String partnerId)` Retrieve details about a specific partner
`javax.ws.rs.core.Response`	`getWebPartners()` Retrieves list of available web partners requested by user or an ICE instance
`javax.ws.rs.core.Response`	`readRemoteUser(long remoteId)` Retrieves available folders from the specified remote ice partner
`javax.ws.rs.core.Response`	`removeWebPartner(String partnerId)`
`javax.ws.rs.core.Response`	`transferEntries(long remoteId, EntrySelection entrySelection)` Schedules a task to transfer a list of entries (explicit or context for generating them) to a specified partner
`javax.ws.rs.core.Response`	`updateRemotePartnerAPIKey(RegistryPartner partner)` Request from a remote ICE instance to update it's api key Verification uses the existing API key.
`javax.ws.rs.core.Response`	`updateWebPartner(long partnerId, RegistryPartner partner)`
`javax.ws.rs.core.Response`	`updateWebPartnerAPIKey(long partnerId)`

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
- PartnerResource
```
public PartnerResource()
```

Method Detail

getWebPartner

@GET
 @Path(value="{id}")
public javax.ws.rs.core.Response getWebPartner(@PathParam(value="id")
                                                                         String partnerId)

Retrieve details about a specific partner

Parameters:: partnerId - unique partner identifier (either the database id or the url)
Returns:: details about the partner if found

getWebPartners
```
@GET
public javax.ws.rs.core.Response getWebPartners()
```
Retrieves list of available web partners requested by user or an ICE instance

Returns:

list of partners

addNewPartner
```
@POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addNewPartner(RegistryPartner partner)
```
Adds a remote instance as a registry partner. There are two entry points for this call within ICE. One is from the web of registries task. This does not contain any authentication information and therefore requires verification of the token.
The second is from the admin ui where a partner is manually added to this ice instance.

Parameters:

partner - details about the partner to add

transferEntries

@POST
 @Path(value="/{id}/entries")
public javax.ws.rs.core.Response transferEntries(@PathParam(value="id")
                                                                                     long remoteId,
                                                                                     EntrySelection entrySelection)

Schedules a task to transfer a list of entries (explicit or context for generating them) to a specified partner

Parameters:: remoteId - unique partner identifier; entrySelection - set of entries to transfer or context used to generate entries

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)

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)

updateWebPartner

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

updateWebPartnerAPIKey

@PUT
 @Path(value="/{id}/apiKey")
public javax.ws.rs.core.Response updateWebPartnerAPIKey(@PathParam(value="id")
                                                                                          long partnerId)

updateRemotePartnerAPIKey
```
@PUT
public javax.ws.rs.core.Response updateRemotePartnerAPIKey(RegistryPartner partner)
```
Request from a remote ICE instance to update it's api key Verification uses the existing API key. Similar to updating password by sending the old password

Parameters:

partner - remote partner information (including new api key)

Returns:

information about this instance with the new token remote partner

removeWebPartner

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

readRemoteUser

@GET
 @Produces(value="application/json")
 @Path(value="{id}/available")
public javax.ws.rs.core.Response readRemoteUser(@PathParam(value="id")
                                                                                                                         long remoteId)

Retrieves available folders from the specified remote ice partner

Parameters:: remoteId - unique identifier for remote partner being accessed

getRemoteUser

@GET
 @Produces(value="application/json")
 @Path(value="{id}/users/{email}")
public javax.ws.rs.core.Response getRemoteUser(@PathParam(value="id")
                                                                                                                            long remoteId,
                                                                                                                            @PathParam(value="email")
                                                                                                                            String email)

getSequence

@GET
 @Produces(value="application/json")
 @Path(value="{id}/{entryId}/sequence")
public javax.ws.rs.core.Response getSequence(@PathParam(value="id")
                                                                                                                               long remoteId,
                                                                                                                               @PathParam(value="entryId")
                                                                                                                               long partId)

Returns:: sequence from remote ICE

getSequenceTraces

@GET
 @Produces(value="application/json")
 @Path(value="{id}/parts/{entryId}/traces")
public javax.ws.rs.core.Response getSequenceTraces(@PathParam(value="id")
                                                                                                                                         long remoteId,
                                                                                                                                         @PathParam(value="entryId")
                                                                                                                                         long partId)

Returns:: traces from remote ICE

getPublicFolderEntries

@GET
 @Produces(value="application/json")
 @Path(value="{id}/folders/{folderId}")
public javax.ws.rs.core.Response getPublicFolderEntries(@PathParam(value="id")
                                                                                                                                          long remoteId,
                                                                                                                                          @PathParam(value="folderId")
                                                                                                                                          long folderId,
                                                                                                                                          @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                                          int offset,
                                                                                                                                          @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                                                                          int limit,
                                                                                                                                          @DefaultValue(value="created") @QueryParam(value="sort")
                                                                                                                                          String sort,
                                                                                                                                          @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                                                                          boolean asc)

Returns:: public folders from remote ICE

getRemotePartSamples

@GET
 @Produces(value="application/json")
 @Path(value="/parts/{partId}/samples")
public javax.ws.rs.core.Response getRemotePartSamples(@PathParam(value="id")
                                                                                                                                        long remoteId,
                                                                                                                                        @PathParam(value="partId")
                                                                                                                                        long partId)

Returns:: part samples from remote ICE

getRemotePartComments

@GET
 @Produces(value="application/json")
 @Path(value="{id}/parts/{partId}/comments")
public javax.ws.rs.core.Response getRemotePartComments(@PathParam(value="id")
                                                                                                                                              long remoteId,
                                                                                                                                              @PathParam(value="partId")
                                                                                                                                              long partId)

Returns:: comments from remote ICE

getWebEntries

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries")
public javax.ws.rs.core.Response getWebEntries(@PathParam(value="id")
                                                                                                                       long partnerId,
                                                                                                                       @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                       int offset,
                                                                                                                       @DefaultValue(value="15") @QueryParam(value="limit")
                                                                                                                       int limit,
                                                                                                                       @DefaultValue(value="created") @QueryParam(value="sort")
                                                                                                                       String sort,
                                                                                                                       @DefaultValue(value="false") @QueryParam(value="asc")
                                                                                                                       boolean asc)

Retrieves entries for specified partner using the specified paging parameters

Parameters:: partnerId - unique identifier for registry partner whose entries are being retrieved; offset - record retrieve offset paging parameter; limit - maximum number of entries to retrieve; sort - field to sort on; asc - sort order
Returns:: Response with public entries from registry partners

Class PartnerResource

Field Summary

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

Constructor Summary