org.gcube.common.storagehub.client.dsl

Class FolderContainer

java.lang.Object

org.gcube.common.storagehub.client.dsl.ItemContainer<org.gcube.common.storagehub.model.items.FolderItem>

org.gcube.common.storagehub.client.dsl.FolderContainer

public class FolderContainer
extends ItemContainer<org.gcube.common.storagehub.model.items.FolderItem>

Field Summary

Fields inherited from class org.gcube.common.storagehub.client.dsl.ItemContainer

item, itemclient, itemId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FolderContainer(ItemManagerClient itemclient, org.gcube.common.storagehub.model.items.FolderItem item)
protected	FolderContainer(ItemManagerClient itemclient, String folderId)

Method Summary

Modifier and Type	Method and Description
URLContainer	addUrl(URL url, String name, String description) creates a inside the folder represented by this FolderContainer
boolean	canWrite()
FolderContainer	changeAcls(String user, org.gcube.common.storagehub.model.acls.AccessType accessType) changes of the {FolderItem} represented by this FolderContainer for a user
ListResolver	findByName(String namePattern) returns the children of this that matches the name pattern
List<org.gcube.common.storagehub.model.acls.ACL>	getAcls() returns the of the {FolderItem} represented by this FolderContainer
ContainerType	getType()
ListResolverTyped	list() returns the children of this By default this method return all FolderContainers (asContainers) or Items (asItems) without accounting data, content data and metadata of the item to add these information see
FolderContainer	newFolder(String name, String description) create a new inside the represented by this FolderContainer
GenericItemContainer	newGcubeItem(org.gcube.common.storagehub.model.items.GCubeItem item) create a new hidden Folder inside the folder represented by this FolderContainer
FolderContainer	newHiddenFolder(String name, String description) create a new hidden inside the folder represented by this FolderContainer
OpenResolver	openByRelativePath(String relativePath) returns the children of this that matches the name pattern
FolderContainer	publish() makes this Folder public.
ListResolver	search(String nameTomatch) returns the items that matches the name pattern searching recursively on all subfolders
ListResolver	search(String nameTomatch, boolean excludeTrashed) returns the items that matches the name pattern searching recursively on all subfolders filtering the trashed Items
FolderContainer	share(Set<String> users, org.gcube.common.storagehub.model.acls.AccessType accessType) shares this Folder with a list of users setting the same for everyone in the list.
FolderContainer	unpublish() unpublish this Folder.
FolderContainer	unshare(Set<String> users) remove share from this Folder for a list of users, for everyone or only for the caller.
FolderContainer	uploadArchive(InputStream stream, String extractionFolderName) creates a set of in the workspace extracting the Archive
FileContainer	uploadFile(InputStream stream, String filename, String description) creates a inside the folder represented by this FolderContainer

Methods inherited from class org.gcube.common.storagehub.client.dsl.ItemContainer

delete, download, forceDelete, get, getAnchestors, getId, getRootSharedFolder, invalidateItem, move, rename, setHidden, setItem, setMetadata, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderContainer

protected FolderContainer(ItemManagerClient itemclient,
                          org.gcube.common.storagehub.model.items.FolderItem item)

FolderContainer

protected FolderContainer(ItemManagerClient itemclient,
                          String folderId)

Method Detail

getType

public ContainerType getType()

Specified by:

getType in class ItemContainer<org.gcube.common.storagehub.model.items.FolderItem>

list

public ListResolverTyped list()
                       throws org.gcube.common.storagehub.model.exceptions.StorageHubException

returns the children of this By default this method return all FolderContainers (asContainers) or Items (asItems) without accounting data, content data and metadata of the item to add these information see

Returns:

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to read this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

uploadFile

public FileContainer uploadFile(InputStream stream,
                                String filename,
                                String description)
                         throws org.gcube.common.storagehub.model.exceptions.StorageHubException

creates a inside the folder represented by this FolderContainer

Parameters:

stream - the file stream

filename - the name of the item in the workspace

description - the description of the item in the workspace

Returns:

of the Item created

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

addUrl

public URLContainer addUrl(URL url,
                           String name,
                           String description)
                    throws org.gcube.common.storagehub.model.exceptions.StorageHubException

creates a inside the folder represented by this FolderContainer

Parameters:

url - the url

name - the name of the item in the workspace

