org.alfresco.repo.quickshare

Class QuickShareServiceImpl

java.lang.Object

org.alfresco.repo.quickshare.QuickShareServiceImpl

All Implemented Interfaces:

CopyServicePolicies.OnCopyNodePolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.OnRestoreNodePolicy, ClassPolicy, Policy, QuickShareService

public class QuickShareServiceImpl
extends Object
implements QuickShareService, NodeServicePolicies.BeforeDeleteNodePolicy, CopyServicePolicies.OnCopyNodePolicy, NodeServicePolicies.OnRestoreNodePolicy

QuickShare Service implementation. In addition to the quick share service, this class also provides a BeforeDeleteNodePolicy and OnCopyNodePolicy for content with the QuickShare aspect.

Author:

Alex Miller, janv, Jamal Kaabi-Mofrad

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuickShareServiceImpl.QuickShareEmailRequest Represents an email request to send a quick share link.

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.OnCopyNodePolicy

ARG_0, ARG_1, QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnRestoreNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor and Description
QuickShareServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef beforeDeleteNodeRef) Called before a node is deleted.
boolean	canDeleteSharedLink(org.alfresco.service.cmr.repository.NodeRef nodeRef, String sharedByUserId) Determine if the current user has permission to delete the shared link.
boolean	canRead(String sharedId) Determine if the current user has permission to read the shared content.
protected void	deleteQuickShareLinkExpiryAction(org.alfresco.service.cmr.repository.NodeRef linkExpiryActionNodeRef) Removes (hard deletes) the previously persisted QuickShareLinkExpiryAction and its related schedule ScheduledPersistedAction from the repository.
void	deleteQuickShareLinkExpiryAction(QuickShareLinkExpiryAction linkExpiryAction) Removes (hard deletes) the previously persisted QuickShareLinkExpiryAction and its related schedule ScheduledPersistedAction from the repository.
CopyBehaviourCallback	getCopyCallback(org.alfresco.service.namespace.QName classRef, CopyDetails copyDetails) Called for all types and aspects before copying a node.
Map<String,Object>	getMetaData(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get QuickShare related metadata for the given node.
Map<String,Object>	getMetaData(String sharedId) Get QuickShare related metadata for the given shareId.
protected String	getSharedLinkEmailTemplatePath(ClientAppConfig.ClientApp clientApp)
org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef>	getTenantNodeRefFromSharedId(String sharedId) Get the tenant domain and node reference for the the given share id.
void	init() The initialise method.
boolean	isQuickShareEnabled() Whether the quick share is enabled or not.
void	onRestoreNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef) Called after an archived node is restored.
protected void	saveSharedLinkExpiryAction(String sharedId, Date expiryDate) Creates and persists the quick share link expiry action and its related schedule.
void	sendEmailNotification(QuickShareServiceImpl.QuickShareEmailRequest emailRequest) Notifies users by email that a content has been shared with them, and the details of it.
void	setActionService(ActionService actionService) Set the actionService
void	setAttributeService(AttributeService attributeService) Set the attribute service
void	setAuthorityService(AuthorityService authorityService) Spring configuration
void	setBehaviourFilter(BehaviourFilter behaviourFilter) Spring configuration
void	setClientAppConfig(ClientAppConfig clientAppConfig) Set the quickShare clientAppConfig
void	setDefaultEmailSender(String defaultEmailSender) Set the default email sender
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) Set the dictionary service
void	setEmailHelper(EmailHelper emailHelper) Spring configuration
void	setEnabled(boolean enabled) Enable or disable this service.
void	setEventPublisher(org.alfresco.repo.events.EventPublisher eventPublisher) Set the eventPublisher
void	setExpiryDatePeriod(String expiryDatePeriod) Spring configuration
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService) Set the Permission service
void	setPersonService(PersonService personService) Set the person service
void	setPolicyComponent(PolicyComponent policyComponent) Set the policy component
void	setQuickShareLinkExpiryActionPersister(QuickShareLinkExpiryActionPersister quickShareLinkExpiryActionPersister) Spring configuration
void	setScheduledPersistedActionService(ScheduledPersistedActionService scheduledPersistedActionService) Spring configuration
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService) Spring configuration
void	setSiteService(SiteService siteService) Spring configuration
void	setSysAdminParams(SysAdminParams sysAdminParams) Spring configuration
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService) Set the tenant service
void	setThumbnailService(ThumbnailService thumbnailService) Set the thumbnail service
QuickShareDTO	shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef) Share content identified by nodeRef.
QuickShareDTO	shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef, Date expiryDate) Share content identified by nodeRef and optionally set an expiry date for the shared link.
void	unshareContent(String sharedId) Unshare the content identified by sharedId

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickShareServiceImpl

