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	cloudDrives The cloud drive.
protected org.exoplatform.services.cms.CmsService	cmsService The cms service.
protected org.exoplatform.services.cms.drives.ManageDriveService	documentDrives The document drives.
static String	ECD_CLOUDFILELINK The Constant ECD_CLOUDFILELINK.
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/user name mappings.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.
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 cloudDrives, 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.
javax.jcr.NodeIterator	getCloudFileLinks(javax.jcr.Node targetNode, String shareIdentity, boolean useSystemSession) Gets the cloud file links.
javax.jcr.NodeIterator	getCloudFileLinks(javax.jcr.Node targetNode, String shareIdentity, String scopePath, boolean useSystemSession) Gets the cloud file links.
org.exoplatform.services.cms.drives.DriveData	getGroupDrive(String groupId) Gets the group drive.
protected String	getMembershipName(String membershipType) Gets organizational membership name by its type name.
org.exoplatform.services.cms.drives.DriveData	getUserDrive(String userName) Gets the user drive.
javax.jcr.Node	getUserProfileNode(String userName) Gets the user profile node (a node where /Private and /Public nodes live).
javax.jcr.Node	getUserPublicNode(String userName) Gets the user public node.
protected void	initCloudFileLink(javax.jcr.Node fileNode, String identity, String targetPath, boolean canEdit) Initialize the cloud file link node (mixin node type and permissions).
boolean	isGroupDrive(org.exoplatform.services.cms.drives.DriveData drive) Checks if is group drive.
boolean	isGroupPath(String path) Checks if is group path.
boolean	isUserDrive(org.exoplatform.services.cms.drives.DriveData drive) Checks if is user drive.
boolean	isUserPath(String path) Checks if is user path.
protected void	listenFileLinks() Listen file links.
javax.jcr.Node	markRemoveLink(javax.jcr.Node linkNode) Mark remove link.
protected void	removeLinks(javax.jcr.Node fileNode, String identity) Removes the links.
protected void	removePermission(javax.jcr.Node node, String permIdentity) Removes the permission of an identity on given node.
protected void	removeWritePermissions(org.exoplatform.services.jcr.core.ExtendedNode target, String groupOrUserId) Remove write permissions for all kinds of membership for this group or user.
protected void	setGroupFilePermission(javax.jcr.Node fileNode, String groupId, boolean forcePrivilegeable) Adds the group permission for cloud file.
protected void	setLinkPermission(javax.jcr.Node linkNode, String ownerId, String sharedIdentity, boolean canEdit) Adds the permission for a cloud file link: user who shared and to whom or group manager have full permissions, others can read only.
protected void	setUserFilePermission(javax.jcr.Node fileNode, String userId, boolean forcePrivilegeable) Adds the user permission.
void	shareToGroup(javax.jcr.Node fileNode, String groupId, boolean canEdit) Share cloud file to a group by its ID and create a symlink in the target space.
void	shareToUser(javax.jcr.Node fileNode, String userId, boolean canEdit) Share cloud file to an user by its ID.
void	start()
void	stop()
protected javax.jcr.Session	systemSession() System session in default workspace of current JCR repository.
void	unshareToSpace(javax.jcr.Node fileNode, String groupId) Unshare to space.
void	unshareToUser(javax.jcr.Node fileNode, String userId) Unshare to user.

Methods inherited from class java.lang.Object

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

Field Detail

ECD_CLOUDFILELINK

public static final String ECD_CLOUDFILELINK

The Constant ECD_CLOUDFILELINK.

See Also:

Constant Field Values

ECD_SHAREIDENTITY

public static final String ECD_SHAREIDENTITY

The Constant ECD_SHAREIDENTITY.

See Also:

Constant Field Values

SHARE_CLOUD_FILES_SPACES

public static final String SHARE_CLOUD_FILES_SPACES

The Constant SHARE_CLOUD_FILES_SPACES.

See Also:

Constant Field Values

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

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

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.

cloudDrives

protected final org.exoplatform.clouddrive.CloudDriveService cloudDrives

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/user 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 cloudDrives,
                              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:

cloudDrives - 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

isGroupPath

public boolean isGroupPath(String path)

Checks if is group path.

Parameters:

path - the path

Returns:

true, if is group path

isUserPath

public boolean isUserPath(String path)

Checks if is user path.

Parameters:

path - the path

Returns:

true, if is user path

getGroupDrive

public org.exoplatform.services.cms.drives.DriveData getGroupDrive(String groupId)
                                                            throws Exception

Gets the group drive.

Parameters:

groupId - the group id

Returns:

the space drive

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

getUserProfileNode

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

Gets the user profile node (a node where /Private and /Public nodes live).

Parameters:

userName - the user name

Returns:

