org.jbei.ice.lib.folder

Class FolderPermissions

java.lang.Object

org.jbei.ice.lib.folder.FolderPermissions

public class FolderPermissions
extends Object

Represents permissions for a specified folder with methods to manipulate them

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
FolderPermissions(String userId, long folderId)

Method Summary

Modifier and Type	Method and Description
AccessPermission	createPermission(AccessPermission accessPermission) Creates a new access permission record to enable read or write privileges for a folder.
protected Permission	createPermissionModel(AccessPermission accessPermission, RemoteShareModel remoteShare)
AccessPermission	createRemotePermission(AccessPermission accessPermission) Creates an access folder permission for a remote user
boolean	disablePublicReadAccess()
boolean	enablePublicReadAccess()
ArrayList<AccessPermission>	get() Retrieves list of available folder permissions (both local and remote)
protected RemoteClientModel	getOrCreateRemoteClient(String remoteUserId, RemotePartner remotePartner) Checks if there is an existing client for the specified userId and remote partner.
boolean	remove(long permissionId)
protected boolean	sendToken(AccessPermission accessPermission, RemotePartner partner) Send access permission to a remote partner with a "secret"

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderPermissions

public FolderPermissions(String userId,
                         long folderId)

Method Detail

get

public ArrayList<AccessPermission> get()

Retrieves list of available folder permissions (both local and remote)

Returns:

list available folders

createPermission

public AccessPermission createPermission(AccessPermission accessPermission)

Creates a new access permission record to enable read or write privileges for a folder. User initiating request must have write privileges for the folder

Parameters:

accessPermission - details about access permissions to create

Returns:

access permission data transfer object with unique record identifier

Throws:

IllegalArgumentException - if the accessPermission object is null

PermissionException - if specified user does not have write privileges on specified folder.

enablePublicReadAccess

public boolean enablePublicReadAccess()

disablePublicReadAccess

public boolean disablePublicReadAccess()

createRemotePermission

public AccessPermission createRemotePermission(AccessPermission accessPermission)

Creates an access folder permission for a remote user

Parameters:

accessPermission - access details

Returns:

wrapper around the unique identifier for the remote permission created

Throws:

IllegalArgumentException - if the partner record cannot be retrieved

getOrCreateRemoteClient

protected RemoteClientModel getOrCreateRemoteClient(String remoteUserId,
                                                    RemotePartner remotePartner)

Checks if there is an existing client for the specified userId and remote partner. Retrieves and returns if so, or creates a new record if not

Parameters:

remoteUserId - email address of remote user

remotePartner - remote partner

Returns:

client model stored in the database with specified user id and partner

remove

public boolean remove(long permissionId)

sendToken

protected boolean sendToken(AccessPermission accessPermission,
                            RemotePartner partner)

Send access permission to a remote partner with a "secret"

Parameters:

accessPermission - permission details including secret token

partner - remote ICE partner to send information to

Returns:

true if permission is successfully sent with a reply received, false otherwise

createPermissionModel

protected Permission createPermissionModel(AccessPermission accessPermission,
                                           RemoteShareModel remoteShare)