Package org.gcube.common.storagehubwrapper.server.tohl

Interface Workspace

All Known Implementing Classes:

WorkspaceStorageHubClientService

public interface Workspace

The Interface Workspace.

Author:

Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it) Jun 15, 2018 Represents a HL user workspace.

Method Summary

Modifier and Type	Method	Description
boolean	canUserWriteIntoFolder(String folderId)	Can user write into folder.
WorkspaceItem	copyFile(String itemId, String folderDestinationId)	Copy file.
List<WorkspaceItem>	copyFileItems(List<String> itemIds, String folderDestinationId)	Copy file items.
WorkspaceFolder	createFolder(String name, String description, String destinationFolderId)	Create a new folder with specified name.
WorkspaceFolder	createFolder(String name, String description, String destinationFolderId, Map<String,String> properties)	Create a new folder with properties.
URLItem	createURL(String name, String description, String url, String destinationFolderId)	Creates the URL.
void	deleteItem(String itemId)	Delete item.
ItemStreamDescriptor	downloadFile(String itemId, String fileName, String versionName, String nodeIdsToExclude)	Download file.
ItemStreamDescriptor	downloadFolder(String folderId, String folderName, String nodeIdsToExclude)	Download folder.
void	emptyTrash()	Empty trash.
boolean	exists(String name, String folderId)	Check if an item with the specified name exists in the specified folder.
List<WorkspaceItem>	find(String name, String folderId)	Get an item with the specified name in the specified folder.
List<org.gcube.common.storagehub.model.items.nodes.accounting.AccountEntry>	getAccounting(String itemId)	Gets the accounting.
List<? extends WorkspaceItem>	getChildren(String id)	Gets the children not including the ones marked as hidden.
List<? extends WorkspaceItem>	getChildren(String id, boolean includeHidden)	Gets the children including the ones marked as hidden if the bool param is true.
long	getDiskUsage()	Get the disk usage of a worskpace.
List<? extends WorkspaceItem>	getFilteredChildren(String id, Class<? extends org.gcube.common.storagehub.model.items.Item> aType)	Gets the filtered children.
PropertyMap	getGcubeItemProperties(String gcubeItemId)	Gets the gcube item properties.
WorkspaceItem	getItem(String itemId)	Return the item with the specified id.
WorkspaceItem	getItem(String itemId, boolean withAccounting, boolean withFileDetails, boolean withMapProperties)	Return the item with the specified id.
WorkspaceItem	getItemByPath(String idFolder, String relativePath)
WorkspaceItem	getItemForExplorer(String itemId, boolean withAccounting, boolean withFileDetails, boolean withMapProperties)	Gets the item for Explorer.
List<WorkspaceFileVersion>	getListVersionsForFile(String fileItemId)	Gets the list versions for file.
Map<String,Object>	getMetadata(String itemId)	Gets the metadata.
String	getOwner()	Gets the owner.
List<? extends WorkspaceItem>	getParentsById(String id)	Gets the parents by id.
List<? extends WorkspaceItem>	getParentsForExplorerById(String id)	Gets the parents for explorer by id.
URL	getPublicLinkForFile(String fileItemId)	Gets the public link to the latest version of file item.
URL	getPublicLinkForFile(String fileItemId, String version)	Gets the public link of the file at the input version.
WorkspaceFolder	getRoot()	Returns the workspace root.
WorkspaceItem	getRootSharedFolder(String itemId)	Gets the root shared folder.
List<Member>	getSharedFolderMembers(String folderid)	Gets the shared folder members.
ItemStreamDescriptor	getThumbnailData(String itemId)	Gets the thumbnail data.
long	getTotalItems()	Get the total number of items in a workspace.
WorkspaceItem	getTrash()	Get Trash Folder.
String	getVREFoldersId()	Gets the VRE folders id.
boolean	isItemShared(String itemId)	Checks if is item shared.
WorkspaceItem	moveItem(String itemId, String destinationFolderId)	Move item.
List<WorkspaceItem>	moveItems(List<String> itemIds, String folderDestinationId)	Move items.
Map<String,String>	removeItems(String... id)	Removes the items.
WorkspaceItem	renameItem(String itemId, String newName)	Rename an item.
WorkspaceItem	restoreThrashItem(String itemId, String destinationFolderId)	Restore thrash item.
List<WorkspaceItem>	search(String text, String folderId)	Search.
void	setFolderAsHidden(String folderId, boolean hide)	Sets the Folder As Hidden or visible .
boolean	setFolderAsPublic(String folderId, boolean bool)	Sets the folder as public.
WorkspaceSharedFolder	shareFolder(String folderId, Set<String> users, ACLType type)
WorkspaceSharedFolder	unshareFolder(String folderId, Set<String> users)
String	updateDescriptionForItem(String itemId, String newDescription)	Update description for item.
void	updateMetadata(String itemId, Map<String,Object> mapObjs)	Update metadata.
WorkspaceItem	uploadArchive(String folderId, InputStream is, String extractionFolderName)	Upload archive.
WorkspaceItem	uploadFile(String folderId, InputStream inputStream, String fileName, String fileDescription)	Upload file.

