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 and Description
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.
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.
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<? extends WorkspaceItem>	getChildren(String id) Gets the children.
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.
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.
List<WorkspaceFileVersion>	getListVersionsForFile(String fileItemId) Gets the list versions for file.
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.
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.
ItemStreamDescriptor	getThumbnailData(String itemId) Gets the thumbnail data.
int	getTotalItems() Get the total number of items in a workspace.
WorkspaceItem	getTrash() Get Trash Folder.
String	getVREFoldersId() Gets the VRE folders id.
boolean	isGroup(String groupId) Check if a user is a group.
boolean	isItemShared(String itemId) Checks if is item shared.
Boolean	markAsPublic(String itemId, boolean isPublic) Mark as public.
WorkspaceItem	moveItem(String itemId, String destinationFolderId) Move item.
List<WorkspaceItem>	moveItems(List<String> itemIds, String folderDestinationId) Move items.
void	remove(String itemName, String folderId) Remove an item from a folder.
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>	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	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.

Parameters:

id - the id

withMetadata - the with metadata

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

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

Upload file.

Parameters:

folderId - the folder id

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

List<String> 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)
                         throws Exception

Restore thrash item.

Parameters:

itemId - the item id

Returns:

the 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 for file.

Parameters:

fileItemId - the file item id

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

markAsPublic

Boolean markAsPublic(String itemId,
                     boolean isPublic)

Mark as public.

Parameters:

isPublic - the is public

Returns:

the boolean

createExternalUrl

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

Create a new External URL into a folder.

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

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

Create a new External URL into a folder.

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.

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

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

changeDescription

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

Change an item description.

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

WorkspaceItem getItemByPath(String path)
                     throws ItemNotFoundException

Return the item with the specified path.

Parameters:

path - the item path.

Returns:

the item.

Throws:

ItemNotFoundException - if the item has not been found.

remove

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

Remove an item from a folder.

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.

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

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

searchByName

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

Search by Name.

Parameters:

name - the name

folderId - the folder id

Returns:

a list of SearchItem

Throws:

InternalErrorException - the internal error exception

searchByMimeType

List<WorkspaceItem> searchByMimeType(String mimeType)
                              throws InternalErrorException

Search By MimeType.

Parameters:

mimeType - the mime type

Returns:

a list of SearchFolderItem

Throws:

InternalErrorException - the internal error exception

getFolderItems

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

Get items by type.

Parameters:

type - the type

Returns:

a list of SearchItem

Throws:

InternalErrorException - the internal error exception

createSharedFolder

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

Create a shared folder with a list of users.

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

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

Create a shared folder associated with a groupId.

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

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

Shared an exist WorkspaceFolder with a list of users.

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

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

Shared an exist WorkspaceFolder with a list of users.

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

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

Create a GCubeItem.

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

WorkspaceItem unshare(String itemId)
               throws InternalErrorException,
                      ItemNotFoundException

Unshare a shared item.

Parameters:

itemId - the item id

Returns:

the workspace item

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

getMySpecialFolders

WorkspaceFolder getMySpecialFolders()
                             throws InternalErrorException,
                                    ItemNotFoundException

Get MySpecialFolders.

Returns:

my special folders

Throws:

InternalErrorException - the internal error exception

ItemNotFoundException - the item not found exception

searchByProperties

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

Search By Properties.

Parameters:

properties - the properties

Returns:

a list of WorkspaceItem

Throws:

InternalErrorException - the internal error exception

getDiskUsage

long getDiskUsage()
           throws InternalErrorException

Get the disk usage of a worskpace.

Returns:

the disk usage

Throws:

InternalErrorException - the internal error exception

getTotalItems

int getTotalItems()
           throws InternalErrorException

Get the total number of items in a workspace.

Returns:

the numer of total Items

Throws:

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

createVREFolder

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

Create a VRE folder.

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

String getGroup(String groupId)
         throws InternalErrorException

Get group name by group id.

Parameters:

groupId - the group id

Returns:

the group name

Throws:

InternalErrorException - the internal error exception

isGroup

boolean isGroup(String groupId)
         throws InternalErrorException

Check if a user is a group.

Parameters:

groupId - the group id

Returns:

true if the user is a group, false otherwise

Throws:

InternalErrorException - the internal error exception

getPublicFolders

List<WorkspaceItem> getPublicFolders()
                              throws InternalErrorException

Get public folders.

Returns:

a list of public folder

Throws:

InternalErrorException - the internal error exception

uploadArchive

WorkspaceItem uploadArchive(String folderId,
                            InputStream is,
                            String extractionFolderName)
                     throws WorkspaceFolderNotFoundException,
                            InternalErrorException,
                            ItemAlreadyExistException,
                            WrongDestinationException,
                            InsufficientPrivilegesException

Upload archive.

Parameters:

folderId - the folder id

is - the is

extractionFolderName - the extraction folder name

Returns:

the workspace item

Throws:

WorkspaceFolderNotFoundException - the workspace folder not found exception

InternalErrorException - the internal error exception

ItemAlreadyExistException - the item already exist exception

WrongDestinationException - the wrong destination exception

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

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