org.nuxeo.ecm.user.invite

Class UserInvitationComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.user.invite.UserInvitationComponent

All Implemented Interfaces:

UserInvitationService, Adaptable, Component, Extensible, TimestampedService

Direct Known Subclasses:

UserRegistrationComponent

public class UserInvitationComponent
extends DefaultComponent
implements UserInvitationService

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.user.invite.UserInvitationService

UserInvitationService.ValidationMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	NUXEO_URL_KEY

Fields inherited from interface org.nuxeo.ecm.user.invite.UserInvitationService

REGISTRATION_DATA_DOC, REGISTRATION_DATA_USER

Constructor Summary

Constructors

Constructor and Description
UserInvitationComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) accept the registration request
void	checkRequestId(String requestId) The method checks if the request id is a valid one.
NuxeoPrincipal	createUser(CoreSession session, DocumentModel registrationDoc)
void	deleteRegistrationRequests(CoreSession session, List<DocumentModel> registrationDocs) Delete a registration document
UserRegistrationConfiguration	getConfiguration()
UserRegistrationConfiguration	getConfiguration(DocumentModel requestDoc)
UserRegistrationConfiguration	getConfiguration(String name) Return specific configuration for the specified name
Set<String>	getConfigurationsName() List all registered onfiguration name
String	getNameEventRegistrationAccepted()
String	getNameEventRegistrationRejected()
String	getNameEventRegistrationSubmitted()
String	getNameEventRegistrationValidated()
DocumentModel	getOrCreateRootDocument(CoreSession session, String configurationName)
RegistrationRules	getRegistrationRules(String configurationName) Get registration rules adapter
DocumentModel	getRegistrationRulesDocument(CoreSession session, String configurationName) Get documentmodel that stores request configuration using RegistrationConfiguration facet.
DocumentModelList	getRegistrationsForUser(String docId, String username) Retrieve registrations for a document givent the username
String	getTestedRendering()
DocumentModel	getUserRegistrationModel(String configurationName) Create a document model for the UserRegistration doctype.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	rejectRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) reject the registration request
void	reviveRegistrationRequests(CoreSession session, List<DocumentModel> registrationDocs) Send a mail to the invited user to revive his invitation If an error occured while sending an email, it logs it and continue.
String	submitRegistrationRequest(DocumentModel userRegistrationModel, Map<String,Serializable> additionnalInfo, UserInvitationService.ValidationMethod validationMethod, boolean autoAccept) Stores a registration request and return a unique ID for it
String	submitRegistrationRequest(String configurationName, DocumentModel userRegistrationModel, Map<String,Serializable> additionnalInfo, UserInvitationService.ValidationMethod validationMethod, boolean autoAccept) Stores a resgitration request like submitRegistrationRequest with Document information
Map<String,Serializable>	validateRegistration(String requestId, Map<String,Serializable> additionnalInfo) Validate a registration request and generate the target User
Map<String,Serializable>	validateRegistrationAndSendEmail(String requestId, Map<String,Serializable> additionnalInfo) Validate a registration request and generate the target User

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

NUXEO_URL_KEY

public static final String NUXEO_URL_KEY

See Also:

Constant Field Values

Constructor Detail

UserInvitationComponent

public UserInvitationComponent()

Method Detail

getTestedRendering

public String getTestedRendering()

getUserRegistrationModel

public DocumentModel getUserRegistrationModel(String configurationName)
                                       throws ClientException

Description copied from interface: UserInvitationService

Create a document model for the UserRegistration doctype.

Specified by:

getUserRegistrationModel in interface UserInvitationService

Parameters:

configurationName - The name of the configuration.

Returns:

The document model

Throws:

ClientException

getRegistrationRulesDocument

public DocumentModel getRegistrationRulesDocument(CoreSession session,
                                         String configurationName)
                                           throws ClientException

Description copied from interface: UserInvitationService

Get documentmodel that stores request configuration using RegistrationConfiguration facet.

Specified by:

getRegistrationRulesDocument in interface UserInvitationService

Returns:

Throws:

ClientException

getOrCreateRootDocument

public DocumentModel getOrCreateRootDocument(CoreSession session,
                                    String configurationName)
                                      throws ClientException

Throws:

ClientException

submitRegistrationRequest

public String submitRegistrationRequest(DocumentModel userRegistrationModel,
                               Map<String,Serializable> additionnalInfo,
                               UserInvitationService.ValidationMethod validationMethod,
                               boolean autoAccept)
                                 throws ClientException

Description copied from interface: UserInvitationService

Stores a registration request and return a unique ID for it

Specified by:

submitRegistrationRequest in interface UserInvitationService

Returns:

Throws:

ClientException

submitRegistrationRequest

public String submitRegistrationRequest(String configurationName,
                               DocumentModel userRegistrationModel,
                               Map<String,Serializable> additionnalInfo,
                               UserInvitationService.ValidationMethod validationMethod,
                               boolean autoAccept)
                                 throws ClientException,
                                        UserRegistrationException

Description copied from interface: UserInvitationService

Stores a resgitration request like submitRegistrationRequest with Document information

