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
void	changeDescription(String itemId, String newDescription) Change an item description.
WorkspaceItem	copy(String itemId, String destinationFolderId) Copy an item from a folder to another folder.
WorkspaceItem	copy(String itemId, String newName, String destinationFolderId) Copy an item from a folder to another folder.
URLFileItem	createExternalUrl(String name, String description, InputStream url, String destinationfolderId) Create a new External URL into a folder.
URLFileItem	createExternalUrl(String name, String description, String url, String destinationFolderId) Create a new External URL into a folder.
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.
WorkspaceSharedFolder	createSharedFolder(String name, String description, String groupId, String destinationFolderId, String displayName, boolean isVREFolder) Create a shared folder associated with a groupId.
WorkspaceVREFolder	createVREFolder(String scope, String description, String displayName, ACLType privilege) Create a VRE folder.
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<? extends WorkspaceItem>	getChildren(String id) Gets the children.
long	getDiskUsage() Get the disk usage of a worskpace.
List<WorkspaceItem>	getFolderItems(org.gcube.common.storagehub.model.types.GenericItemType type) Get items by type.
String	getGroup(String groupId) Get group name by group id.
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 path) Return the item with the specified path.
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.
WorkspaceFolder	getRoot() Returns the workspace root.
List<String>	getSharedFolderMembers(String folderId) Gets the shared folder members.
StorageHubClientService	getStorageHubClientService() Gets the storage hub client service.
int	getTotalItems() Get the total number of items in a workspace.
WorkspaceTrashItem	getTrash() Get Trash Folder.
WorkspaceSharedFolder	getVREFolderByScope(String scope) Get VRE Folder By Scope.
boolean	isGroup(String groupId) Check if a user is a group.
boolean	isWithAccounting()
boolean	isWithFileDetails()
boolean	isWithMapProperties()
WorkspaceItem	moveItem(String itemId, String destinationFolderId) Move a workspaceItem to a specified destination.
void	remove(String itemName, String folderId) Remove an item from a folder.
void	removeItem(String itemId) Remove an item.
Map<String,String>	removeItems(String... id) Remove a list of items identified by ids.
void	renameItem(String itemId, String newName) Rename an item.
List<WorkspaceItem>	searchByMimeType(String mimeType) Search By MimeType.
List<WorkspaceItem>	searchByName(String name, String folderId) Search by Name.
List<WorkspaceItem>	searchByProperties(List<String> properties) Search By Properties.
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.
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()

Returns:

the withAccounting

isWithFileDetails

public boolean isWithFileDetails()

Returns:

the withFileDetails

isWithMapProperties

public boolean isWithMapProperties()

Returns:

the withMapProperties

getOwner

public String getOwner()
                throws InternalErrorException

Description copied from interface: Workspace

Gets the owner.

Specified by:

getOwner in interface Workspace

Returns:

the owner

Throws:

InternalErrorException - the internal error exception

getRoot

public WorkspaceFolder getRoot()
                        throws InternalErrorException

Description copied from interface: Workspace

Returns the workspace root.

Specified by:

getRoot in interface Workspace

Returns:

the root.

Throws:

InternalErrorException - the internal error exception

getChildren

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

Description copied from interface: Workspace

Gets the children.

Specified by:

getChildren in interface Workspace

Parameters:

id - the id

Returns:

the children

getParentsById

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

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

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

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

getItem

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

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

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 InsufficientPrivilegesException,
                                WorkspaceFolderNotFoundException,
                                InternalErrorException,
                                ItemAlreadyExistException,
                                WrongDestinationException

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 item

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

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.

createExternalUrl

public URLFileItem createExternalUrl(String name,
                                     String description,
                                     String url,
                                     String destinationFolderId)
                              throws InsufficientPrivilegesException,
                                     WorkspaceFolderNotFoundException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     IOException

Description copied from interface: Workspace

Create a new External URL into a folder.

Specified by:

createExternalUrl in interface Workspace

Parameters:

name - the external URL name.

description - the external URL description.

url - the external URL value.

destinationFolderId - the destination folder.

Returns:

the new external URL.