Method Detail

getOwner

String getOwner()
         throws InternalErrorException,
                Exception

Gets the owner.

Returns:

the owner

Throws:

InternalErrorException - the internal error exception

Exception - the exception

getRoot

WorkspaceFolder getRoot()
                 throws InternalErrorException,
                        Exception

Returns the workspace root.

Returns:

the root.

Throws:

InternalErrorException - the internal error exception

Exception - the exception

getChildren

List<? extends WorkspaceItem> getChildren(String id)
                                   throws Exception

Gets the children not including the ones marked as hidden.

Parameters:

id - the id

Returns:

the children

Throws:

Exception - the exception

getChildren

List<? extends WorkspaceItem> getChildren(String id,
                                          boolean includeHidden)
                                   throws Exception

Gets the children including the ones marked as hidden if the bool param is true.

Parameters:

id - the id

hidden - true to return also the hidden ones

Returns:

the children

Throws:

Exception - the exception

getParentsById

List<? extends WorkspaceItem> getParentsById(String id)
                                      throws InternalErrorException,
                                             Exception

Gets the parents by id.

Parameters:

id - the id

Returns:

the parents by id

Throws:

InternalErrorException - the internal error exception

Exception - the exception

getItem

WorkspaceItem getItem(String itemId)
               throws ItemNotFoundException,
                      InternalErrorException,
                      Exception

Return the item with the specified id.

Parameters:

itemId - the item id.

Returns:

the item.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - the internal error exception

Exception - the exception

getItem

WorkspaceItem getItem(String itemId,
                      boolean withAccounting,
                      boolean withFileDetails,
                      boolean withMapProperties)
               throws ItemNotFoundException,
                      InternalErrorException,
                      Exception

Return the item with the specified id.

Parameters:

itemId - the item id.

withAccounting - the with accounting

withFileDetails - the with file details

withMapProperties - the with map properties

Returns:

the item.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - the internal error exception

Exception - the exception

getItemByPath

WorkspaceItem getItemByPath(String idFolder,
                            String relativePath)
                     throws ItemNotFoundException,
                            InternalErrorException,
                            Exception

Parameters:

idFolder -

relativePath -

Returns:

the item.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - the internal error exception

Exception - the exception

createFolder

WorkspaceFolder createFolder(String name,
                             String description,
                             String destinationFolderId)
                      throws InternalErrorException,
                             InsufficientPrivilegesException,
                             ItemAlreadyExistException,
                             WrongDestinationException,
                             ItemNotFoundException,
                             WorkspaceFolderNotFoundException,
                             Exception

Create a new folder with specified name. The new folder is created into the specified folder.

Parameters:

name - the folder name.

description - the folder description.

destinationFolderId - the destination folder.

Returns:

the new folder.

Throws:

InternalErrorException - if an internal error occurs.

InsufficientPrivilegesException - if the user don't have sufficient privileges to perform this operation.

ItemAlreadyExistException - if an item with the same exist in the destination folder.

WrongDestinationException - if the destination item is not a folder.

ItemNotFoundException - if the destination folder has not been found.

WorkspaceFolderNotFoundException - if the destination folder has not been found.

Exception - the exception

createFolder

WorkspaceFolder createFolder(String name,
                             String description,
                             String destinationFolderId,
                             Map<String,String> properties)
                      throws InternalErrorException,
                             InsufficientPrivilegesException,
                             ItemAlreadyExistException,
                             WrongDestinationException,
                             ItemNotFoundException,
                             WorkspaceFolderNotFoundException

Create a new folder with properties.

Parameters:

name - the name

description - the description

destinationFolderId - the destination folder id

properties - the properties

Returns:

the new folder

Throws:

InternalErrorException - the internal error exception

InsufficientPrivilegesException - the insufficient privileges exception

ItemAlreadyExistException - the item already exist exception

WrongDestinationException - the wrong destination exception