public QuickShareServiceImpl()

Method Detail

setAttributeService

public void setAttributeService(AttributeService attributeService)

Set the attribute service

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Set the dictionary service

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

Set the Permission service

setPersonService

public void setPersonService(PersonService personService)

Set the person service

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

Set the policy component

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

Set the tenant service

setThumbnailService

public void setThumbnailService(ThumbnailService thumbnailService)

Set the thumbnail service

setEventPublisher

public void setEventPublisher(org.alfresco.repo.events.EventPublisher eventPublisher)

Set the eventPublisher

setActionService

public void setActionService(ActionService actionService)

Set the actionService

setBehaviourFilter

public void setBehaviourFilter(BehaviourFilter behaviourFilter)

Spring configuration

Parameters:

behaviourFilter - the behaviourFilter to set

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

Spring configuration

Parameters:

searchService - the searchService to set

setSiteService

public void setSiteService(SiteService siteService)

Spring configuration

Parameters:

siteService - the siteService to set

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Spring configuration

Parameters:

authorityService - the authorityService to set

setSysAdminParams

public void setSysAdminParams(SysAdminParams sysAdminParams)

Spring configuration

Parameters:

sysAdminParams - the sysAdminParams to set

setEmailHelper

public void setEmailHelper(EmailHelper emailHelper)

Spring configuration

Parameters:

emailHelper - the emailHelper to set

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this service.

setDefaultEmailSender

public void setDefaultEmailSender(String defaultEmailSender)

Set the default email sender

setClientAppConfig

public void setClientAppConfig(ClientAppConfig clientAppConfig)

Set the quickShare clientAppConfig

setScheduledPersistedActionService

public void setScheduledPersistedActionService(ScheduledPersistedActionService scheduledPersistedActionService)

Spring configuration

Parameters:

scheduledPersistedActionService - the scheduledPersistedActionService to set

setQuickShareLinkExpiryActionPersister

public void setQuickShareLinkExpiryActionPersister(QuickShareLinkExpiryActionPersister quickShareLinkExpiryActionPersister)

Spring configuration

Parameters:

quickShareLinkExpiryActionPersister - the quickShareLinkExpiryActionPersister to set

setExpiryDatePeriod

public void setExpiryDatePeriod(String expiryDatePeriod)

Spring configuration

Parameters:

expiryDatePeriod - the expiryDatePeriod to set

init

public void init()

The initialise method. Register our policies.

shareContent

public QuickShareDTO shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: QuickShareService

Share content identified by nodeRef.

Specified by:

shareContent in interface QuickShareService

Parameters:

nodeRef - The NodeRef of the content to share

Returns:

QuickDTO with details of the share

shareContent

public QuickShareDTO shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                  Date expiryDate)
                           throws QuickShareDisabledException,
                                  org.alfresco.service.cmr.repository.InvalidNodeRefException

Description copied from interface: QuickShareService

Share content identified by nodeRef and optionally set an expiry date for the shared link.

Specified by:

shareContent in interface QuickShareService

Parameters:

nodeRef - The NodeRef of the content to share

expiryDate - The expiry date of the shared link

Returns:

QuickDTO with details of the share

Throws:

QuickShareDisabledException

org.alfresco.service.cmr.repository.InvalidNodeRefException

getMetaData

