BulkUploadResource (ice 5.3.1 API)

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

@Path(value="/uploads")
public class BulkUploadResource
extends RestResource

Rest API for interacting with bulk upload resources

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

BulkUploadResource()

Constructors
Constructor and Description
`BulkUploadResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addPermission(long id, AccessPermission accessPermission)` Add upload permission
`BulkUploadInfo`	`create(BulkUploadInfo info)`
`javax.ws.rs.core.Response`	`createEntry(long uploadId, PartData data)`
`javax.ws.rs.core.Response`	`deleteEntry(long uploadId, long entryId)`
`javax.ws.rs.core.Response`	`deleteEntryAttachment(long uploadId, long entryId)`
`javax.ws.rs.core.Response`	`deleteEntrySequence(long uploadId, long entryId)`
`javax.ws.rs.core.Response`	`getPartNumbersForUpload(EntryType uploadType, String token, int limit)` Retrieves matching part numbers to be linked to entries in a bulk upload
`javax.ws.rs.core.Response`	`getPendingUploads()`
`javax.ws.rs.core.Response`	`getUploadPermissions(long id)` Retrieves permissions associated with an upload
`javax.ws.rs.core.Response`	`post(InputStream fileInputStream, String type, org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)`
`ArrayList<BulkUploadInfo>`	`query()`
`BulkUploadInfo`	`read(long id, int offset, int limit)` Retrieves specified bulk upload resource including
`javax.ws.rs.core.Response`	`removePermission(long id, long permissionId)`
`javax.ws.rs.core.Response`	`updateEntry(long uploadId, long entryId, PartData data)`
`BulkUploadInfo`	`updateList(long id, BulkUploadInfo info)` Creates or updates a list of entries that are to be associated with the specified bulk upload
`javax.ws.rs.core.Response`	`updateName(long id, BulkUploadInfo info)`
`javax.ws.rs.core.Response`	`updateStatus(long id, BulkUploadInfo info)` Updates the status of the bulk upload
`javax.ws.rs.core.Response`	`uploadAttachmentFile(long uploadId, InputStream fileInputStream, long entryId, org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)`
`javax.ws.rs.core.Response`	`uploadSequenceFile(long uploadId, InputStream fileInputStream, long entryId, org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)`

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

Method Detail

read

@GET
 @Produces(value="application/json")
 @Path(value="/{id}")
public BulkUploadInfo read(@PathParam(value="id")
                                                                                           long id,
                                                                                           @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                           int offset,
                                                                                           @DefaultValue(value="50") @QueryParam(value="limit")
                                                                                           int limit)

Retrieves specified bulk upload resource including

Parameters:: id -; offset -; limit -
Returns:: model object for bulk upload

getPartNumbersForUpload

@GET
 @Produces(value="application/json")
 @Path(value="/partNumbers")
public javax.ws.rs.core.Response getPartNumbersForUpload(@QueryParam(value="type")
                                                                                                                                EntryType uploadType,
                                                                                                                                @QueryParam(value="token")
                                                                                                                                String token,
                                                                                                                                @DefaultValue(value="8") @QueryParam(value="limit")
                                                                                                                                int limit)

Retrieves matching part numbers to be linked to entries in a bulk upload

Returns:: list of matching part numbers based on passed parameters

getUploadPermissions

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

Retrieves permissions associated with an upload

Parameters:: id - unique identifier for the upload
Returns:: retrieved permissions for specified upload if user has required permissions

addPermission

@POST
 @Path(value="/{id}/permissions")
public javax.ws.rs.core.Response addPermission(@PathParam(value="id")
                                                                                       long id,
                                                                                       AccessPermission accessPermission)

Add upload permission

Parameters:: id - unique identifier for the upload; accessPermission - model object for permissions applied to upload
Returns:: Response with the added permission

removePermission

@DELETE
 @Path(value="/{id}/permissions/{pid}")
public javax.ws.rs.core.Response removePermission(@PathParam(value="id")
                                                                                                  long id,
                                                                                                  @PathParam(value="pid")
                                                                                                  long permissionId)

Parameters:: id -; permissionId -
Returns:: Response with success or failure of permissions delete

uploadSequenceFile