ItemNotFoundException - the item not found exception

WorkspaceFolderNotFoundException - the workspace folder not found exception

uploadFile

WorkspaceItem uploadFile(String folderId,
                         InputStream inputStream,
                         String fileName,
                         String fileDescription)
                  throws Exception

Upload file.

Parameters:

folderId - the folder id

inputStream - the input stream

fileName - the file name

fileDescription - the file description

Returns:

the workspace item

Throws:

Exception - the exception

getSharedFolderMembers

List<Member> getSharedFolderMembers(String folderid)
                             throws Exception

Gets the shared folder members.

Parameters:

folderid - the folderid

Returns:

the shared folder members

Throws:

Exception - the exception

exists

boolean exists(String name,
               String folderId)
        throws InternalErrorException,
               ItemNotFoundException,
               WrongItemTypeException

Check if an item with the specified name exists in the specified folder.

Parameters:

name - the name to check.

folderId - the folder where to search the item.

Returns:

true if the item exists, false otherwise.

Throws:

InternalErrorException - if an error occurs.

ItemNotFoundException - if the folder has not been found.

WrongItemTypeException - if the folderId referrer to an item with type different from Workspace or folder.

find

List<WorkspaceItem> find(String name,
                         String folderId)
                  throws InternalErrorException,
                         ItemNotFoundException,
                         WrongItemTypeException

Get an item with the specified name in the specified folder.

Parameters:

name - the item name to find.

folderId - the folder where to search the item.

Returns:

the item if the item is found, null otherwise.

Throws:

InternalErrorException - if an error occurs.

ItemNotFoundException - if the folder has not been found.

WrongItemTypeException - if the folderId referrer to an item with type different from Workspace or folder.

getRootSharedFolder

WorkspaceItem getRootSharedFolder(String itemId)
                           throws Exception

Gets the root shared folder.

Parameters:

itemId - the item id

Returns:

the root shared folder

Throws:

Exception - the exception

isItemShared

boolean isItemShared(String itemId)
              throws Exception

Checks if is item shared.

Parameters:

itemId - the item id

Returns:

true, if is item shared

Throws:

Exception - the exception

getVREFoldersId

String getVREFoldersId()
                throws Exception

Gets the VRE folders id.

Returns:

the VRE folders id

Throws:

Exception - the exception

getTrash

WorkspaceItem getTrash()
                throws InternalErrorException,
                       ItemNotFoundException,
                       Exception

Get Trash Folder.

Returns:

the trash folder

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

Exception - the exception

emptyTrash

void emptyTrash()
         throws Exception

Empty trash.

Throws:

Exception - the exception

restoreThrashItem

WorkspaceItem restoreThrashItem(String itemId,
                                String destinationFolderId)
                         throws Exception

Restore thrash item.

Parameters:

itemId - the item id

destinationFolderId - the destination folder id

Returns:

the workspace item

Throws:

Exception - the exception

getFilteredChildren

List<? extends WorkspaceItem> getFilteredChildren(String id,
                                                  Class<? extends org.gcube.common.storagehub.model.items.Item> aType)
                                           throws Exception

Gets the filtered children.

Parameters:

id - the id

aType - the a type

Returns:

the filtered children

Throws:

Exception - the exception

renameItem

WorkspaceItem renameItem(String itemId,
                         String newName)
                  throws ItemNotFoundException,
                         InternalErrorException,
                         ItemAlreadyExistException,
                         InsufficientPrivilegesException,
                         Exception

Rename an item.

Parameters:

itemId - the item id.

newName - the new name.

Returns:

the workspace item

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if the user don't have sufficient privileges to perform this operation.

InsufficientPrivilegesException - the insufficient privileges exception

Exception - the exception

getPublicLinkForFile

URL getPublicLinkForFile(String fileItemId)
                  throws Exception

Gets the public link to the latest version of file item.

Parameters:

fileItemId - the file item id

Returns:

the public link for file

Throws:

Exception - the exception

getPublicLinkForFile

URL getPublicLinkForFile(String fileItemId,
                         String version)
                  throws Exception

Gets the public link of the file at the input version.

Parameters:

fileItemId - the file item id

version - the version

Returns:

the public link for file

Throws:

Exception - the exception

getListVersionsForFile

List<WorkspaceFileVersion> getListVersionsForFile(String fileItemId)
                                           throws Exception

Gets the list versions for file.

Parameters:

fileItemId - the file item id

Returns:

the list versions for file

Throws:

Exception - the exception

getThumbnailData