Throws:

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

WorkspaceFolderNotFoundException - if the destination folder has not been found.

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if a folder item with same name already exist.

WrongDestinationException - if the destination type is not a folder.

IOException - Signals that an I/O exception has occurred.

createExternalUrl

public URLFileItem createExternalUrl(String name,
                                     String description,
                                     InputStream url,
                                     String destinationfolderId)
                              throws InsufficientPrivilegesException,
                                     InternalErrorException,
                                     ItemAlreadyExistException,
                                     WrongDestinationException,
                                     WorkspaceFolderNotFoundException,
                                     IOException

Description copied from interface: Workspace

Create a new External URL into a folder.

Specified by:

createExternalUrl in interface Workspace

Parameters:

name - the external URL name.

description - the external URL description.

url - the external URL.

destinationfolderId - the destination folder.

Returns:

the new external URL.

Throws:

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

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if a folder item with same name already exist.

WrongDestinationException - if the destination type is not a folder.

WorkspaceFolderNotFoundException - if the destination folder has not been found.

IOException

removeItem

public void removeItem(String itemId)
                throws ItemNotFoundException,
                       InternalErrorException,
                       InsufficientPrivilegesException

Description copied from interface: Workspace

Remove an item.

Specified by:

removeItem in interface Workspace

Parameters:

itemId - the item to remove.

Throws:

ItemNotFoundException - if the item has not been found.

InternalErrorException - if an internal error occurs.

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

moveItem

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

Description copied from interface: Workspace

Move a workspaceItem to a specified destination.

Specified by:

moveItem in interface Workspace

Parameters:

itemId - the item to move.

destinationFolderId - the destination folder.

Returns:

the moved workspaceItem

Throws:

ItemNotFoundException - if the specified item has not been found.

WrongDestinationException - if the specified destination has not been found.

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

InternalErrorException - if an internal error occurs.

ItemAlreadyExistException - if the destination folder have a children with same name.

WorkspaceFolderNotFoundException - if the destination folder is not found.

renameItem

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

Description copied from interface: Workspace

Rename an item.

Specified by:

renameItem in interface Workspace

Parameters:

itemId - the item id.

newName - the new name.

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

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.

getItemByPath

public WorkspaceItem getItemByPath(String path)
                            throws ItemNotFoundException

Description copied from interface: Workspace

Return the item with the specified path.

Specified by:

getItemByPath in interface Workspace

Parameters:

path - the item path.

Returns:

the item.

Throws:

ItemNotFoundException - if the item has not been found.

remove

public void remove(String itemName,
                   String folderId)
            throws ItemNotFoundException,
                   InternalErrorException,
                   InsufficientPrivilegesException,
                   WrongItemTypeException

Description copied from interface: Workspace

Remove an item from a folder.

Specified by:

remove in interface Workspace

Parameters:

itemName - the item name.

folderId - the folder id.

Throws:

ItemNotFoundException - if the folder has not been found.

InternalErrorException - if an internal error occurs.

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

WrongItemTypeException - if the specified folder is neither a workspace nor a folder.

copy

public WorkspaceItem copy(String itemId,
                          String newName,
                          String destinationFolderId)
                   throws ItemNotFoundException,
                          WrongDestinationException,
                          InternalErrorException,
                          ItemAlreadyExistException,
                          InsufficientPrivilegesException,
                          WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Copy an item from a folder to another folder.

Specified by:

copy in interface Workspace

Parameters:

itemId - the item to copy.

newName - the item new name.

destinationFolderId - the destination folder id.

Returns:

the item copy.

Throws:

ItemNotFoundException - if the item has not been found.

WrongDestinationException - if the destination have a wrong type.

InternalErrorException - if an internal error occurs.

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

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

WorkspaceFolderNotFoundException - if the destination folder has not been found.

copy

public WorkspaceItem copy(String itemId,
                          String destinationFolderId)
                   throws ItemNotFoundException,
                          WrongDestinationException,
                          InternalErrorException,
                          ItemAlreadyExistException,
                          InsufficientPrivilegesException,
                          WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Copy an item from a folder to another folder. The item copy have the same name of the original.

