org.nuxeo.ecm.user.registration

Interface UserRegistrationService

All Superinterfaces:

UserInvitationService

All Known Implementing Classes:

UserRegistrationComponent

public interface UserRegistrationService
extends 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	CONFIGURATION_NAME

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

REGISTRATION_DATA_DOC, REGISTRATION_DATA_USER

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	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 interface org.nuxeo.ecm.user.invite.UserInvitationService

acceptRegistrationRequest, checkRequestId, createUser, deleteRegistrationRequests, getConfiguration, getConfiguration, getConfiguration, getConfigurationsName, getNameEventRegistrationAccepted, getNameEventRegistrationRejected, getNameEventRegistrationSubmitted, getNameEventRegistrationValidated, getRegistrationRules, getRegistrationRulesDocument, getRegistrationsForUser, getUserRegistrationModel, rejectRegistrationRequest, reviveRegistrationRequests, submitRegistrationRequest, submitRegistrationRequest, validateRegistration

Field Detail

CONFIGURATION_NAME

static final String CONFIGURATION_NAME

See Also:

Constant Field Values

Method Detail

submitRegistrationRequest

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

Stores a registration request and return a unique ID for it

Returns:

Throws:

ClientException

UserRegistrationException

validateRegistrationAndSendEmail

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

Validate a registration request and generate the target User

Specified by:

validateRegistrationAndSendEmail in interface UserInvitationService

Parameters:

requestId -

Throws:

ClientException

UserRegistrationException

addRightsOnDoc

void addRightsOnDoc(CoreSession session,
                  DocumentModel registrationDoc)
                    throws ClientException

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

Parameters:

registrationDoc - containing all registration info

Throws:

ClientException

Since:

5.6

submitRegistrationRequest

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

Stores a registration request like submitRegistrationRequest with Document information

Returns:

a unique ID for it`

Throws:

ClientException

UserRegistrationException

Since:

5.6