org.gcube.common.storagehubwrapper.server

Class StorageHubClientService

java.lang.Object

org.gcube.common.storagehubwrapper.server.StorageHubClientService

public class StorageHubClientService
extends Object

The Class StorageHubClientService.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCOUNTING_HL_NODE_NAME

Constructor Summary

Constructors

Constructor and Description
StorageHubClientService(String scope, String authorizationToken) Instantiates a new storage hub service util.

Method Summary

Modifier and Type	Method and Description
org.gcube.common.storagehub.model.items.AbstractFileItem	copyFileItem(String fileItemId, org.gcube.common.storagehub.client.dsl.FolderContainer destFolderContainer, String newFileName) Copy item.
org.gcube.common.storagehub.model.items.Item	createFolder(String parentId, String folderName, String folderDescription) Creates the folder.
void	deleteItemById(String itemId) Delete item by id.
org.gcube.common.storagehub.client.StreamDescriptor	downloadFile(String itemId, String versionName, String... nodeIdsToExclude) Download file.
org.gcube.common.storagehub.client.StreamDescriptor	downloadFolder(String folderId, String nodeIdsToExclude) Download folder.
void	emptyTrash() Empty trash.
List<? extends org.gcube.common.storagehub.model.items.Item>	findByName(String name, String folderId) Find by name.
List<? extends org.gcube.common.storagehub.model.items.Item>	getChildren(String id, boolean withAccounting, boolean withMapProperties) Gets the children.
List<? extends org.gcube.common.storagehub.model.items.Item>	getFilteredChildren(String id, Class<? extends org.gcube.common.storagehub.model.items.Item> aType, boolean withAccounting, boolean withMapProperties) Gets the filtered children.
org.gcube.common.storagehub.client.dsl.FolderContainer	getFolderContainer(String itemId) Gets the folder container.
String	getIdSharedFolder(String itemId) Gets the id shared folder.
org.gcube.common.storagehub.model.items.nodes.ImageContent	getImageContent(String itemId) Gets the image content.
org.gcube.common.storagehub.model.items.Item	getItem(String itemId) Gets the item.
org.gcube.common.storagehub.model.items.Item	getItem(String itemId, boolean withAccounting, boolean withMetadata) Gets the item.
int	getItemChildrenCount(String itemId) Gets the item children count.
List<org.gcube.common.storagehub.model.service.Version>	getListVersions(String fileItemId) Gets the list versions.
List<? extends org.gcube.common.storagehub.model.items.Item>	getParents(String itemId) Gets the parents.
URL	getPublicLinkForFile(String fileItemId) Gets the file public link.
org.gcube.common.storagehub.model.items.FolderItem	getRoot() Gets the root.
org.gcube.common.storagehub.model.items.FolderItem	getRootSharedFolder(org.gcube.common.storagehub.client.dsl.ItemContainer<org.gcube.common.storagehub.model.items.Item> itemContainer) Gets the root shared folder.
org.gcube.common.storagehub.model.items.FolderItem	getRootSharedFolder(String itemId) Gets the root shared folder.
List<String>	getSharedFolderMembers(String folderId) Gets the shared folder members.
org.gcube.common.storagehub.model.items.Item	getTrash() Gets the root.
String	getUserACLForFolderId(String infrastructureName, String userName, String folderId) Gets the user acl for folder id.
String	getVREFoldersId() Gets the VRE folders id.
boolean	isItemShared(String itemId) Checks if is item shared.
org.gcube.common.storagehub.model.items.Item	moveItem(String itemId, org.gcube.common.storagehub.client.dsl.FolderContainer destFolderContainer) Move item.
org.gcube.common.storagehub.model.items.Item	openTrash() Open trash.
org.gcube.common.storagehub.model.items.Item	renameItem(String itemId, String newName) Rename item.
org.gcube.common.storagehub.model.items.Item	restoreThrashItem(String itemId) Restore thrash item.
org.gcube.common.storagehub.model.items.Item	setMetadata(String itemId, org.gcube.common.storagehub.model.Metadata metadata) Sets the metadata and returns the Item with metadata updated.
String	toString()
org.gcube.common.storagehub.model.items.Item	uploadArchive(String folderId, InputStream is, String extractionFolderName) Upload archive.
org.gcube.common.storagehub.model.items.Item	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, wait, wait, wait

Field Detail

ACCOUNTING_HL_NODE_NAME

public static final String ACCOUNTING_HL_NODE_NAME

