org.alfresco.repo.invitation

Class InviteHelper

java.lang.Object

org.alfresco.repo.invitation.InviteHelper

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class InviteHelper
extends Object
implements org.springframework.beans.factory.InitializingBean

Helper class to house utility methods common to more than one Invite Service Web Script

Author:

Nick Smith

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
InviteHelper()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptNominatedInvitation(Map<String,Object> executionVariables)
void	addSiteMembership(String invitee, String siteName, String role, String runAsUser, boolean overrideExisting) Add Invitee to Site with the site role that the inviter "started" the invite process with
void	afterPropertiesSet()
void	approveModeratedInvitation(Map<String,Object> executionVariables)
void	cancelInvitation(Map<String,Object> executionVariables, String currentInviteId)
void	deleteAuthenticationIfUnused(String inviteeUserName, String currentInviteId) Clean up invitee user account and person node when no longer in use.
List<WorkflowTask>	findInvitePendingTasks(String inviteeUserName) Find invitePending tasks (in-progress) by the given invitee user name
WorkflowTask	findInviteStartTask(String inviteId) Find an invite start task by the given task id.
InviteInfo	getPendingInviteInfo(WorkflowTask startInviteTask) Returns an InviteInfo instance for the given startInvite task (used for rendering the response).
void	rejectModeratedInvitation(Map<String,Object> vars)
void	sendNominatedInvitation(String inviteId, Map<String,Object> executionVariables)
void	setMessageService(MessageService messageService)
void	setRepositoryHelper(Repository repositoryHelper)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

InviteHelper

public InviteHelper()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

acceptNominatedInvitation

public void acceptNominatedInvitation(Map<String,Object> executionVariables)

findInviteStartTask

public WorkflowTask findInviteStartTask(String inviteId)

Find an invite start task by the given task id.

Returns:

a WorkflowTask or null if not found.

findInvitePendingTasks

public List<WorkflowTask> findInvitePendingTasks(String inviteeUserName)

Find invitePending tasks (in-progress) by the given invitee user name

Returns:

a list of workflow tasks

getPendingInviteInfo

public InviteInfo getPendingInviteInfo(WorkflowTask startInviteTask)

Returns an InviteInfo instance for the given startInvite task (used for rendering the response).

Parameters:

startInviteTask - startInvite task to get invite info properties from

serviceRegistry - service registry instance

Returns:

InviteInfo instance containing invite information

addSiteMembership

public void addSiteMembership(String invitee,
                     String siteName,
                     String role,
                     String runAsUser,
                     boolean overrideExisting)

Add Invitee to Site with the site role that the inviter "started" the invite process with

Parameters:

invitee -

siteName -

role -

runAsUser -

siteService -

overrideExisting -

deleteAuthenticationIfUnused

public void deleteAuthenticationIfUnused(String inviteeUserName,
                                String currentInviteId)

Clean up invitee user account and person node when no longer in use. They are deemed to no longer be in use when the invitee user account is still disabled and there are no outstanding pending invites for that invitee.

Parameters:

inviteeUserName -

currentInviteId - TODO

authenticationservice -

personService -

workflowService -

cancelInvitation

public void cancelInvitation(Map<String,Object> executionVariables,
                    String currentInviteId)

Parameters:

executionVariables -

sendNominatedInvitation

public void sendNominatedInvitation(String inviteId,
                           Map<String,Object> executionVariables)

approveModeratedInvitation

public void approveModeratedInvitation(Map<String,Object> executionVariables)

rejectModeratedInvitation

public void rejectModeratedInvitation(Map<String,Object> vars)

Parameters:

vars -

setMessageService

public void setMessageService(MessageService messageService)

Parameters:

messageService - the messageService to set

setRepositoryHelper

public void setRepositoryHelper(Repository repositoryHelper)

Parameters:

repositoryHelper - the repositoryHelper to set

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Parameters:

serviceRegistry - the serviceRegistry to set