org.nuxeo.ecm.user.registration

Interface UserRegistrationService

All Known Implementing Classes:

UserRegistrationComponent

public interface UserRegistrationService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserRegistrationService.ValidationMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGISTRATION_ACCEPTED_EVENT
static String	REGISTRATION_REJECTED_EVENT
static String	REGISTRATION_SUBMITTED_EVENT
static String	REGISTRATION_VALIDATED_EVENT

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) accept the registration request
NuxeoPrincipal	createUser(CoreSession session, DocumentModel registrationDoc)
UserRegistrationConfiguration	getConfiguration()
void	rejectRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) reject the registration request
String	submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String,Serializable> additionnalInfo, UserRegistrationService.ValidationMethod validationMethod, boolean autoAccept) Stores a registration request and return a unique ID for it
Map<String,Serializable>	validateRegistration(String requestId) 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

Field Detail

REGISTRATION_SUBMITTED_EVENT

static final String REGISTRATION_SUBMITTED_EVENT

See Also:

Constant Field Values

REGISTRATION_ACCEPTED_EVENT

static final String REGISTRATION_ACCEPTED_EVENT

See Also:

Constant Field Values

REGISTRATION_REJECTED_EVENT

static final String REGISTRATION_REJECTED_EVENT

See Also:

Constant Field Values

REGISTRATION_VALIDATED_EVENT

static final String REGISTRATION_VALIDATED_EVENT

See Also:

Constant Field Values

Method Detail

submitRegistrationRequest

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

Stores a registration request and return a unique ID for it

Returns:

Throws:

ClientException

UserRegistrationException

acceptRegistrationRequest

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

accept the registration request

Parameters:

requestId -

Throws:

ClientException

UserRegistrationException

rejectRegistrationRequest

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

reject the registration request

Parameters:

requestId -

Throws:

ClientException

UserRegistrationException

validateRegistration

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

Validate a registration request and generate the target User

Parameters:

requestId -

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

Parameters:

requestId -

Throws:

ClientException

UserRegistrationException

createUser

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

Throws:

ClientException

UserRegistrationException

getConfiguration

UserRegistrationConfiguration getConfiguration()