See Also:

Constant Field Values

Constructor Detail

StorageHubClientService

public StorageHubClientService(String scope,
                               String authorizationToken)

Instantiates a new storage hub service util.

Parameters:

scope - the scope

authorizationToken - the authorization token

Method Detail

getRoot

public org.gcube.common.storagehub.model.items.FolderItem getRoot()
                                                           throws Exception

Gets the root.

Returns:

the root

Throws:

Exception - the exception

getTrash

public org.gcube.common.storagehub.model.items.Item getTrash()

Gets the root.

Returns:

the root

getChildren

public List<? extends org.gcube.common.storagehub.model.items.Item> getChildren(String id,
                                                                                boolean withAccounting,
                                                                                boolean withMapProperties)

Gets the children.

Parameters:

id - the id

withAccounting - the with accounting

withMapProperties - the with map properties

Returns:

the children

getFilteredChildren

public List<? extends org.gcube.common.storagehub.model.items.Item> getFilteredChildren(String id,
                                                                                        Class<? extends org.gcube.common.storagehub.model.items.Item> aType,
                                                                                        boolean withAccounting,
                                                                                        boolean withMapProperties)

Gets the filtered children.

Parameters:

id - the id

aType - the a type

withAccounting - the with accounting

withMapProperties - the with map properties

Returns:

the filtered children

getItem

public org.gcube.common.storagehub.model.items.Item getItem(String itemId,
                                                            boolean withAccounting,
                                                            boolean withMetadata)
                                                     throws Exception

Gets the item.

Parameters:

itemId - the item id

withAccounting - the with accounting

withMetadata - the with metadata

Returns:

the item

Throws:

Exception - the exception

getItem

public org.gcube.common.storagehub.model.items.Item getItem(String itemId)
                                                     throws Exception

Gets the item.

Parameters:

itemId - the item id

withAccounting - the with accounting

withMetadata - the with metadata

Returns:

the item

Throws:

Exception - the exception

setMetadata

public org.gcube.common.storagehub.model.items.Item setMetadata(String itemId,
                                                                org.gcube.common.storagehub.model.Metadata metadata)
                                                         throws Exception

Sets the metadata and returns the Item with metadata updated.

Parameters:

itemId - the item id

metadata - the metadata

Returns:

the item

Throws:

Exception - the exception

getFolderContainer

public org.gcube.common.storagehub.client.dsl.FolderContainer getFolderContainer(String itemId)
                                                                          throws Exception

Gets the folder container.

Parameters:

itemId - the item id

Returns:

the folder container

Throws:

Exception - the exception

getParents

public List<? extends org.gcube.common.storagehub.model.items.Item> getParents(String itemId)

Gets the parents.

Parameters:

itemId - the item id

Returns:

the parents

getIdSharedFolder

public String getIdSharedFolder(String itemId)
                         throws Exception

Gets the id shared folder.

Parameters:

itemId - the item id

Returns:

the id shared folder

Throws:

Exception - the exception

getRootSharedFolder

public org.gcube.common.storagehub.model.items.FolderItem 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

public 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

getRootSharedFolder

public org.gcube.common.storagehub.model.items.FolderItem getRootSharedFolder(org.gcube.common.storagehub.client.dsl.ItemContainer<org.gcube.common.storagehub.model.items.Item> itemContainer)
                                                                       throws Exception

Gets the root shared folder.

Parameters:

itemContainer - the item container

Returns:

the root shared folder

Throws:

Exception - the exception

createFolder

public org.gcube.common.storagehub.model.items.Item createFolder(String parentId,
                                                                 String folderName,
                                                                 String folderDescription)
                                                          throws Exception

Creates the folder.

Parameters:

parentId - the parent id

folderName - the folder name

folderDescription - the folder description

Returns:

the item

Throws:

Exception - the exception

getVREFoldersId

public String getVREFoldersId()

Gets the VRE folders id.

Returns:

the VRE folders id

getUserACLForFolderId

public String getUserACLForFolderId(String infrastructureName,
                                    String userName,
                                    String folderId)
                             throws Exception

Gets the user acl for folder id.

Parameters:

infrastructureName - the infrastructure name

userName - the user name

folderId - the folder id

Returns:

the user acl for folder id

Throws:

Exception - the exception

getItemChildrenCount

public int getItemChildrenCount(String itemId)

Gets the item children count.

Parameters:

itemId - the item id

Returns:

the item children count

uploadFile

