|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.invitation.InvitationServiceImpl
public class InvitationServiceImpl
Implementation of invitation service.
Invitation
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy |
---|
Policy.Arg |
Field Summary | |
---|---|
static int |
MAX_NUM_INVITEE_USER_NAME_GEN_TRIES
|
Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.policy.Policy |
---|
NAMESPACE |
Constructor Summary | |
---|---|
InvitationServiceImpl()
|
Method Summary | |
---|---|
Invitation |
accept(java.lang.String invitationId,
java.lang.String ticket)
Invitee accepts this invitation Nominated Invitaton process only |
Invitation |
approve(java.lang.String invitationId,
java.lang.String reason)
Moderator approves this invitation |
void |
beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
NodeServicePolicies.BeforeDeleteNodePolicy Called immediatly prior to deletion of a web site. |
Invitation |
cancel(java.lang.String invitationId)
cancel this request |
protected java.lang.String |
generateWorkflowDescription(SiteInfo siteInfo,
java.lang.String messageId)
Generates a description for the workflow |
MutableAuthenticationService |
getAuthenticationService()
|
Invitation |
getInvitation(java.lang.String invitationId)
Get an invitation from its invitation id Invitations are returned which may be in progress or completed. |
java.util.List |
getInvitationServiceWorkflowNames()
Get the names of the workflows which are managed by the invitation service |
org.alfresco.service.namespace.NamespaceService |
getNamespaceService()
|
org.alfresco.service.cmr.repository.NodeService |
getNodeService()
|
PasswordGenerator |
getPasswordGenerator()
|
org.alfresco.service.cmr.security.PermissionService |
getPermissionService()
|
PersonService |
getPersonService()
|
SiteService |
getSiteService()
|
UserNameGenerator |
getUserNameGenerator()
|
WorkflowService |
getWorkflowService()
|
void |
init()
Checks that all necessary properties and services have been provided. |
ModeratedInvitation |
inviteModerated(java.lang.String inviteeComments,
java.lang.String inviteeUserName,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole)
Start the invitation process for a ModeratedInvitation |
NominatedInvitation |
inviteNominated(java.lang.String inviteeUserName,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole,
java.lang.String serverPath,
java.lang.String acceptUrl,
java.lang.String rejectUrl)
Start the invitation process for a NominatedInvitation |
NominatedInvitation |
inviteNominated(java.lang.String inviteeFirstName,
java.lang.String inviteeLastName,
java.lang.String inviteeEmail,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole,
java.lang.String serverPath,
java.lang.String acceptUrl,
java.lang.String rejectUrl)
Start the invitation process for a NominatedInvitation |
boolean |
isSendEmails()
|
java.util.List |
listPendingInvitationsForInvitee(java.lang.String invitee)
list Invitations for a specific person/invitee |
java.util.List |
listPendingInvitationsForResource(Invitation.ResourceType resourceType,
java.lang.String resourceName)
list Invitations for a specific resource |
Invitation |
reject(java.lang.String invitationId,
java.lang.String reason)
User or moderator rejects this request |
java.util.List |
searchInvitation(InvitationSearchCriteria criteria)
This is the general search invitation method |
void |
setAuthenticationService(MutableAuthenticationService authenticationService)
|
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
|
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
|
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
|
void |
setPasswordGenerator(PasswordGenerator passwordGenerator)
|
void |
setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
|
void |
setPersonService(PersonService personService)
|
void |
setPolicyComponent(PolicyComponent policyComponent)
Set the policy component |
void |
setSendEmails(boolean sendEmails)
|
void |
setSiteService(SiteService siteService)
|
void |
setUserNameGenerator(UserNameGenerator usernameGenerator)
|
void |
setWorkflowAdminService(WorkflowAdminService workflowAdminService)
|
void |
setWorkflowService(WorkflowService workflowService)
Set the workflow service |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MAX_NUM_INVITEE_USER_NAME_GEN_TRIES
Constructor Detail |
---|
public InvitationServiceImpl()
Method Detail |
---|
public void setPolicyComponent(PolicyComponent policyComponent)
policyComponent
- policy componentpublic void init()
public java.util.List getInvitationServiceWorkflowNames()
getInvitationServiceWorkflowNames
in interface InvitationService
public NominatedInvitation inviteNominated(java.lang.String inviteeUserName, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole, java.lang.String serverPath, java.lang.String acceptUrl, java.lang.String rejectUrl)
inviteNominated
in interface InvitationService
inviteeUserName
- Alfresco user name of the inviteeInvitation
- ResourceType
- resourceTyperesourceName
- inviteeRole
- serverPath
- acceptUrl
- rejectUrl
-
InvitationException
InvitationExceptionUserError
InvitationExceptionForbidden
public NominatedInvitation inviteNominated(java.lang.String inviteeFirstName, java.lang.String inviteeLastName, java.lang.String inviteeEmail, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole, java.lang.String serverPath, java.lang.String acceptUrl, java.lang.String rejectUrl)
inviteNominated
in interface InvitationService
inviteeFirstName
- inviteeLastName
- inviteeEmail
- inviteeUserName
- optional Alfresco user name of the invitee, null
if not on system.Invitation
- .ResourceType resourceTyperesourceName
- inviteeRole
- serverPath
- acceptUrl
- rejectUrl
-
InvitationException
InvitationExceptionUserError
InvitationExceptionForbidden
public ModeratedInvitation inviteModerated(java.lang.String inviteeComments, java.lang.String inviteeUserName, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole)
inviteModerated
in interface InvitationService
comments
- why does the invitee want access to the resource ?inviteeUserName
- who is to be invitedInvitation
- .ResourceType resourceType what resource type ?resourceName
- which resourceinviteeRole
- which role ?public Invitation accept(java.lang.String invitationId, java.lang.String ticket)
accept
in interface InvitationService
invitationId
- the invitation idticket
- the ticket produced when creating the invitation.
public Invitation approve(java.lang.String invitationId, java.lang.String reason)
approve
in interface InvitationService
request
- the request to approvereason
- comments about the acceptancepublic Invitation reject(java.lang.String invitationId, java.lang.String reason)
reject
in interface InvitationService
invitationId
- reason
- , optional reason for rejectionpublic Invitation cancel(java.lang.String invitationId)
cancel
in interface InvitationService
public Invitation getInvitation(java.lang.String invitationId)
getInvitation
in interface InvitationService
InvitationExceptionNotFound
- the invitation does not exist.
InvitationExceptionUserError
public java.util.List listPendingInvitationsForInvitee(java.lang.String invitee)
listPendingInvitationsForInvitee
in interface InvitationService
invitee
- alfresco user id of person being invitedpublic java.util.List listPendingInvitationsForResource(Invitation.ResourceType resourceType, java.lang.String resourceName)
listPendingInvitationsForResource
in interface InvitationService
resourceType
- resourceName
- public java.util.List searchInvitation(InvitationSearchCriteria criteria)
searchInvitation
in interface InvitationService
criteria
-
public void setWorkflowService(WorkflowService workflowService)
workflowService
- public void setWorkflowAdminService(WorkflowAdminService workflowAdminService)
workflowAdminService
- the workflowAdminService to setpublic WorkflowService getWorkflowService()
public void setPersonService(PersonService personService)
public PersonService getPersonService()
public void setSiteService(SiteService siteService)
public SiteService getSiteService()
public void setAuthenticationService(MutableAuthenticationService authenticationService)
public MutableAuthenticationService getAuthenticationService()
public void setUserNameGenerator(UserNameGenerator usernameGenerator)
public UserNameGenerator getUserNameGenerator()
public void setPasswordGenerator(PasswordGenerator passwordGenerator)
public PasswordGenerator getPasswordGenerator()
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
public org.alfresco.service.namespace.NamespaceService getNamespaceService()
public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
public org.alfresco.service.cmr.security.PermissionService getPermissionService()
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
public org.alfresco.service.cmr.repository.NodeService getNodeService()
public void beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
beforeDeleteNode
in interface NodeServicePolicies.BeforeDeleteNodePolicy
nodeRef
- the node referenceprotected java.lang.String generateWorkflowDescription(SiteInfo siteInfo, java.lang.String messageId)
siteInfo
- The site to generate a description formessageId
- The resource bundle key to use for the description
public void setSendEmails(boolean sendEmails)
sendEmails
- the sendEmails to setpublic boolean isSendEmails()
isSendEmails
in interface InvitationService
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |