org.exoplatform.clouddrive.ecms.action

Class CloudFileActionService

java.lang.Object

org.exoplatform.clouddrive.ecms.action.CloudFileActionService

All Implemented Interfaces:

org.picocontainer.Startable

public class CloudFileActionService
extends Object
implements org.picocontainer.Startable

Integration of Cloud Drive with eXo Platform apps.
Created by The eXo Platform SAS

Version:

$Id: CloudFileActionService.java 00000 Jul 6, 2015 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CloudFileActionService.LinkRemoveListener Act on ecd:cloudFileLinkGroup property removal on a cloud file symlink and then unshare the file from the group where it was shared by the link.
protected class	CloudFileActionService.LinkTrashListener Act on Cloud File symlink trashing.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.exoplatform.clouddrive.CloudDriveService	cloudDrive The cloud drive.
protected org.exoplatform.services.cms.CmsService	cmsService The cms service.
protected org.exoplatform.services.cms.drives.ManageDriveService	documentDrives The document drives.
protected static String	ECD_CLOUDFILELINK The Constant ECD_CLOUDFILELINK.
protected static String	ECD_SHAREIDENTITY The Constant ECD_SHAREIDENTITY.
protected static String	EXO_OWNEABLE The Constant EXO_OWNEABLE.
protected static String	EXO_PRIVILEGEABLE The Constant EXO_PRIVILEGEABLE.
protected static String	EXO_TRASHFOLDER The Constant EXO_TRASHFOLDER.
protected org.exoplatform.clouddrive.jcr.NodeFinder	finder Node finder facade on actual storage implementation.
protected String	groupsPath The groups path.
protected org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator	hierarchyCreator The hierarchy creator.
protected org.exoplatform.services.jcr.RepositoryService	jcrService The jcr service.
protected org.exoplatform.services.cms.link.LinkManager	linkManager The link manager.
protected org.exoplatform.services.listener.ListenerService	listenerService The listener service.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected static String[]	MANAGER_PERMISSION The Constant MANAGER_PERMISSION.
protected static String	MIX_VERSIONABLE The Constant MIX_VERSIONABLE.
protected org.exoplatform.services.organization.OrganizationService	orgService The org service.
protected static String[]	READER_PERMISSION The Constant READER_PERMISSION.
protected Map<String,String>	removedLinks Symlink to cloud file UUID mappings.
protected Map<String,String>	removedShared Cloud file UUID to shared group name mappings.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.
protected static String	SHARE_CLOUD_FILES_SPACES The Constant SHARE_CLOUD_FILES_SPACES.
protected static String	SPACES_GROUP The Constant SPACES_GROUP.
protected org.exoplatform.services.cms.documents.TrashService	trash The trash.
protected String	usersPath The users path.
protected org.exoplatform.clouddrive.ThreadExecutor	workerExecutor Trashed symlinks removal workers.

Constructor Summary

Constructors

Constructor and Description

CloudFileActionService(org.exoplatform.clouddrive.CloudDriveService cloudDrive, org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.organization.OrganizationService orgService, org.exoplatform.clouddrive.jcr.NodeFinder finder, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator, org.exoplatform.services.cms.link.LinkManager linkManager, org.exoplatform.services.cms.drives.ManageDriveService documentDrives, org.exoplatform.services.cms.documents.TrashService trash, org.exoplatform.services.listener.ListenerService listeners, org.exoplatform.services.cms.CmsService cmsService) Instantiates a new cloud file action service.

Method Summary

