org.gcube.common.storagehubwrapper.server

Class WorkspaceStorageHubClientService

java.lang.Object

org.gcube.common.storagehubwrapper.server.WorkspaceStorageHubClientService

All Implemented Interfaces:

Workspace

public final class WorkspaceStorageHubClientService
extends Object
implements Workspace

The Class WorkspaceStorageHubClientService.

Author:

Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it) Jun 20, 2018

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkspaceStorageHubClientService.WorkspaceStorageHubClientServiceBuilder The Class WorkspaceStorageHubClientServiceBuilder.

Method Summary

Modifier and Type	Method and Description
boolean	canUserWriteIntoFolder(String folderId) Can user write into folder.
void	changeDescription(String itemId, String newDescription) Change an item description.
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.
WorkspaceItem	createGcubeItem(String name, String description, List<String> scopes, String creator, String itemType, Map<String,String> properties, String destinationFolderId) Create a GCubeItem.
WorkspaceSharedFolder	createSharedFolder(String name, String description, List<String> users, String destinationFolderId) Create a shared folder with a list of users.
URLItem	createURL(String fileName, String fileDescription, String url, String destinationFolderId) Creates the URL.
WorkspaceVREFolder	createVREFolder(String scope, String description, String displayName, ACLType privilege) Create a VRE folder.
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.
long	getDiskUsage() Gets the disk usage.
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.
List<WorkspaceFileVersion>	getListVersionsForFile(String fileItemId) Gets the list versions for file.
Map<String,Object>	getMetadata(String itemId) Gets the metadata.
WorkspaceFolder	getMySpecialFolders() Get MySpecialFolders.
String	getOwner() Gets the owner.
List<? extends WorkspaceItem>	getParentsById(String id) Gets the parents by id.
List<WorkspaceItem>	getPublicFolders() Get public folders.
URL	getPublicLinkForFile(String fileItemId) Gets the public link for file.
URL	getPublicLinkForFile(String fileItemId, String version) Gets the public link for file.
WorkspaceFolder	getRoot() Returns the workspace root.
WorkspaceItem	getRootSharedFolder(String itemId) Gets the root shared folder.
List<String>	getSharedFolderMembers(String folderId) Gets the shared folder members.
StorageHubClientService	getStorageHubClientService() Gets the storage hub client service.
ItemStreamDescriptor	getThumbnailData(String itemId) Gets the thumbnail data.
long	getTotalItems() Gets the total items.
WorkspaceItem	getTrash() Get Trash Folder.
String	getVREFoldersId() Gets the VRE folders id.
boolean	isItemShared(String itemId) Checks if is item shared.
boolean	isWithAccounting() Checks if is with accounting.
boolean	isWithFileDetails() Checks if is with file details.
boolean	isWithMapProperties() Checks if is with map properties.
WorkspaceItem	moveItem(String itemId, String folderDestinationId) 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) Restore thrash item.
List<WorkspaceItem>	searchByMimeType(String mimeType) Search By MimeType.
List<WorkspaceItem>	searchByProperties(List<String> properties) Search By Properties.
boolean	setFolderAsPublic(String folderId, boolean setPublic) Sets the folder as public.
WorkspaceSharedFolder	share(List<String> users, String itemId) Shared an exist WorkspaceFolder with a list of users.
WorkspaceSharedFolder	shareFolder(List<String> users, String destinationFolderId) Shared an exist WorkspaceFolder with a list of users.
WorkspaceItem	unshare(String itemId) Unshare a shared 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 is, String fileName, String fileDescription) Upload file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStorageHubClientService

public StorageHubClientService getStorageHubClientService()

Gets the storage hub client service.

Returns:

the storageHubClientService

isWithAccounting

public boolean isWithAccounting()

Checks if is with accounting.

Returns:

the withAccounting

isWithFileDetails

public boolean isWithFileDetails()

Checks if is with file details.

Returns:

the withFileDetails

isWithMapProperties

public boolean isWithMapProperties()

Checks if is with map properties.

Returns:

the withMapProperties

getOwner

public String getOwner()
                throws InternalErrorException,
                       Exception

Description copied from interface: Workspace

Gets the owner.

Specified by:

getOwner in interface Workspace

Returns:

the owner

Throws:

InternalErrorException - the internal error exception

Exception - the exception

getRoot

public WorkspaceFolder getRoot()
                        throws InternalErrorException,
                               Exception

Description copied from interface: Workspace

Returns the workspace root.

Specified by:

getRoot in interface Workspace

Returns:

the root.

Throws:

InternalErrorException - the internal error exception

Exception - the exception

getChildren

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