@POST
 @Path(value="/{id}/sequence")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadSequenceFile(@PathParam(value="id")
                                                                                                                                                                      long uploadId,
                                                                                                                                                                      InputStream fileInputStream,
                                                                                                                                                                      long entryId,
                                                                                                                                                                      org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)

uploadAttachmentFile

@POST
 @Path(value="/{id}/attachment")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
public javax.ws.rs.core.Response uploadAttachmentFile(@PathParam(value="id")
                                                                                                                                                                          long uploadId,
                                                                                                                                                                          InputStream fileInputStream,
                                                                                                                                                                          long entryId,
                                                                                                                                                                          org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)

updateList

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}")
public BulkUploadInfo updateList(@PathParam(value="id")
                                                                                                 long id,
                                                                                                 BulkUploadInfo info)

Creates or updates a list of entries that are to be associated with the specified bulk upload

Parameters:: id -; info -
Returns:: wrapper around list of created or updated entries

getPendingUploads

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

Returns:: Response with pending upload information

updateName

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}/name")
public javax.ws.rs.core.Response updateName(@PathParam(value="id")
                                                                                                                 long id,
                                                                                                                 BulkUploadInfo info)

Parameters:: id -; info -
Returns:: Response with upload information on renamed upload

updateStatus

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}/status")
public javax.ws.rs.core.Response updateStatus(@PathParam(value="id")
                                                                                                                     long id,
                                                                                                                     BulkUploadInfo info)

Updates the status of the bulk upload

Parameters:: id - unique identifier of bulk upload whose status is to be updated; info -
Returns:

createEntry

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}/entry")
public javax.ws.rs.core.Response createEntry(@PathParam(value="id")
                                                                                                                   long uploadId,
                                                                                                                   PartData data)

Parameters:: uploadId -; data -
Returns:: Response with created part data

updateEntry

@POST
 @Produces(value="application/json")
 @Path(value="/{id}/entry/{entryId}")
public javax.ws.rs.core.Response updateEntry(@PathParam(value="id")
                                                                                                                              long uploadId,
                                                                                                                              @PathParam(value="entryId")
                                                                                                                              long entryId,
                                                                                                                              PartData data)

Parameters:: uploadId -; entryId -; data -
Returns:: Response with updated part data

create

@PUT
 @Produces(value="application/json")
public BulkUploadInfo create(BulkUploadInfo info)

Parameters:: info -
Returns:: a bulk upload info object

query

@GET
 @Produces(value="application/json")
public ArrayList<BulkUploadInfo> query()

Returns:: all bulk uploads for the current user

post

@POST
 @Path(value="file")
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
public javax.ws.rs.core.Response post(InputStream fileInputStream,
                                                                                                                                              String type,
                                                                                                                                              org.glassfish.jersey.media.multipart.FormDataContentDisposition contentDispositionHeader)

Returns:: Response with the id of the imported bulk upload

deleteEntry

@DELETE
 @Produces(value="application/json")
 @Path(value="/{id}/entry/{entryId}")
public javax.ws.rs.core.Response deleteEntry(@PathParam(value="id")
                                                                                                                                long uploadId,
                                                                                                                                @PathParam(value="entryId")
                                                                                                                                long entryId)

deleteEntrySequence

@DELETE
 @Produces(value="application/json")
 @Path(value="/{id}/entry/{entryId}/sequence")
public javax.ws.rs.core.Response deleteEntrySequence(@PathParam(value="id")
                                                                                                                                                 long uploadId,
                                                                                                                                                 @PathParam(value="entryId")
                                                                                                                                                 long entryId)

Parameters:: uploadId -; entryId -
Returns:: OK response if sequence is deleted

deleteEntryAttachment

@DELETE
 @Produces(value="application/json")
 @Path(value="/{id}/entry/{entryId}/attachment")
public javax.ws.rs.core.Response deleteEntryAttachment(@PathParam(value="id")
                                                                                                                                                     long uploadId,
                                                                                                                                                     @PathParam(value="entryId")
                                                                                                                                                     long entryId)

Parameters:: uploadId -; entryId -
Returns:: OK response if attachment is deleted

Class BulkUploadResource

Field Summary

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

Constructor Summary