FolderResource (ice 5.3.1 API)

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

```
@Path(value="/folders")
public class FolderResource
extends RestResource
```
Rest resource for dealing with folders. Note that this is different from collections whose api can be found in the CollectionResource class.
Folders are generally contained in collections and can be created and deleted in an ad-hoc manner while collections are a system defined fixed set.

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

FolderResource()

Constructors
Constructor and Description
`FolderResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addPermission(long folderId, AccessPermission permission)` Add new permission to list of permissions for specified folder
`javax.ws.rs.core.Response`	`addSelectedEntriesToFolders(EntrySelection entrySelection, String remoteUserToken, String remoteUserId, long fid)` Adds contents referenced in the `entrySelection` object to the folders also referenced in the same object
`javax.ws.rs.core.Response`	`create(boolean isTransfer, FolderDetails folder)` Creates a new folder with the details specified in the parameter.
`FolderDetails`	`deleteFolder(long folderId, String folderType)` Deletes the specified folder resource
`javax.ws.rs.core.Response`	`disablePublicAccess(long folderId)`
`javax.ws.rs.core.Response`	`enablePublicAccess(long folderId)`
`javax.ws.rs.core.Response`	`getAutoCompleteForAvailableFolders(String val, int limit)`
`javax.ws.rs.core.Response`	`getFolder(long folderId)` Retrieve specified folder resource
`javax.ws.rs.core.Response`	`getFolderPermissions(long folderId)` Retrieves list of permissions available for the specified folder.
`javax.ws.rs.core.Response`	`getFolders()`
`ArrayList<FolderDetails>`	`getPublicFolders()`
`javax.ws.rs.core.Response`	`modifyFolderEntries(long folderId, boolean move, EntrySelection entrySelection)` Modifies the contents of a folder either by removing or moving entries as determined by the `move` parameter
`FolderDetails`	`read(String folderId, int offset, int limit, String sort, boolean asc, String filter, String token, String remoteUserId, List<String> queryParam)` Retrieves the entries for specified folder.
`javax.ws.rs.core.Response`	`removePermission(long folderId, long permissionId)`
`FolderDetails`	`setPermissions(long folderId, ArrayList<AccessPermission> permissions)`
`javax.ws.rs.core.Response`	`update(long folderId, FolderDetails details)` Updates the specified folder resource

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

Method Detail

getAutoCompleteForAvailableFolders

@GET
 @Produces(value="application/json")
 @Path(value="/autocomplete")
public javax.ws.rs.core.Response getAutoCompleteForAvailableFolders(@QueryParam(value="val")
                                                                                                                                            String val,
                                                                                                                                            @DefaultValue(value="8") @QueryParam(value="limit")
                                                                                                                                            int limit)

getFolders

@GET
public javax.ws.rs.core.Response getFolders()

create
```
@POST
 @Produces(value="application/json")
public javax.ws.rs.core.Response create(@DefaultValue(value="false") @QueryParam(value="isTransfer")
                                                                                   boolean isTransfer,
                                                                                   FolderDetails folder)
```
Creates a new folder with the details specified in the parameter. The folder is either created by a user or represents one that is transferred
The default type for the folder is PRIVATE and is owned by the user creating it unless it is transferred

Parameters:

isTransfer - whether the folder being created is a transfer folder or not

folder - details of the folder to create

Returns:

information about the created folder including the unique identifier

getPublicFolders

@GET
 @Path(value="/public")
 @Produces(value="application/json")
public ArrayList<FolderDetails> getPublicFolders()

getFolder

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

Retrieve specified folder resource

Parameters:: folderId - unique folder resource identifier
Returns:: folder specified by resource id, if the user making request has appropriate privileges

update

@PUT
 @Path(value="/{id}")
public javax.ws.rs.core.Response update(@PathParam(value="id")
                                                                   long folderId,
                                                                   FolderDetails details)

Updates the specified folder resource

Parameters:: folderId - resource identifier of folder to be updated; details - details for update

deleteFolder

@DELETE
 @Path(value="/{id}")
public FolderDetails deleteFolder(@PathParam(value="id")
                                                                long folderId,
                                                                @QueryParam(value="type")
                                                                String folderType)

Deletes the specified folder resource

Returns:: the details of the deleted collection

addSelectedEntriesToFolders

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/entries")
public javax.ws.rs.core.Response addSelectedEntriesToFolders(EntrySelection entrySelection,
                                                                                                                                                                     @QueryParam(value="token")
                                                                                                                                                                     String remoteUserToken,
                                                                                                                                                                     @QueryParam(value="userId")
                                                                                                                                                                     String remoteUserId,
                                                                                                                                                                     @QueryParam(value="folderId")
                                                                                                                                                                     long fid)

Adds contents referenced in the entrySelection object to the folders also referenced in the same object

modifyFolderEntries

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="/{id}/entries")
public javax.ws.rs.core.Response modifyFolderEntries(@PathParam(value="id")
                                                                                                                                                                   long folderId,
                                                                                                                                                                   @DefaultValue(value="false") @QueryParam(value="move")
                                                                                                                                                                   boolean move,
                                                                                                                                                                   EntrySelection entrySelection)

Modifies the contents of a folder either by removing or moving entries as determined by the move parameter

Parameters:: folderId - resource identifier for folder whose contents are to be modified; move - whether to move the specified entries or simply remove them from the folder; entrySelection - wrapper around context for modification

read

@GET
 @Produces(value="application/json")
 @Path(value="/{id}/entries")
public FolderDetails read(@PathParam(value="id")
                                                                                                  String 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,
                                                                                                  @DefaultValue(value="") @QueryParam(value="filter")
                                                                                                  String filter,
                                                                                                  @QueryParam(value="token")
                                                                                                  String token,
                                                                                                  @QueryParam(value="userId")
                                                                                                  String remoteUserId,
                                                                                                  @QueryParam(value="fields")
                                                                                                  List<String> queryParam)

Retrieves the entries for specified folder. Handles request from a local client (ui) or from a remote ice instance

Returns:: list of retrieved entries wrapped in folder object

getFolderPermissions

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

Retrieves list of permissions available for the specified folder. This action is restricted to users who have write privileges on the folder

Parameters:: folderId - unique local folder identifier
Returns:: list of permissions for folder

setPermissions

@PUT
 @Produces(value="application/json")
 @Path(value="/{id}/permissions")
public FolderDetails setPermissions(@PathParam(value="id")
                                                                                                                long folderId,
                                                                                                                ArrayList<AccessPermission> permissions)

Returns:: details of the modified collection

addPermission

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

Add new permission to list of permissions for specified folder

Parameters:: folderId - unique local folder identifier; permission - details about access privilege for folder
Returns:: details about access privilege for folder with a local unique identifier which can be used to remove the privilege

removePermission

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

enablePublicAccess

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

disablePublicAccess

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

Class FolderResource

Field Summary

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

Constructor Summary