Description copied from interface: Workspace

Gets the children.

Specified by:

getChildren in interface Workspace

Parameters:

id - the id

Returns:

the children

Throws:

Exception - the exception

getFilteredChildren

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

Description copied from interface: Workspace

Gets the filtered children.

Specified by:

getFilteredChildren in interface Workspace

Parameters:

id - the id

aType - the a type

Returns:

the filtered children

Throws:

Exception - the exception

getParentsById

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

Description copied from interface: Workspace

Gets the parents by id.

Specified by:

getParentsById in interface Workspace

Parameters:

id - the id

Returns:

the parents by id

Throws:

InternalErrorException - the internal error exception

Exception - the exception

createFolder

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

Description copied from interface: Workspace

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

Specified by:

createFolder in interface Workspace

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.

getItem

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

Description copied from interface: Workspace

Return the item with the specified id.

Specified by:

getItem in interface Workspace

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

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

Description copied from interface: Workspace

Return the item with the specified id.

Specified by:

getItem in interface Workspace

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

createFolder

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

Description copied from interface: Workspace

Create a new folder with properties.

Specified by:

createFolder in interface Workspace

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

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

Description copied from interface: Workspace

Upload file.

Specified by:

uploadFile in interface Workspace

Parameters:

folderId - the folder id

is - the input stream

fileName - the file name

fileDescription - the file description

Returns:

the workspace item

Throws:

Exception - the exception

getSharedFolderMembers

public List<String> getSharedFolderMembers(String folderId)
                                    throws Exception

Description copied from interface: Workspace

Gets the shared folder members.

Specified by:

getSharedFolderMembers in interface Workspace

Parameters:

folderId - the folderid

Returns:

the shared folder members

Throws:

Exception - the exception

exists

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

Description copied from interface: Workspace

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

Specified by:

exists in interface Workspace

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

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

Description copied from interface: Workspace

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

Specified by:

find in interface Workspace

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

public WorkspaceItem getRootSharedFolder(String itemId)
                                  throws Exception

Gets the root shared folder.

Specified by:

getRootSharedFolder in interface Workspace

Parameters:

itemId - the item id

Returns:

the root shared folder

Throws:

Exception - the exception

deleteItem

public void deleteItem(String itemId)
                throws Exception

Description copied from interface: Workspace

Delete item.

Specified by:

deleteItem in interface Workspace

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

removeItems

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

Description copied from interface: Workspace

Removes the items.

Specified by:

removeItems in interface Workspace

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

uploadArchive

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

Description copied from interface: Workspace

Upload archive.

Specified by:

uploadArchive in interface Workspace

Parameters:

folderId - the folder id

is - the is

extractionFolderName - the extraction folder name

Returns:

the workspace item

Throws:

Exception - the exception

isItemShared

public boolean isItemShared(String itemId)
                     throws Exception

Checks if is item shared.

Specified by:

isItemShared in interface Workspace

Parameters:

itemId - the item id

Returns:

true, if is item shared

Throws:

Exception - the exception

getVREFoldersId

public String getVREFoldersId()
                       throws Exception

Gets the VRE folders id.

Specified by:

getVREFoldersId in interface Workspace

Returns:

the VRE folders id

Throws:

Exception - the exception

getTrash

public WorkspaceItem getTrash()
                       throws Exception

Description copied from interface: Workspace

Get Trash Folder.

Specified by:

getTrash in interface Workspace

Returns:

the trash folder

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

Exception - the exception

emptyTrash

public void emptyTrash()
                throws Exception

Empty trash.

Specified by:

emptyTrash in interface Workspace

Throws:

Exception - the exception

restoreThrashItem

public WorkspaceItem restoreThrashItem(String itemId)
                                throws Exception

Description copied from interface: Workspace

Restore thrash item.

Specified by:

restoreThrashItem in interface Workspace

Parameters:

itemId - the item id

Returns:

the item

Throws:

Exception - the exception

downloadFile

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

Download file.

Specified by:

downloadFile in interface Workspace

Parameters:

itemId - the item id

fileName - the file name

versionName - the version name

nodeIdsToExclude - the node ids to exclude

Returns:

the file stream descriptor

Throws:

Exception - the exception

downloadFolder

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

Download folder.

Specified by:

downloadFolder in interface Workspace

Parameters:

folderId - the folder id

folderName - the folder name

nodeIdsToExclude - the node ids to exclude

Returns:

the file stream descriptor

Throws:

Exception - the exception

moveItems

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

Description copied from interface: Workspace

Move items.

Specified by:

moveItems in interface Workspace

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

copyFileItems

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