Specified by:

copy in interface Workspace

Parameters:

itemId - the item to copy.

destinationFolderId - the destination folder id, can't be the same of the item (can't have the same name).

Returns:

the item copy.

Throws:

ItemNotFoundException - if the item has not been found.

WrongDestinationException - if the destination have a wrong type.

InternalErrorException - if an internal error occurs.

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

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

WorkspaceFolderNotFoundException - if the destination folder has not been found.

searchByName

public List<WorkspaceItem> searchByName(String name,
                                        String folderId)
                                 throws InternalErrorException

Description copied from interface: Workspace

Search by Name.

Specified by:

searchByName in interface Workspace

Parameters:

name - the name

folderId - the folder id

Returns:

a list of SearchItem

Throws:

InternalErrorException - the internal error exception

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

getFolderItems

public List<WorkspaceItem> getFolderItems(org.gcube.common.storagehub.model.types.GenericItemType type)
                                   throws InternalErrorException

Description copied from interface: Workspace

Get items by type.

Specified by:

getFolderItems in interface Workspace

Parameters:

type - the type

Returns:

a list of SearchItem

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

createSharedFolder

public WorkspaceSharedFolder createSharedFolder(String name,
                                                String description,
                                                String groupId,
                                                String destinationFolderId,
                                                String displayName,
                                                boolean isVREFolder)
                                         throws InternalErrorException,
                                                InsufficientPrivilegesException,
                                                ItemAlreadyExistException,
                                                WrongDestinationException,
                                                ItemNotFoundException,
                                                WorkspaceFolderNotFoundException

Description copied from interface: Workspace

Create a shared folder associated with a groupId.

Specified by:

createSharedFolder in interface Workspace

Parameters:

name - the name of the folder

description - the description

groupId - an existing groupId to associate with the folder

destinationFolderId - the destination folder id

displayName - a friendly name for the folder

isVREFolder - a flag to indicate the folder is a VRE Folder

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

getTrash

public WorkspaceTrashItem getTrash()
                            throws InternalErrorException,
                                   ItemNotFoundException

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

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

getVREFolderByScope

public WorkspaceSharedFolder getVREFolderByScope(String scope)
                                          throws ItemNotFoundException,
                                                 InternalErrorException

Description copied from interface: Workspace

Get VRE Folder By Scope.

Specified by:

getVREFolderByScope in interface Workspace

Parameters:

scope - the scope

Returns:

the VRE folder associated to such scope

Throws:

ItemNotFoundException - the item not found exception

InternalErrorException - the internal error exception

getDiskUsage

public long getDiskUsage()
                  throws InternalErrorException

Description copied from interface: Workspace

Get the disk usage of a worskpace.

Specified by:

getDiskUsage in interface Workspace

Returns:

the disk usage

Throws:

InternalErrorException - the internal error exception

getTotalItems

public int getTotalItems()
                  throws InternalErrorException

Description copied from interface: Workspace

Get the total number of items in a workspace.

Specified by:

getTotalItems in interface Workspace

Returns:

the numer of total Items

Throws:

InternalErrorException - the internal error exception

removeItems

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

Description copied from interface: Workspace

Remove a list of items identified by ids.

Specified by:

removeItems in interface Workspace

Parameters:

id - the id

Returns:

a map of errors: Map

Throws:

ItemNotFoundException - the item not found exception

InternalErrorException - the internal error exception

InsufficientPrivilegesException - the insufficient privileges 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

getGroup

public String getGroup(String groupId)
                throws InternalErrorException

Description copied from interface: Workspace

Get group name by group id.

Specified by:

getGroup in interface Workspace

Parameters:

groupId - the group id

Returns:

the group name

Throws:

InternalErrorException - the internal error exception

isGroup

public boolean isGroup(String groupId)
                throws InternalErrorException

Description copied from interface: Workspace

Check if a user is a group.

Specified by:

isGroup in interface Workspace

Parameters:

groupId - the group id

Returns:

true if the user is a group, false otherwise

Throws:

InternalErrorException - the internal error 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