public Map<String,Object> getMetaData(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: QuickShareService

Get QuickShare related metadata for the given node.

Specified by:

getMetaData in interface QuickShareService

Parameters:

nodeRef - NodeRef

Returns:

Map

getTenantNodeRefFromSharedId

public org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef> getTenantNodeRefFromSharedId(String sharedId)

Description copied from interface: QuickShareService

Get the tenant domain and node reference for the the given share id.

Specified by:

getTenantNodeRefFromSharedId in interface QuickShareService

Parameters:

sharedId - String

Returns:

Pair

getMetaData

public Map<String,Object> getMetaData(String sharedId)

Description copied from interface: QuickShareService

Get QuickShare related metadata for the given shareId.

Specified by:

getMetaData in interface QuickShareService

Parameters:

sharedId - String

Returns:

Map

beforeDeleteNode

public void beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef beforeDeleteNodeRef)

Description copied from interface: NodeServicePolicies.BeforeDeleteNodePolicy

Called before a node is deleted.

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

Parameters:

beforeDeleteNodeRef - the node reference

onRestoreNode

public void onRestoreNode(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef)

Description copied from interface: NodeServicePolicies.OnRestoreNodePolicy

Called after an archived node is restored.

Specified by:

onRestoreNode in interface NodeServicePolicies.OnRestoreNodePolicy

Parameters:

childAssocRef - the newly created child association reference

unshareContent

public void unshareContent(String sharedId)

Description copied from interface: QuickShareService

Unshare the content identified by sharedId

Specified by:

unshareContent in interface QuickShareService

Parameters:

sharedId - The shared id of the content to unshare.

getCopyCallback

public CopyBehaviourCallback getCopyCallback(org.alfresco.service.namespace.QName classRef,
                                             CopyDetails copyDetails)

Description copied from interface: CopyServicePolicies.OnCopyNodePolicy

Called for all types and aspects before copying a node.

Specified by:

getCopyCallback in interface CopyServicePolicies.OnCopyNodePolicy

Parameters:

classRef - the type or aspect qualified name

copyDetails - the details of the impending copy

Returns:

Return the callback that will be used to modify the copy behaviour for this dictionary class. Return null to assume the default.

See Also:

CopyServicePolicies

canRead

public boolean canRead(String sharedId)

Description copied from interface: QuickShareService

Determine if the current user has permission to read the shared content.

Specified by:

canRead in interface QuickShareService

sendEmailNotification

public void sendEmailNotification(QuickShareServiceImpl.QuickShareEmailRequest emailRequest)

Description copied from interface: QuickShareService

Notifies users by email that a content has been shared with them, and the details of it.

Specified by:

sendEmailNotification in interface QuickShareService

Parameters:

emailRequest - The email details including its template details

getSharedLinkEmailTemplatePath

protected String getSharedLinkEmailTemplatePath(ClientAppConfig.ClientApp clientApp)

canDeleteSharedLink

public boolean canDeleteSharedLink(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                   String sharedByUserId)

Description copied from interface: QuickShareService

Determine if the current user has permission to delete the shared link.

Specified by:

canDeleteSharedLink in interface QuickShareService

isQuickShareEnabled

public boolean isQuickShareEnabled()

Description copied from interface: QuickShareService

Whether the quick share is enabled or not.

Specified by:

isQuickShareEnabled in interface QuickShareService

Returns:

true if quick share is enabled, false otherwise.

saveSharedLinkExpiryAction

protected void saveSharedLinkExpiryAction(String sharedId,
                                          Date expiryDate)

Creates and persists the quick share link expiry action and its related schedule.

deleteQuickShareLinkExpiryAction

public void deleteQuickShareLinkExpiryAction(QuickShareLinkExpiryAction linkExpiryAction)

Description copied from interface: QuickShareService

Removes (hard deletes) the previously persisted QuickShareLinkExpiryAction and its related schedule ScheduledPersistedAction from the repository.

Specified by:

deleteQuickShareLinkExpiryAction in interface QuickShareService

Parameters:

linkExpiryAction - The QuickShareLinkExpiryAction to be deleted.

deleteQuickShareLinkExpiryAction

protected void deleteQuickShareLinkExpiryAction(org.alfresco.service.cmr.repository.NodeRef linkExpiryActionNodeRef)

Removes (hard deletes) the previously persisted QuickShareLinkExpiryAction and its related schedule ScheduledPersistedAction from the repository.