Description copied from interface: Workspace

Copy file items.

Specified by:

copyFileItems in interface Workspace

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

copyFile

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

Description copied from interface: Workspace

Copy file.

Specified by:

copyFile in interface Workspace

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

moveItem

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

Description copied from interface: Workspace

Move item.

Specified by:

moveItem in interface Workspace

Parameters:

itemId - the item id

folderDestinationId - 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

ItemAlreadyExistException - the item already exist exception

InternalErrorException - the internal error exception

WorkspaceFolderNotFoundException - the workspace folder not found exception

Exception - the exception

renameItem

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

Description copied from interface: Workspace

Rename an item.

Specified by:

renameItem in interface Workspace

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

public URL getPublicLinkForFile(String fileItemId)
                         throws Exception

Gets the public link for file.

Specified by:

getPublicLinkForFile in interface Workspace

Parameters:

fileItemId - the file item id

Returns:

the public link for file

Throws:

Exception - the exception

getPublicLinkForFile

public URL getPublicLinkForFile(String fileItemId,
                                String version)
                         throws Exception

Gets the public link for file.

Specified by:

getPublicLinkForFile in interface Workspace

Parameters:

fileItemId - the file item id

version - the version

Returns:

the public link for file

Throws:

Exception - the exception

getListVersionsForFile

public List<WorkspaceFileVersion> getListVersionsForFile(String fileItemId)
                                                  throws Exception

Gets the list versions for file.

Specified by:

getListVersionsForFile in interface Workspace

Parameters:

fileItemId - the file item id

Returns:

the list versions for file

Throws:

Exception - the exception

getThumbnailData

public ItemStreamDescriptor getThumbnailData(String itemId)
                                      throws Exception

Description copied from interface: Workspace

Gets the thumbnail data.

Specified by:

getThumbnailData in interface Workspace

Parameters:

itemId - the item id

Returns:

the thumbnail data

Throws:

Exception - the exception

getMetadata

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

Description copied from interface: Workspace

Gets the metadata.

Specified by:

getMetadata in interface Workspace

Parameters:

itemId - the item id

Returns:

the metadata

Throws:

Exception - the exception

getTotalItems

public long getTotalItems()
                   throws Exception

Gets the total items.

Specified by:

getTotalItems in interface Workspace

Returns:

the total items

Throws:

Exception - the exception

getDiskUsage

public long getDiskUsage()
                  throws Exception

Gets the disk usage.

Specified by:

getDiskUsage in interface Workspace

Returns:

the disk usage

Throws:

Exception - the exception

getAccounting

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

Gets the accounting.

Specified by:

getAccounting in interface Workspace

Parameters:

itemId - the item id

Returns:

the accounting

Throws:

Exception - the exception

getGcubeItemProperties

public PropertyMap getGcubeItemProperties(String gcubeItemId)
                                   throws Exception

Gets the gcube item properties.

Specified by:

getGcubeItemProperties in interface Workspace

Parameters:

gcubeItemId - the gcube item id

Returns:

the gcube item properties

Throws:

Exception - the exception

updateMetadata

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

Description copied from interface: Workspace

Update metadata.

Specified by:

updateMetadata in interface Workspace

Parameters:

itemId - the item id

mapObjs - the map objs

Throws:

Exception - the exception

createURL

public URLItem createURL(String fileName,
                         String fileDescription,
                         String url,
                         String destinationFolderId)
                  throws Exception

Description copied from interface: Workspace

Creates the URL.

Specified by:

createURL in interface Workspace

Parameters:

fileName - the name

fileDescription - the description

url - the url

destinationFolderId - the destination folder id

Returns:

the URL file item

Throws:

Exception - the exception

setFolderAsPublic

public boolean setFolderAsPublic(String folderId,
                                 boolean setPublic)
                          throws Exception

Description copied from interface: Workspace

Sets the folder as public.

Specified by:

setFolderAsPublic in interface Workspace

Parameters:

folderId - the folder id

setPublic - the bool

Returns:

the new folder status (public or private)

Throws:

Exception - the exception

canUserWriteIntoFolder

public boolean canUserWriteIntoFolder(String folderId)
                               throws Exception

Can user write into folder.

Specified by:

canUserWriteIntoFolder in interface Workspace

Parameters:

folderId - the folder id

Returns:

true, if successful

Throws:

Exception - the exception

changeDescription

public void changeDescription(String itemId,
                              String newDescription)
                       throws ItemNotFoundException,
                              InternalErrorException

Description copied from interface: Workspace

Change an item description.

Specified by:

changeDescription in interface Workspace

Parameters:

itemId - the item to update.