the user profile node

Throws:

Exception - the exception

shareToUser

public void shareToUser(javax.jcr.Node fileNode,
                        String userId,
                        boolean canEdit)
                 throws javax.jcr.RepositoryException

Share cloud file to an user by its ID.

Parameters:

fileNode - the file node

userId - the user id

canEdit - the can edit flag, if true then user should be able to modify the shared link node, read-only link otherwise

Throws:

javax.jcr.RepositoryException - the repository exception

unshareToUser

public void unshareToUser(javax.jcr.Node fileNode,
                          String userId)
                   throws javax.jcr.RepositoryException

Unshare to user.

Parameters:

fileNode - the file node

userId - the user id

Throws:

javax.jcr.RepositoryException - the repository exception

shareToGroup

public void shareToGroup(javax.jcr.Node fileNode,
                         String groupId,
                         boolean canEdit)
                  throws javax.jcr.RepositoryException

Share cloud file to a group by its ID and create a symlink in the target space.

Parameters:

fileNode - the file node

groupId - the group id

canEdit - the can edit flag, if true then group members should be able to modify the shared link node, read-only link otherwise

Throws:

javax.jcr.RepositoryException - the repository exception

unshareToSpace

public void unshareToSpace(javax.jcr.Node fileNode,
                           String groupId)
                    throws javax.jcr.RepositoryException

Unshare to space.

Parameters:

fileNode - the file node

groupId - the group id

Throws:

javax.jcr.RepositoryException - the repository 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

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

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

removeLinks

protected void removeLinks(javax.jcr.Node fileNode,
                           String identity)
                    throws javax.jcr.RepositoryException

Removes the links.

Parameters:

fileNode - the file node

identity - the shared identity

Throws:

javax.jcr.RepositoryException - the repository exception

getCloudFileLinks

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

Gets the cloud file links.

Parameters:

targetNode - the target node

shareIdentity - the share identity

scopePath - the scope path (only nodes from this sub-tree will be searched)

useSystemSession - the use system session

Returns:

the cloud file links

Throws:

javax.jcr.RepositoryException - the repository exception

getMembershipName

protected String getMembershipName(String membershipType)

Gets organizational membership name by its type name.

Parameters:

membershipType - the membership type

Returns:

the membership name

removePermission

protected void removePermission(javax.jcr.Node node,
                                String permIdentity)

Removes the permission of an identity on given node.

Parameters:

node - the node, expected ExtendedNode here

permIdentity - the identity, it should include membership if actual (e.g. for space it's *:/space/my_team, but simply john for an user)

setUserFilePermission

protected void setUserFilePermission(javax.jcr.Node fileNode,
                                     String userId,
                                     boolean forcePrivilegeable)
                              throws javax.jcr.RepositoryException

Adds the user permission.

Parameters:

fileNode - the file node

userId - the user id

forcePrivilegeable - if need force adding of exo:privilegeable mixin to the node

Throws:

javax.jcr.RepositoryException - the repository exception

setGroupFilePermission

protected void setGroupFilePermission(javax.jcr.Node fileNode,
                                      String groupId,
                                      boolean forcePrivilegeable)
                               throws javax.jcr.RepositoryException

Adds the group permission for cloud file.

Parameters:

fileNode - the node

groupId - the group id

forcePrivilegeable - if need force adding of exo:privilegeable mixin to the node

Throws:

javax.jcr.RepositoryException - the repository exception

setLinkPermission

protected void setLinkPermission(javax.jcr.Node linkNode,
                                 String ownerId,
                                 String sharedIdentity,
                                 boolean canEdit)
                          throws AccessControlException,
                                 javax.jcr.RepositoryException

Adds the permission for a cloud file link: user who shared and to whom or group manager have full permissions, others can read only.

Parameters:

linkNode - the node

ownerId - the owner id

sharedIdentity - the group id

canEdit - the can edit flag

Throws:

AccessControlException - the access control exception

javax.jcr.RepositoryException - the repository exception

initCloudFileLink

protected void initCloudFileLink(javax.jcr.Node fileNode,
                                 String identity,
                                 String targetPath,
                                 boolean canEdit)

Initialize the cloud file link node (mixin node type and permissions).

Parameters:

fileNode - the file node

identity - the identity this link was shared to

targetPath - the target path

canEdit - the can edit flag

removeWritePermissions

protected void removeWritePermissions(org.exoplatform.services.jcr.core.ExtendedNode target,
                                      String groupOrUserId)
                               throws javax.jcr.RepositoryException

Remove write permissions for all kinds of membership for this group or user.

Parameters:

target - the target

groupOrUserId - the group or user id

Throws:

javax.jcr.RepositoryException - the repository exception

getCloudFileLinks

public 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