description - the description of the item in the workspace

Returns:

of the Item created

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

uploadArchive

public FolderContainer uploadArchive(InputStream stream,
                                     String extractionFolderName)
                              throws org.gcube.common.storagehub.model.exceptions.StorageHubException

creates a set of in the workspace extracting the Archive

Parameters:

stream - the file stream

extractionFolderName - the root name of the folder where the archive will be extracted (A new folder with this name will be created)

Returns:

of the extraction Folder

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

newFolder

public FolderContainer newFolder(String name,
                                 String description)
                          throws org.gcube.common.storagehub.model.exceptions.StorageHubException

create a new inside the represented by this FolderContainer

Parameters:

name - the name of the folder

description - the description of the folder

Returns:

the representing the new folder

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

newHiddenFolder

public FolderContainer newHiddenFolder(String name,
                                       String description)
                                throws Exception

create a new hidden inside the folder represented by this FolderContainer

Parameters:

name - the name of the folder

description - the description of the folder

Returns:

the representing the new folder

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

Exception

newGcubeItem

public GenericItemContainer newGcubeItem(org.gcube.common.storagehub.model.items.GCubeItem item)
                                  throws Exception

create a new hidden Folder inside the folder represented by this FolderContainer

Parameters:

name - the name of the folder

description - the description of the folder

Returns:

the representing the new folder

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to write in this folder

Exception

getAcls

public List<org.gcube.common.storagehub.model.acls.ACL> getAcls()
                                                         throws Exception

returns the of the {FolderItem} represented by this FolderContainer

Returns:

a List of

Throws:

{@StorageHubException}

Exception

changeAcls

public FolderContainer changeAcls(String user,
                                  org.gcube.common.storagehub.model.acls.AccessType accessType)
                           throws org.gcube.common.storagehub.model.exceptions.StorageHubException

changes of the {FolderItem} represented by this FolderContainer for a user

Returns:

the

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not administrator of this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

canWrite

public boolean canWrite()
                 throws Exception

Throws:

Exception

findByName

public ListResolver findByName(String namePattern)
                        throws org.gcube.common.storagehub.model.exceptions.StorageHubException

returns the children of this that matches the name pattern

Returns:

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to read this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

openByRelativePath

public OpenResolver openByRelativePath(String relativePath)
                                throws org.gcube.common.storagehub.model.exceptions.StorageHubException

returns the children of this that matches the name pattern

Returns:

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to read this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

search

public ListResolver search(String nameTomatch,
                           boolean excludeTrashed)
                    throws org.gcube.common.storagehub.model.exceptions.StorageHubException

returns the items that matches the name pattern searching recursively on all subfolders filtering the trashed Items

Returns:

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to read this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

search

public ListResolver search(String nameTomatch)
                    throws org.gcube.common.storagehub.model.exceptions.StorageHubException

returns the items that matches the name pattern searching recursively on all subfolders

Returns:

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to read this folder

org.gcube.common.storagehub.model.exceptions.StorageHubException

share

public FolderContainer share(Set<String> users,
                             org.gcube.common.storagehub.model.acls.AccessType accessType)
                      throws Exception

shares this Folder with a list of users setting the same for everyone in the list. if the folder is already shared it add the users to the share.

Returns:

the current updated

Throws:

{@InvalidItemException}

{@UserNotAuthorizedException} - if user is not authorized to share this folder

Exception

unshare

public FolderContainer unshare(Set<String> users)
                        throws Exception

remove share from this Folder for a list of users, for everyone or only for the caller. Is applicable only on . if users is empty or null unshare the entire folder for everyone. if users contains only the caller login the folder is removed only for him.

Returns:

the current updated

Throws:

{@InvalidItemException} - if this folder is not share

{@UserNotAuthorizedException} - if user is not authorized to unshare this folder

Exception

unpublish

public FolderContainer unpublish()
                          throws Exception

unpublish this Folder.

Returns:

the current updated

Throws:

{@InvalidCallParameter} - if this is not a Folder

{@UserNotAuthorizedException} - if user is not authorized to unpublish this folder

Exception

publish

public FolderContainer publish()
                        throws Exception

makes this Folder public.

Returns:

the current updated

Throws:

{@InvalidCallParameter} - if this is not a Folder

{@UserNotAuthorizedException} - if user is not authorized to publish this folder

Exception