ItemStreamDescriptor getThumbnailData(String itemId)
                               throws Exception

Gets the thumbnail data.

Parameters:

itemId - the item id

Returns:

the thumbnail data

Throws:

Exception - the exception

getMetadata

Map<String,Object> getMetadata(String itemId)
                              throws Exception

Gets the metadata.

Parameters:

itemId - the item id

Returns:

the metadata

Throws:

Exception - the exception

getDiskUsage

long getDiskUsage()
           throws Exception

Get the disk usage of a worskpace.

Returns:

the disk usage

Throws:

Exception - the exception

getTotalItems

long getTotalItems()
            throws Exception

Get the total number of items in a workspace.

Returns:

the numer of total Items

Throws:

Exception - the exception

getAccounting

List<org.gcube.common.storagehub.model.items.nodes.accounting.AccountEntry> getAccounting(String itemId)
                                                                                   throws Exception

Gets the accounting.

Parameters:

itemId - the item id

Returns:

the accounting

Throws:

Exception - the exception

getGcubeItemProperties

PropertyMap getGcubeItemProperties(String gcubeItemId)
                            throws Exception

Gets the gcube item properties.

Parameters:

gcubeItemId - the gcube item id

Returns:

the gcube item properties

Throws:

Exception - the exception

updateMetadata

void updateMetadata(String itemId,
                    Map<String,Object> mapObjs)
             throws Exception

Update metadata.

Parameters:

itemId - the item id

mapObjs - the map objs

Throws:

Exception - the exception

createURL

URLItem createURL(String name,
                  String description,
                  String url,
                  String destinationFolderId)
           throws Exception

Creates the URL.

Parameters:

name - the name

description - the description

url - the url

destinationFolderId - the destination folder id

Returns:

the URL file item

Throws:

Exception - the exception

setFolderAsPublic

boolean setFolderAsPublic(String folderId,
                          boolean bool)
                   throws Exception

Sets the folder as public.

Parameters:

folderId - the folder id

bool - the bool

Returns:

the new folder status (public or private)

Throws:

Exception - the exception

moveItems

List<WorkspaceItem> moveItems(List<String> itemIds,
                              String folderDestinationId)
                       throws ItemNotFoundException,
                              WrongDestinationException,
                              InsufficientPrivilegesException,
                              InternalErrorException,
                              ItemAlreadyExistException,
                              Exception

Move items.

Parameters:

itemIds - the item ids

folderDestinationId - the folder destination id

Returns:

the list

Throws:

ItemNotFoundException - the item not found exception

WrongDestinationException - the wrong destination exception

InsufficientPrivilegesException - the insufficient privileges exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

Exception - the exception

deleteItem

void deleteItem(String itemId)
         throws ItemNotFoundException,
                InternalErrorException,
                InsufficientPrivilegesException,
                Exception

Delete item.

Parameters:

itemId - the item id

Throws:

ItemNotFoundException - the item not found exception

InternalErrorException - the internal error exception

InsufficientPrivilegesException - the insufficient privileges exception

Exception - the exception

moveItem

WorkspaceItem moveItem(String itemId,
                       String destinationFolderId)
                throws ItemNotFoundException,
                       WrongDestinationException,
                       InsufficientPrivilegesException,
                       InternalErrorException,
                       ItemAlreadyExistException,
                       WorkspaceFolderNotFoundException,
                       Exception

Move item.

Parameters:

itemId - the item id

destinationFolderId - the destination folder id

Returns:

the workspace item

Throws:

ItemNotFoundException - the item not found exception

WrongDestinationException - the wrong destination exception

InsufficientPrivilegesException - the insufficient privileges exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

WorkspaceFolderNotFoundException - the workspace folder not found exception

Exception - the exception

copyFile

WorkspaceItem copyFile(String itemId,
                       String folderDestinationId)
                throws ItemNotFoundException,
                       WrongDestinationException,
                       InternalErrorException,
                       ItemAlreadyExistException,
                       InsufficientPrivilegesException,
                       Exception

Copy file.

Parameters:

itemId - the item id

folderDestinationId - the folder destination id

Returns:

the list

Throws:

ItemNotFoundException - the item not found exception

WrongDestinationException - the wrong destination exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

InsufficientPrivilegesException - the insufficient privileges exception

Exception - the exception

copyFileItems

List<WorkspaceItem> copyFileItems(List<String> itemIds,
                                  String folderDestinationId)
                           throws ItemNotFoundException,
                                  WrongDestinationException,
                                  InternalErrorException,
                                  ItemAlreadyExistException,
                                  InsufficientPrivilegesException,
                                  Exception