newDescription - the new item description.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

searchByMimeType

public List<WorkspaceItem> searchByMimeType(String mimeType)
                                     throws InternalErrorException

Description copied from interface: Workspace

Search By MimeType.

Specified by:

searchByMimeType in interface Workspace

Parameters:

mimeType - the mime type

Returns:

a list of SearchFolderItem

Throws:

InternalErrorException - the internal error exception

createSharedFolder

public WorkspaceSharedFolder createSharedFolder(String name,
                                                String description,
                                                List<String> users,
                                                String destinationFolderId)
                                         throws InternalErrorException,
                                                InsufficientPrivilegesException,
                                                ItemAlreadyExistException,
                                                WrongDestinationException,
                                                ItemNotFoundException,
                                                WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Create a shared folder with a list of users.

Specified by:

createSharedFolder in interface Workspace

Parameters:

name - the name

description - the description

users - A list of portal logins

destinationFolderId - the destination folder id

Returns:

the shared 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

shareFolder

public WorkspaceSharedFolder shareFolder(List<String> users,
                                         String destinationFolderId)
                                  throws InternalErrorException,
                                         InsufficientPrivilegesException,
                                         ItemAlreadyExistException,
                                         WrongDestinationException,
                                         ItemNotFoundException,
                                         WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Shared an exist WorkspaceFolder with a list of users.

Specified by:

shareFolder in interface Workspace

Parameters:

users - A list of portal logins.

destinationFolderId - the destination folder id

Returns:

the shared 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

share

public WorkspaceSharedFolder share(List<String> users,
                                   String itemId)
                            throws InternalErrorException,
                                   InsufficientPrivilegesException,
                                   ItemAlreadyExistException,
                                   WrongDestinationException,
                                   ItemNotFoundException,
                                   WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Shared an exist WorkspaceFolder with a list of users.

Specified by:

share in interface Workspace

Parameters:

users - A list of portal logins.

itemId - the item id

Returns:

the shared 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

createGcubeItem

public WorkspaceItem createGcubeItem(String name,
                                     String description,
                                     List<String> scopes,
                                     String creator,
                                     String itemType,
                                     Map<String,String> properties,
                                     String destinationFolderId)
                              throws InsufficientPrivilegesException,
                                     WorkspaceFolderNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     ItemNotFoundException

Description copied from interface: Workspace

Create a GCubeItem.

Specified by:

createGcubeItem in interface Workspace

Parameters:

name - the name

description - the description

scopes - the scopes

creator - the creator

itemType - the item type

properties - the properties

destinationFolderId - the destination folder id

Returns:

a GCubeItem

Throws:

InsufficientPrivilegesException - the insufficient privileges exception

WorkspaceFolderNotFoundException - the workspace folder not found exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

WrongDestinationException - the wrong destination exception

ItemNotFoundException - the item not found exception

unshare

public WorkspaceItem unshare(String itemId)
                      throws InternalErrorException,
                             ItemNotFoundException

Description copied from interface: Workspace

Unshare a shared item.

Specified by:

unshare in interface Workspace

Parameters:

itemId - the item id

Returns:

the workspace item

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

getMySpecialFolders

public WorkspaceFolder getMySpecialFolders()
                                    throws InternalErrorException,
                                           ItemNotFoundException

Description copied from interface: Workspace

Get MySpecialFolders.

Specified by:

getMySpecialFolders in interface Workspace

Returns:

my special folders

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

searchByProperties

public List<WorkspaceItem> searchByProperties(List<String> properties)
                                       throws InternalErrorException

Description copied from interface: Workspace

Search By Properties.

Specified by:

searchByProperties in interface Workspace

Parameters:

properties - the properties

Returns:

a list of WorkspaceItem

Throws:

InternalErrorException - the internal error exception

createVREFolder

public WorkspaceVREFolder createVREFolder(String scope,
                                          String description,
                                          String displayName,
                                          ACLType privilege)
                                   throws InternalErrorException,
                                          InsufficientPrivilegesException,
                                          ItemAlreadyExistException,
                                          WrongDestinationException,
                                          ItemNotFoundException,
                                          WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Create a VRE folder.

Specified by:

createVREFolder in interface Workspace

Parameters:

scope - the scope

description - the description

displayName - the display name

privilege - the privilege

Returns:

a new VRE 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

getPublicFolders

public List<WorkspaceItem> getPublicFolders()
                                     throws InternalErrorException

Description copied from interface: Workspace

Get public folders.

Specified by:

getPublicFolders in interface Workspace

Returns:

a list of public folder

Throws:

InternalErrorException - the internal error exception