Modifier and Type	Method and Description
protected String	documentName(javax.jcr.Node document) Find pretty name of the document.
protected javax.jcr.NodeIterator	getCloudFileLinks(javax.jcr.Node targetNode, String shareIdentity, boolean useSystemSession) Gets the cloud file links.
String	getDriveNameFromPath(String nodePath) Deprecated.
org.exoplatform.services.cms.drives.DriveData	getNodeDrive(javax.jcr.Node node) Gets the node drive.
org.exoplatform.services.cms.drives.DriveData	getUserDrive(String userName) Gets the user drive.
javax.jcr.Node	getUserPublicNode(String userName) Gets the user public node.
boolean	isGroupDrive(org.exoplatform.services.cms.drives.DriveData drive) Checks if is group drive.
boolean	isUserDrive(org.exoplatform.services.cms.drives.DriveData drive) Checks if is user drive.
javax.jcr.Node	linkFile(javax.jcr.Node srcNode, javax.jcr.Node destNode, String destIdentity) Link file.
javax.jcr.Node	linkShareToUser(javax.jcr.Node fileNode, org.exoplatform.clouddrive.CloudDrive fileDrive, String userName) Link share to user.
protected void	listenFileLinks() Listen file links.
javax.jcr.Node	markRemoveLink(javax.jcr.Node linkNode) Mark remove link.
String	postSharedActivity(javax.jcr.Node node, javax.jcr.Node link, String comment) Post shared activity.
void	removeLinks(javax.jcr.Node fileNode, String shareIdentity) Removes the links.
protected void	removePermissions(javax.jcr.Node node, boolean deep, String... identities) Remove read permissions on the target node for all given identities (e.g.
protected void	setAllPermissions(javax.jcr.Node node, String... identities) Set all available permissions to given node for given identities.
protected void	setParentPermissions(javax.jcr.Node parent, String... identities) Set permissions on a parent node of a link target: all child nodes will become exo:privilegeable (thus copy permissions from its priviligeable parent).
protected void	setPermissions(javax.jcr.Node node, boolean deep, boolean forcePrivilegeable, String... identities) Set read permissions on the target node to all given identities (e.g.
protected void	setPermissions(javax.jcr.Node node, String... identities) Set read permissions on the target node to all given identities (e.g.
void	shareCloudFile(javax.jcr.Node fileNode, org.exoplatform.clouddrive.CloudDrive cloudDrive, String... identities) Share cloud file.
void	start()
void	stop()
protected javax.jcr.Session	systemSession() System session in default workspace of current JCR repository.
void	unshareCloudFile(javax.jcr.Node fileNode, org.exoplatform.clouddrive.CloudDrive cloudDrive, String... identities) Unshare cloud file.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

SPACES_GROUP

protected static final String SPACES_GROUP

The Constant SPACES_GROUP.

See Also:

Constant Field Values

SHARE_CLOUD_FILES_SPACES

protected static final String SHARE_CLOUD_FILES_SPACES

The Constant SHARE_CLOUD_FILES_SPACES.

See Also:

Constant Field Values

EXO_OWNEABLE

protected static final String EXO_OWNEABLE

The Constant EXO_OWNEABLE.

See Also:

Constant Field Values

EXO_PRIVILEGEABLE

protected static final String EXO_PRIVILEGEABLE

The Constant EXO_PRIVILEGEABLE.

See Also:

Constant Field Values

ECD_CLOUDFILELINK

protected static final String ECD_CLOUDFILELINK

The Constant ECD_CLOUDFILELINK.

See Also:

Constant Field Values

ECD_SHAREIDENTITY

protected static final String ECD_SHAREIDENTITY

The Constant ECD_SHAREIDENTITY.

See Also:

Constant Field Values

MIX_VERSIONABLE

protected static final String MIX_VERSIONABLE

The Constant MIX_VERSIONABLE.

See Also:

Constant Field Values

EXO_TRASHFOLDER

protected static final String EXO_TRASHFOLDER

The Constant EXO_TRASHFOLDER.

See Also:

Constant Field Values

READER_PERMISSION

protected static final String[] READER_PERMISSION

The Constant READER_PERMISSION.

MANAGER_PERMISSION

protected static final String[] MANAGER_PERMISSION

The Constant MANAGER_PERMISSION.

cloudDrive

protected final org.exoplatform.clouddrive.CloudDriveService cloudDrive

The cloud drive.

jcrService

protected final org.exoplatform.services.jcr.RepositoryService jcrService

The jcr service.

hierarchyCreator

protected final org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator

The hierarchy creator.

sessionProviders

protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders

The session providers.

orgService

protected final org.exoplatform.services.organization.OrganizationService orgService

The org service.

linkManager

protected final org.exoplatform.services.cms.link.LinkManager linkManager

The link manager.

documentDrives

protected final org.exoplatform.services.cms.drives.ManageDriveService documentDrives

The document drives.

trash

protected final org.exoplatform.services.cms.documents.TrashService trash

The trash.

listenerService

protected final org.exoplatform.services.listener.ListenerService listenerService

The listener service.

cmsService

protected final org.exoplatform.services.cms.CmsService cmsService

The cms service.

removedLinks

protected final Map<String,String> removedLinks

Symlink to cloud file UUID mappings.

removedShared

protected final Map<String,String> removedShared

Cloud file UUID to shared group name mappings.

finder

protected final org.exoplatform.clouddrive.jcr.NodeFinder finder

Node finder facade on actual storage implementation.

workerExecutor

protected final org.exoplatform.clouddrive.ThreadExecutor workerExecutor

Trashed symlinks removal workers.

groupsPath

protected final String groupsPath

The groups path.

usersPath

protected final String usersPath

The users path.

Constructor Detail

CloudFileActionService

public CloudFileActionService(org.exoplatform.clouddrive.CloudDriveService cloudDrive,
                              org.exoplatform.services.jcr.RepositoryService jcrService,
                              org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                              org.exoplatform.services.organization.OrganizationService orgService,
                              org.exoplatform.clouddrive.jcr.NodeFinder finder,
                              org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator,
                              org.exoplatform.services.cms.link.LinkManager linkManager,
                              org.exoplatform.services.cms.drives.ManageDriveService documentDrives,
                              org.exoplatform.services.cms.documents.TrashService trash,
                              org.exoplatform.services.listener.ListenerService listeners,
                              org.exoplatform.services.cms.CmsService cmsService)

Instantiates a new cloud file action service.

Parameters:

cloudDrive - the cloud drive

jcrService - the jcr service

sessionProviders - the session providers

orgService - the org service

finder - the finder

hierarchyCreator - the hierarchy creator

linkManager - the link manager

documentDrives - the document drives

trash - the trash

listeners - the listeners

cmsService - the cms service

Method Detail

isGroupDrive

public boolean isGroupDrive(org.exoplatform.services.cms.drives.DriveData drive)

Checks if is group drive.

Parameters:

drive - the drive

Returns:

true, if is group drive

isUserDrive

public boolean isUserDrive(org.exoplatform.services.cms.drives.DriveData drive)

Checks if is user drive.

Parameters:

drive - the drive

Returns:

true, if is user drive

linkShareToUser

public javax.jcr.Node linkShareToUser(javax.jcr.Node fileNode,
                                      org.exoplatform.clouddrive.CloudDrive fileDrive,
                                      String userName)
                               throws Exception

Link share to user.

Parameters:

fileNode - the file node

fileDrive - the file drive

userName - the user name

Returns:

the node

Throws:

Exception - the exception

getUserDrive

public org.exoplatform.services.cms.drives.DriveData getUserDrive(String userName)
                                                           throws Exception

Gets the user drive.

Parameters:

userName - the user name

Returns:

the user drive

Throws:

Exception - the exception

getUserPublicNode

public javax.jcr.Node getUserPublicNode(String userName)
                                 throws Exception

Gets the user public node.

Parameters:

userName - the user name

Returns:

the user public node

Throws:

Exception - the exception

removeLinks

public void removeLinks(javax.jcr.Node fileNode,
                        String shareIdentity)
                 throws javax.jcr.RepositoryException

Removes the links.

Parameters:

fileNode - the file node

shareIdentity - the share identity

Throws:

javax.jcr.RepositoryException - the repository exception

getNodeDrive

public org.exoplatform.services.cms.drives.DriveData getNodeDrive(javax.jcr.Node node)
                                                           throws Exception

Gets the node drive.

Parameters:

node - the node

Returns:

the node drive

Throws:

Exception - the exception

getDriveNameFromPath

@Deprecated
public String getDriveNameFromPath(String nodePath)
                                        throws CloudFileActionException

Deprecated.

Gets the drive name from path.

Parameters:

nodePath - the node path

Returns:

the drive name from path

Throws:

CloudFileActionException - the cloud file action exception

linkFile

public javax.jcr.Node linkFile(javax.jcr.Node srcNode,
                               javax.jcr.Node destNode,
                               String destIdentity)
                        throws org.exoplatform.clouddrive.NotCloudDriveException,
                               org.exoplatform.clouddrive.DriveRemovedException,
                               javax.jcr.RepositoryException,
                               org.exoplatform.clouddrive.CloudDriveException

Link file.

Parameters:

srcNode - the src node

destNode - the dest node

destIdentity - the dest identity

Returns:

the node

Throws:

org.exoplatform.clouddrive.NotCloudDriveException - the not cloud drive exception

org.exoplatform.clouddrive.DriveRemovedException - the drive removed exception

javax.jcr.RepositoryException - the repository exception

org.exoplatform.clouddrive.CloudDriveException - the cloud drive exception

markRemoveLink

public javax.jcr.Node markRemoveLink(javax.jcr.Node linkNode)
                              throws org.exoplatform.clouddrive.NotCloudDriveException,
                                     org.exoplatform.clouddrive.DriveRemovedException,
                                     javax.jcr.RepositoryException,
                                     org.exoplatform.clouddrive.CloudDriveException

Mark remove link.

Parameters:

linkNode - the link node

Returns:

the node

Throws:

org.exoplatform.clouddrive.NotCloudDriveException - the not cloud drive exception

org.exoplatform.clouddrive.DriveRemovedException - the drive removed exception

javax.jcr.RepositoryException - the repository exception

org.exoplatform.clouddrive.CloudDriveException - the cloud drive exception

shareCloudFile

public void shareCloudFile(javax.jcr.Node fileNode,
                           org.exoplatform.clouddrive.CloudDrive cloudDrive,
                           String... identities)
                    throws org.exoplatform.clouddrive.NotCloudDriveException,
                           org.exoplatform.clouddrive.DriveRemovedException,
                           javax.jcr.RepositoryException,
                           org.exoplatform.clouddrive.CloudDriveException

Share cloud file.

Parameters:

fileNode - the file node

cloudDrive - the cloud drive

identities - the identities

Throws:

org.exoplatform.clouddrive.NotCloudDriveException - the not cloud drive exception

org.exoplatform.clouddrive.DriveRemovedException - the drive removed exception

javax.jcr.RepositoryException - the repository exception

org.exoplatform.clouddrive.CloudDriveException - the cloud drive exception

unshareCloudFile

public void unshareCloudFile(javax.jcr.Node fileNode,
                             org.exoplatform.clouddrive.CloudDrive cloudDrive,
                             String... identities)
                      throws org.exoplatform.clouddrive.NotCloudDriveException,
                             org.exoplatform.clouddrive.DriveRemovedException,
                             javax.jcr.RepositoryException,
                             org.exoplatform.clouddrive.CloudDriveException

Unshare cloud file.

Parameters:

fileNode - the file node

cloudDrive - the cloud drive

identities - the identities

Throws:

org.exoplatform.clouddrive.NotCloudDriveException - the not cloud drive exception

org.exoplatform.clouddrive.DriveRemovedException - the drive removed exception

javax.jcr.RepositoryException - the repository exception

org.exoplatform.clouddrive.CloudDriveException - the cloud drive exception

postSharedActivity

public String postSharedActivity(javax.jcr.Node node,
                                 javax.jcr.Node link,
                                 String comment)
                          throws org.exoplatform.clouddrive.CloudDriveException

Post shared activity.

Parameters:

node - the node

link - the link

comment - the comment

Returns:

the string

Throws:

org.exoplatform.clouddrive.CloudDriveException - the cloud drive exception

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

listenFileLinks

protected void listenFileLinks()
                        throws javax.jcr.RepositoryException

Listen file links.

Throws:

javax.jcr.RepositoryException - the repository exception

setPermissions

protected void setPermissions(javax.jcr.Node node,
                              String... identities)
                       throws AccessControlException,
                              javax.jcr.RepositoryException

Set read permissions on the target node to all given identities (e.g. space group members). If node not yet exo:privilegeable it will add such mixin to allow set the permissions first. Requested permissions will be set to all children nodes if the child already exo:privilegeable.

Parameters:

node - Node link target node

identities - array of String with user identifiers (names or memberships)

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

setPermissions

protected void setPermissions(javax.jcr.Node node,
                              boolean deep,
                              boolean forcePrivilegeable,
                              String... identities)
                       throws AccessControlException,
                              javax.jcr.RepositoryException

Set read permissions on the target node to all given identities (e.g. space group members). Permissions will not be set if target not exo:privilegeable and forcePrivilegeable is false. If deep is true the target children nodes will be checked also for a need to set the requested permissions.

Parameters:

node - Node link target node

deep - Boolean if true then also children nodes will be set to the requested permissions

forcePrivilegeable - Boolean if true and node not yet exo:privilegeable it will add such mixin to allow set the permissions.

identities - array of String with user identifiers (names or memberships)

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

removePermissions

protected void removePermissions(javax.jcr.Node node,
                                 boolean deep,
                                 String... identities)
                          throws AccessControlException,
                                 javax.jcr.RepositoryException

Remove read permissions on the target node for all given identities (e.g. space group members). If deep is true then permissions will be removed on all ancestor nodes (sub-tree for folders).

Parameters:

node - Node link target node

deep - Boolean if true then also remove the permissions from children nodes

identities - array of String with user identifiers (names or memberships)

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

setParentPermissions

protected void setParentPermissions(javax.jcr.Node parent,
                                    String... identities)
                             throws AccessControlException,
                                    javax.jcr.RepositoryException

Set permissions on a parent node of a link target: all child nodes will become exo:privilegeable (thus copy permissions from its priviligeable parent). If a child already of priviligeable type - nothing will be performed, by this we assume its permissions already handled as required. After this read permissions will be added to the parent node.
This method SHOULD be used before setting permissions to a link target node in this parent. In this way we will keep permission of the target in consistent state.

Parameters:

parent - the parent

identities - the identities

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

setAllPermissions

protected void setAllPermissions(javax.jcr.Node node,
                                 String... identities)
                          throws AccessControlException,
                                 javax.jcr.RepositoryException

Set all available permissions to given node for given identities.

Parameters:

node - the node

identities - the identities

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

documentName

protected String documentName(javax.jcr.Node document)
                       throws javax.jcr.RepositoryException

Find pretty name of the document.

Parameters:

document - the document

Returns:

the string

Throws:

javax.jcr.RepositoryException - the repository exception

systemSession

protected javax.jcr.Session systemSession()
                                   throws javax.jcr.RepositoryException

System session in default workspace of current JCR repository.

Returns:

the session

Throws:

javax.jcr.RepositoryException - the repository exception

getCloudFileLinks

protected javax.jcr.NodeIterator getCloudFileLinks(javax.jcr.Node targetNode,
                                                   String shareIdentity,
                                                   boolean useSystemSession)
                                            throws javax.jcr.RepositoryException

Gets the cloud file links.

Parameters:

targetNode - the target node

shareIdentity - the share identity

useSystemSession - the use system session

Returns:

the cloud file links

Throws:

javax.jcr.RepositoryException - the repository exception