org.nuxeo.ecm.user.registration

Class UserRegistrationComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.user.invite.UserInvitationComponent

org.nuxeo.ecm.user.registration.UserRegistrationComponent

All Implemented Interfaces:

UserInvitationService, UserRegistrationService, Adaptable, Component, Extensible, TimestampedService

public class UserRegistrationComponent
extends UserInvitationComponent
implements UserRegistrationService

Nested Class Summary

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

UserInvitationService.ValidationMethod

Field Summary

Fields inherited from class org.nuxeo.ecm.user.invite.UserInvitationComponent

NUXEO_URL_KEY

Fields inherited from interface org.nuxeo.ecm.user.registration.UserRegistrationService

CONFIGURATION_NAME

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

REGISTRATION_CONFIGURATION_NAME, REGISTRATION_DATA_DOC, REGISTRATION_DATA_USER

Constructor Summary

Constructors

Constructor and Description
UserRegistrationComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRightsOnDoc(CoreSession session, DocumentModel registrationDoc) Add an ACL with the right specified in the registration Doc or nothing, if no rights needed.
String	getNameEventRegistrationAccepted()
String	getNameEventRegistrationRejected()
String	getNameEventRegistrationSubmitted()
String	getNameEventRegistrationValidated()
String	submitRegistrationRequest(String configurationName, UserRegistrationInfo userInfo, DocumentRegistrationInfo docInfo, Map<String,Serializable> additionnalInfo, UserInvitationService.ValidationMethod validationMethod, boolean autoAccept, String principalName) Stores a registration request like submitRegistrationRequest with Document information
String	submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String,Serializable> additionnalInfo, UserInvitationService.ValidationMethod validationMethod, boolean autoAccept, String principalName) Stores a registration request and return a unique ID for it
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.ecm.user.invite.UserInvitationComponent

acceptRegistrationRequest, checkRequestId, createUser, deleteRegistrationRequests, getConfiguration, getConfiguration, getConfiguration, getConfigurationsName, getOrCreateRootDocument, getRegistrationRules, getRegistrationRulesDocument, getRegistrationsForUser, getTestedRendering, getUserRegistrationModel, registerContribution, rejectRegistrationRequest, reviveRegistrationRequests, submitRegistrationRequest, submitRegistrationRequest, validateRegistration

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

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

acceptRegistrationRequest, checkRequestId, createUser, deleteRegistrationRequests, getConfiguration, getConfiguration, getConfiguration, getConfigurationsName, getRegistrationRules, getRegistrationRulesDocument, getRegistrationsForUser, getUserRegistrationModel, rejectRegistrationRequest, reviveRegistrationRequests, submitRegistrationRequest, submitRegistrationRequest, validateRegistration

Constructor Detail

UserRegistrationComponent

public UserRegistrationComponent()

Method Detail

submitRegistrationRequest

public String submitRegistrationRequest(UserRegistrationInfo userInfo,
                               Map<String,Serializable> additionnalInfo,
                               UserInvitationService.ValidationMethod validationMethod,
                               boolean autoAccept,
                               String principalName)
                                 throws ClientException

Description copied from interface: UserRegistrationService

Stores a registration request and return a unique ID for it

Specified by:

submitRegistrationRequest in interface UserRegistrationService

Returns:

Throws:

ClientException

submitRegistrationRequest

public String submitRegistrationRequest(String configurationName,
                               UserRegistrationInfo userInfo,
                               DocumentRegistrationInfo docInfo,
                               Map<String,Serializable> additionnalInfo,
                               UserInvitationService.ValidationMethod validationMethod,
                               boolean autoAccept,
                               String principalName)
                                 throws ClientException,
                                        UserRegistrationException

Description copied from interface: UserRegistrationService

Stores a registration request like submitRegistrationRequest with Document information

Specified by:

submitRegistrationRequest in interface UserRegistrationService

Returns:

a unique ID for it`

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

Specified by:

validateRegistrationAndSendEmail in interface UserRegistrationService

Overrides:

validateRegistrationAndSendEmail in class UserInvitationComponent

Throws:

ClientException

UserRegistrationException

addRightsOnDoc

public void addRightsOnDoc(CoreSession session,
                  DocumentModel registrationDoc)
                    throws ClientException

Description copied from interface: UserRegistrationService

Add an ACL with the right specified in the registration Doc or nothing, if no rights needed.

Specified by:

addRightsOnDoc in interface UserRegistrationService

registrationDoc - containing all registration info

Throws:

ClientException

getNameEventRegistrationSubmitted

public String getNameEventRegistrationSubmitted()

Specified by:

getNameEventRegistrationSubmitted in interface UserInvitationService

Overrides:

getNameEventRegistrationSubmitted in class UserInvitationComponent

Returns:

The name of the event when the registration is submitted.

getNameEventRegistrationAccepted

public String getNameEventRegistrationAccepted()

Specified by:

getNameEventRegistrationAccepted in interface UserInvitationService

Overrides:

getNameEventRegistrationAccepted in class UserInvitationComponent

Returns:

The name of the event when the registration is accepted.

getNameEventRegistrationRejected

public String getNameEventRegistrationRejected()

Specified by:

getNameEventRegistrationRejected in interface UserInvitationService

Overrides:

getNameEventRegistrationRejected in class UserInvitationComponent

Returns:

The name of the event when the registration is rejected.

getNameEventRegistrationValidated

public String getNameEventRegistrationValidated()

Specified by:

getNameEventRegistrationValidated in interface UserInvitationService

Overrides:

getNameEventRegistrationValidated in class UserInvitationComponent

Returns:

The name of the event when the registration is validated.