org.gcube.common.homelibrary.home.workspace

Interface WorkspaceSharedFolder

All Superinterfaces:

WorkspaceFolder, WorkspaceItem

public interface WorkspaceSharedFolder
extends WorkspaceFolder

Author:

gioia

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAdmin(String username) Add administrators to a shared folder
void	addUser(String user)
void	deleteACL(List<String> users) Delete privileges for a list of users
Map<ACLType,List<String>>	getACLOwner() Get a map of ACL of a WorkspaceSharedFolder
ACLType	getACLUser() Get the ACL of a WorkspaceSharedFolder
List<String>	getAdministrators() Get Administrators
String	getDisplayName()
List<String>	getMembers()
String	getName(String user)
ACLType	getPrivilege() Get the privilege set on a WorkspaceSharedFolder
List<String>	getUsers()
boolean	isVreFolder()
void	setACL(List<String> users, ACLType privilege) Set ACLs on shared folder
boolean	setAdmins(List<String> logins) Set administrators
WorkspaceFolder	unShare()
WorkspaceFolder	unShare(String user) Unshare a single user

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceFolder

createAnnotationItem, createAquaMapsItem, createDocumentItem, createDocumentLinkItem, createExternalFileItem, createExternalFileItem, createExternalImageItem, createExternalImageItem, createExternalPDFFileItem, createExternalPDFFileItem, createExternalResourceLink, createExternalUrlItem, createExternalUrlItem, createExternalUrlItem, createFolder, createImageDocumentItem, createImageDocumentLinkItem, createMetadataItem, createPDFDocumentItem, createPDFDocumentLinkItem, createQueryItem, createQueryItem, createReportItem, createReportTemplateItem, createTabularDataLink, createTimeSeries, createUrlDocumentItem, createWorkflowReport, createWorkflowTemplate, exists, find, getChildren, getCount, getNewFolderBulkCreator, getSize, getUniqueName, share

Methods inherited from interface org.gcube.common.homelibrary.home.workspace.WorkspaceItem

cloneItem, getAccounting, getCapabilities, getCreationTime, getDescription, getId, getIdSharedFolder, getLastAction, getLastModificationTime, getName, getOwner, getParent, getPath, getProperties, getPublicLink, getReaders, getRemotePath, getType, hasAccessRight, isFolder, isMarkedAsRead, isRoot, isShared, isTrashed, markAsRead, move, remove, removeChild, rename, setDescription

Method Detail

getAdministrators

List<String> getAdministrators()
                               throws InternalErrorException

Get Administrators

Returns:

Administrators

Throws:

InternalErrorException

addAdmin

boolean addAdmin(String username)
                 throws InsufficientPrivilegesException,
                        InternalErrorException

Add administrators to a shared folder

Throws:

InsufficientPrivilegesException

InternalErrorException

setAdmins

boolean setAdmins(List<String> logins)
                  throws InsufficientPrivilegesException,
                         InternalErrorException

Set administrators

Throws:

InsufficientPrivilegesException

InternalErrorException

getUsers

List<String> getUsers()
                      throws InternalErrorException

Returns:

the list of users.

Throws:

InternalErrorException

addUser

void addUser(String user)
             throws InsufficientPrivilegesException,
                    InternalErrorException

Parameters:

user -

Throws:

InsufficientPrivilegesException

InternalErrorException

unShare

WorkspaceFolder unShare()
                        throws InternalErrorException

Returns:

a new WorkspaceFolder

Throws:

InternalErrorException

unShare

WorkspaceFolder unShare(String user)
                        throws InternalErrorException

Unshare a single user

Parameters:

user -

Returns:

a new WorkspaceFolder

Throws:

InternalErrorException

getName

String getName(String user)
               throws InternalErrorException

Parameters:

user -

Returns:

the shared folder name set by the user, null if the user doen't exist.

Throws:

InternalErrorException

setACL

void setACL(List<String> users,
          ACLType privilege)
            throws InternalErrorException

Set ACLs on shared folder

Specified by:

setACL in interface WorkspaceFolder

Parameters:

users -

privilege -

Throws:

InternalErrorException

getDisplayName

String getDisplayName()

Returns:

the displayName for the VRE folder

isVreFolder

boolean isVreFolder()

Returns:

true if the shared folder is a VRE folder

getACLOwner

Map<ACLType,List<String>> getACLOwner()
                                      throws InternalErrorException

Get a map of ACL of a WorkspaceSharedFolder

Returns:

Throws:

InternalErrorException

getPrivilege

ACLType getPrivilege()
                     throws InternalErrorException

Get the privilege set on a WorkspaceSharedFolder

Returns:

Throws:

InternalErrorException

getACLUser

ACLType getACLUser()
                   throws InternalErrorException

Get the ACL of a WorkspaceSharedFolder

Returns:

Throws:

InternalErrorException

deleteACL

void deleteACL(List<String> users)
               throws InternalErrorException

Delete privileges for a list of users

Specified by:

deleteACL in interface WorkspaceItem

Parameters:

users -

Throws:

InternalErrorException

getMembers

List<String> getMembers()
                        throws InternalErrorException

Returns:

Throws:

InternalErrorException