Specified by:

submitRegistrationRequest in interface UserInvitationService

Returns:

a unique ID for it

Throws:

ClientException

UserRegistrationException

acceptRegistrationRequest

public void acceptRegistrationRequest(String requestId,
                             Map<String,Serializable> additionnalInfo)
                               throws ClientException,
                                      UserRegistrationException

Description copied from interface: UserInvitationService

accept the registration request

Specified by:

acceptRegistrationRequest in interface UserInvitationService

Throws:

ClientException

UserRegistrationException

rejectRegistrationRequest

public void rejectRegistrationRequest(String requestId,
                             Map<String,Serializable> additionnalInfo)
                               throws ClientException,
                                      UserRegistrationException

Description copied from interface: UserInvitationService

reject the registration request

Specified by:

rejectRegistrationRequest in interface UserInvitationService

Throws:

ClientException

UserRegistrationException

validateRegistration

public Map<String,Serializable> validateRegistration(String requestId,
                                            Map<String,Serializable> additionnalInfo)
                                              throws ClientException,
                                                     UserRegistrationException

Description copied from interface: UserInvitationService

Validate a registration request and generate the target User

Specified by:

validateRegistration in interface UserInvitationService

Throws:

ClientException

UserRegistrationException

validateRegistrationAndSendEmail

public Map<String,Serializable> validateRegistrationAndSendEmail(String requestId,
                                                        Map<String,Serializable> additionnalInfo)
                                                          throws ClientException,
                                                                 UserRegistrationException

Description copied from interface: UserInvitationService

Validate a registration request and generate the target User

Specified by:

validateRegistrationAndSendEmail in interface UserInvitationService

Throws:

ClientException

UserRegistrationException

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

createUser

public NuxeoPrincipal createUser(CoreSession session,
                        DocumentModel registrationDoc)
                          throws ClientException,
                                 UserRegistrationException

Specified by:

createUser in interface UserInvitationService

Throws:

ClientException

UserRegistrationException

getConfiguration

public UserRegistrationConfiguration getConfiguration()

Specified by:

getConfiguration in interface UserInvitationService

getConfiguration

public UserRegistrationConfiguration getConfiguration(DocumentModel requestDoc)

Specified by:

getConfiguration in interface UserInvitationService

getConfiguration

public UserRegistrationConfiguration getConfiguration(String name)

Description copied from interface: UserInvitationService

Return specific configuration for the specified name

Specified by:

getConfiguration in interface UserInvitationService

Parameters:

name - configuration name

getRegistrationRules

public RegistrationRules getRegistrationRules(String configurationName)
                                       throws ClientException

Description copied from interface: UserInvitationService

Get registration rules adapter

Specified by:

getRegistrationRules in interface UserInvitationService

Throws:

ClientException

reviveRegistrationRequests

public void reviveRegistrationRequests(CoreSession session,
                              List<DocumentModel> registrationDocs)
                                throws ClientException

Description copied from interface: UserInvitationService

Send a mail to the invited user to revive his invitation If an error occured while sending an email, it logs it and continue.

Specified by:

reviveRegistrationRequests in interface UserInvitationService

Throws:

ClientException

deleteRegistrationRequests

public void deleteRegistrationRequests(CoreSession session,
                              List<DocumentModel> registrationDocs)
                                throws ClientException

Description copied from interface: UserInvitationService

Delete a registration document

Specified by:

deleteRegistrationRequests in interface UserInvitationService

Throws:

ClientException

getConfigurationsName

public Set<String> getConfigurationsName()

Description copied from interface: UserInvitationService

List all registered onfiguration name

Specified by:

getConfigurationsName in interface UserInvitationService

getRegistrationsForUser

public DocumentModelList getRegistrationsForUser(String docId,
                                        String username)
                                          throws ClientException

Description copied from interface: UserInvitationService

Retrieve registrations for a document givent the username

Specified by:

getRegistrationsForUser in interface UserInvitationService

Throws:

ClientException

checkRequestId

public void checkRequestId(String requestId)
                    throws ClientException,
                           UserRegistrationException

Description copied from interface: UserInvitationService

The method checks if the request id is a valid one.

Specified by:

checkRequestId in interface UserInvitationService

Parameters:

requestId - The value of the request id.

Throws:

ClientException

UserRegistrationException

getNameEventRegistrationSubmitted

public String getNameEventRegistrationSubmitted()

Specified by:

getNameEventRegistrationSubmitted in interface UserInvitationService

Returns:

The name of the event when the registration is submitted.

getNameEventRegistrationAccepted

public String getNameEventRegistrationAccepted()

Specified by:

getNameEventRegistrationAccepted in interface UserInvitationService

Returns:

The name of the event when the registration is accepted.

getNameEventRegistrationRejected

public String getNameEventRegistrationRejected()

Specified by:

getNameEventRegistrationRejected in interface UserInvitationService

Returns:

The name of the event when the registration is rejected.

getNameEventRegistrationValidated

public String getNameEventRegistrationValidated()

Specified by:

getNameEventRegistrationValidated in interface UserInvitationService

Returns:

The name of the event when the registration is validated.