public org.gcube.common.storagehub.model.items.Item uploadFile(String folderId,
                                                               InputStream is,
                                                               String fileName,
                                                               String fileDescription)
                                                        throws Exception

Upload file.

Parameters:

folderId - the folder id

is - the is

fileName - the file name

fileDescription - the file description

Returns:

the item

Throws:

Exception - the exception

downloadFile

public org.gcube.common.storagehub.client.StreamDescriptor downloadFile(String itemId,
                                                                        String versionName,
                                                                        String... nodeIdsToExclude)
                                                                 throws Exception

Download file.

Parameters:

itemId - the item id

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

nodeIdsToExclude - the node ids to exclude

Returns:

the stream descriptor

Throws:

Exception - the exception

downloadFolder

public org.gcube.common.storagehub.client.StreamDescriptor downloadFolder(String folderId,
                                                                          String nodeIdsToExclude)
                                                                   throws Exception

Download folder.

Parameters:

folderId - the folder id

nodeIdsToExclude - the node ids to exclude

Returns:

the stream descriptor

Throws:

Exception - the exception

uploadArchive

public org.gcube.common.storagehub.model.items.Item uploadArchive(String folderId,
                                                                  InputStream is,
                                                                  String extractionFolderName)
                                                           throws Exception

Upload archive.

Parameters:

folderId - the folder id

is - the is

extractionFolderName - the extraction folder name

Returns:

the item

Throws:

Exception - the exception

getSharedFolderMembers

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

Gets the shared folder members.

Parameters:

folderId - the folder id

Returns:

the shared folder members

Throws:

Exception - the exception

findByName

public List<? extends org.gcube.common.storagehub.model.items.Item> findByName(String name,
                                                                               String folderId)
                                                                        throws Exception

Find by name.

Parameters:

name - the name

folderId - the folder id

Returns:

the list

Throws:

Exception - the exception

deleteItemById

public void deleteItemById(String itemId)
                    throws Exception

Delete item by id.

Parameters:

itemId - the item id

Throws:

Exception - the exception

openTrash

public org.gcube.common.storagehub.model.items.Item openTrash()
                                                       throws Exception

Open trash.

Returns:

the item

Throws:

Exception - the exception

emptyTrash

public void emptyTrash()
                throws Exception

Empty trash.

Throws:

Exception - the exception

restoreThrashItem

public org.gcube.common.storagehub.model.items.Item restoreThrashItem(String itemId)
                                                               throws Exception

Restore thrash item.

Parameters:

itemId - the item id

Returns:

the item

Throws:

Exception - the exception

moveItem

public org.gcube.common.storagehub.model.items.Item moveItem(String itemId,
                                                             org.gcube.common.storagehub.client.dsl.FolderContainer destFolderContainer)
                                                      throws Exception

Move item.

Parameters:

itemId - the item id

destFolderContainer - the dest folder container

Returns:

the abstract file item

Throws:

Exception - the exception

copyFileItem

public org.gcube.common.storagehub.model.items.AbstractFileItem copyFileItem(String fileItemId,
                                                                             org.gcube.common.storagehub.client.dsl.FolderContainer destFolderContainer,
                                                                             String newFileName)
                                                                      throws Exception

Copy item.

Parameters:

fileItemId - the copy item id

destFolderContainer - the dest folder container

newFileName - the new file name

Returns:

the abstract file item

Throws:

Exception - the exception

renameItem

public org.gcube.common.storagehub.model.items.Item renameItem(String itemId,
                                                               String newName)
                                                        throws Exception

Rename item.

Parameters:

itemId - the item id

newName - the new name

Returns:

the item

Throws:

Exception - the exception

getPublicLinkForFile

public URL getPublicLinkForFile(String fileItemId)
                         throws Exception

Gets the file public link.

Parameters:

fileItemId - the file item id

Returns:

the file public link

Throws:

Exception - the exception

getListVersions

public List<org.gcube.common.storagehub.model.service.Version> getListVersions(String fileItemId)
                                                                        throws Exception

Gets the list versions.

Parameters:

fileItemId - the file item id

Returns:

the list versions

Throws:

Exception - the exception

getImageContent

public org.gcube.common.storagehub.model.items.nodes.ImageContent getImageContent(String itemId)
                                                                           throws Exception

Gets the image content.

Parameters:

itemId - the item id

Returns:

the image content

Throws:

Exception - the exception

toString

public String toString()

Overrides:

toString in class Object