Copy file items.

Parameters:

itemIds - the item ids

folderDestinationId - the folder destination id

Returns:

the list

Throws:

ItemNotFoundException - the item not found exception

WrongDestinationException - the wrong destination exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

InsufficientPrivilegesException - the insufficient privileges exception

Exception - the exception

canUserWriteIntoFolder

boolean canUserWriteIntoFolder(String folderId)
                        throws Exception

Can user write into folder.

Parameters:

folderId - the folder id

Returns:

true, if successful

Throws:

Exception - the exception

search

List<WorkspaceItem> search(String text,
                           String folderId)
                    throws InternalErrorException,
                           ItemNotFoundException,
                           WrongItemTypeException

Search.

Parameters:

text - the text

folderId - the folder id

Returns:

the list

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

WrongItemTypeException - the wrong item type exception

getItemForExplorer

WorkspaceItem getItemForExplorer(String itemId,
                                 boolean withAccounting,
                                 boolean withFileDetails,
                                 boolean withMapProperties)
                          throws ItemNotFoundException,
                                 InternalErrorException,
                                 Exception

Gets the item for Explorer.

Parameters:

itemId - the item id

withAccounting - the with accounting

withFileDetails - the with file details

withMapProperties - the with map properties

Returns:

the item

Throws:

ItemNotFoundException - the item not found exception

InternalErrorException - the internal error exception

Exception - the exception

getParentsForExplorerById

List<? extends WorkspaceItem> getParentsForExplorerById(String id)
                                                 throws InternalErrorException,
                                                        Exception

Gets the parents for explorer by id. This call is the same of WorkspaceStorageHubClientService.getParentsById(String) except to getRoot called inside (to check if a parent is root or not). WorkspaceItem.isRoot() returns always false.

Parameters:

id - the id

Returns:

the parents for explorer by id

Throws:

InternalErrorException - the internal error exception

Exception - the exception

downloadFile

ItemStreamDescriptor downloadFile(String itemId,
                                  String fileName,
                                  String versionName,
                                  String nodeIdsToExclude)
                           throws Exception

Download file.

Parameters:

itemId - the item id

fileName - the file name

versionName - the version name. If is null or empty returns the latest version of file

nodeIdsToExclude - the node ids to exclude

Returns:

the item stream descriptor

Throws:

Exception - the exception

uploadArchive

WorkspaceItem uploadArchive(String folderId,
                            InputStream is,
                            String extractionFolderName)
                     throws Exception

Upload archive.

Parameters:

folderId - the folder id

is - the is

extractionFolderName - the extraction folder name

Returns:

the workspace item

Throws:

Exception - the exception

downloadFolder

ItemStreamDescriptor downloadFolder(String folderId,
                                    String folderName,
                                    String nodeIdsToExclude)
                             throws Exception

Download folder.

Parameters:

folderId - the folder id

folderName - the folder name

nodeIdsToExclude - the node ids to exclude

Returns:

the item stream descriptor

Throws:

Exception - the exception

removeItems

Map<String,String> removeItems(String... id)
                              throws ItemNotFoundException,
                                     InternalErrorException,
                                     InsufficientPrivilegesException

Removes the items.

Parameters:

id - the id

Returns:

the map of errors (id,error)

Throws:

ItemNotFoundException - the item not found exception

InternalErrorException - the internal error exception

InsufficientPrivilegesException - the insufficient privileges exception

updateDescriptionForItem

String updateDescriptionForItem(String itemId,
                                String newDescription)
                         throws Exception

Update description for item.

Parameters:

itemId - the item id

newDescription - the new description

Returns:

the description updated read by SHUB

Throws:

Exception - the exception

setFolderAsHidden

void setFolderAsHidden(String folderId,
                       boolean hide)
                throws Exception

Sets the Folder As Hidden or visible .

Parameters:

folderId - the folder id to set as hidden

hide - true to set hide, false to set visible

Throws:

Exception - the exception

shareFolder

WorkspaceSharedFolder shareFolder(String folderId,
                                  Set<String> users,
                                  ACLType type)
                           throws Exception

Parameters:

folderId - the folder id to share

users - the Set of users to share

type - the permission

Throws:

Exception

unshareFolder

WorkspaceSharedFolder unshareFolder(String folderId,
                                    Set<String> users)
                             throws Exception

Parameters:

folderId - the folder id to share

users - the Set of users to share

type - the permission

Throws:

Exception