org.nuxeo.ecm.user.invite

Interface UserInvitationService

All Known Implementing Classes:

UserInvitationComponent

public interface UserInvitationService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserInvitationService.ValidationMethod

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGISTRATION_DATA_DOC
static String	REGISTRATION_DATA_USER

Method Summary

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.
org.nuxeo.ecm.core.api.NuxeoPrincipal	createUser(org.nuxeo.ecm.core.api.CoreSession session, org.nuxeo.ecm.core.api.DocumentModel registrationDoc)
void	deleteRegistrationRequests(org.nuxeo.ecm.core.api.CoreSession session, List<org.nuxeo.ecm.core.api.DocumentModel> registrationDoc) Delete a registration document
UserRegistrationConfiguration	getConfiguration()
UserRegistrationConfiguration	getConfiguration(org.nuxeo.ecm.core.api.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()
RegistrationRules	getRegistrationRules(String configurationName) Get registration rules adapter
org.nuxeo.ecm.core.api.DocumentModel	getRegistrationRulesDocument(org.nuxeo.ecm.core.api.CoreSession session, String configurationName) Get documentmodel that stores request configuration using RegistrationConfiguration facet.
org.nuxeo.ecm.core.api.DocumentModelList	getRegistrationsForUser(String docId, String username) Retrieve registrations for a document givent the username
org.nuxeo.ecm.core.api.DocumentModel	getUserRegistrationModel(String configurationName) Create a document model for the UserRegistration doctype.
void	rejectRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) reject the registration request
void	reviveRegistrationRequests(org.nuxeo.ecm.core.api.CoreSession session, List<org.nuxeo.ecm.core.api.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(org.nuxeo.ecm.core.api.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, org.nuxeo.ecm.core.api.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

Field Detail

REGISTRATION_DATA_DOC

static final String REGISTRATION_DATA_DOC

See Also:

Constant Field Values

REGISTRATION_DATA_USER

static final String REGISTRATION_DATA_USER

See Also:

Constant Field Values

Method Detail

getUserRegistrationModel

org.nuxeo.ecm.core.api.DocumentModel getUserRegistrationModel(String configurationName)
                                                       throws org.nuxeo.ecm.core.api.ClientException

Create a document model for the UserRegistration doctype.

Parameters:

configurationName - The name of the configuration.

Returns:

The document model

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.9.3

submitRegistrationRequest

String submitRegistrationRequest(org.nuxeo.ecm.core.api.DocumentModel userRegistrationModel,
                                 Map<String,Serializable> additionnalInfo,
                                 UserInvitationService.ValidationMethod validationMethod,
                                 boolean autoAccept)
                          throws org.nuxeo.ecm.core.api.ClientException,
                                 UserRegistrationException

Stores a registration request and return a unique ID for it

Returns:

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

acceptRegistrationRequest

void acceptRegistrationRequest(String requestId,
                               Map<String,Serializable> additionnalInfo)
                        throws org.nuxeo.ecm.core.api.ClientException,
                               UserRegistrationException

accept the registration request

Parameters:

requestId -

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

rejectRegistrationRequest

void rejectRegistrationRequest(String requestId,
                               Map<String,Serializable> additionnalInfo)
                        throws org.nuxeo.ecm.core.api.ClientException,
                               UserRegistrationException

reject the registration request

Parameters:

requestId -

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

validateRegistration

Map<String,Serializable> validateRegistration(String requestId,
                                              Map<String,Serializable> additionnalInfo)
                                       throws org.nuxeo.ecm.core.api.ClientException

Validate a registration request and generate the target User

Parameters:

requestId -

Throws:

org.nuxeo.ecm.core.api.ClientException

validateRegistrationAndSendEmail

Map<String,Serializable> validateRegistrationAndSendEmail(String requestId,
                                                          Map<String,Serializable> additionnalInfo)
                                                   throws org.nuxeo.ecm.core.api.ClientException,
                                                          UserRegistrationException

Validate a registration request and generate the target User

Parameters:

requestId -

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

createUser

org.nuxeo.ecm.core.api.NuxeoPrincipal createUser(org.nuxeo.ecm.core.api.CoreSession session,
                                                 org.nuxeo.ecm.core.api.DocumentModel registrationDoc)
                                          throws org.nuxeo.ecm.core.api.ClientException,
                                                 UserRegistrationException

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

reviveRegistrationRequests

void reviveRegistrationRequests(org.nuxeo.ecm.core.api.CoreSession session,
                                List<org.nuxeo.ecm.core.api.DocumentModel> registrationDocs)
                         throws org.nuxeo.ecm.core.api.ClientException

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

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

deleteRegistrationRequests

void deleteRegistrationRequests(org.nuxeo.ecm.core.api.CoreSession session,
                                List<org.nuxeo.ecm.core.api.DocumentModel> registrationDoc)
                         throws org.nuxeo.ecm.core.api.ClientException

Delete a registration document

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getConfiguration

UserRegistrationConfiguration getConfiguration()

getRegistrationsForUser

org.nuxeo.ecm.core.api.DocumentModelList getRegistrationsForUser(String docId,
                                                                 String username)
                                                          throws org.nuxeo.ecm.core.api.ClientException

Retrieve registrations for a document givent the username

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getConfiguration

UserRegistrationConfiguration getConfiguration(String name)

Return specific configuration for the specified name

Parameters:

name - configuration name

Since:

5.6

getConfiguration

UserRegistrationConfiguration getConfiguration(org.nuxeo.ecm.core.api.DocumentModel requestDoc)

Since:

5.6

getRegistrationRulesDocument

org.nuxeo.ecm.core.api.DocumentModel getRegistrationRulesDocument(org.nuxeo.ecm.core.api.CoreSession session,
                                                                  String configurationName)
                                                           throws org.nuxeo.ecm.core.api.ClientException

Get documentmodel that stores request configuration using RegistrationConfiguration facet.

Parameters:

session -

Returns:

Throws:

org.nuxeo.ecm.core.api.ClientException

submitRegistrationRequest

String submitRegistrationRequest(String configurationName,
                                 org.nuxeo.ecm.core.api.DocumentModel userRegistrationModel,
                                 Map<String,Serializable> additionnalInfo,
                                 UserInvitationService.ValidationMethod validationMethod,
                                 boolean autoAccept)
                          throws org.nuxeo.ecm.core.api.ClientException,
                                 UserRegistrationException

Stores a resgitration request like submitRegistrationRequest with Document information

Returns:

a unique ID for it

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

Since:

5.6

getRegistrationRules

RegistrationRules getRegistrationRules(String configurationName)
                                throws org.nuxeo.ecm.core.api.ClientException

Get registration rules adapter

Throws:

org.nuxeo.ecm.core.api.ClientException

Since:

5.6

getConfigurationsName

Set<String> getConfigurationsName()

List all registered onfiguration name

checkRequestId

void checkRequestId(String requestId)
             throws org.nuxeo.ecm.core.api.ClientException,
                    UserRegistrationException

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

Parameters:

requestId - The value of the request id.

Throws:

org.nuxeo.ecm.core.api.ClientException

UserRegistrationException

Since:

5.9.3

getNameEventRegistrationSubmitted

String getNameEventRegistrationSubmitted()

Returns:

The name of the event when the registration is submitted.

Since:

5.9.3

getNameEventRegistrationAccepted

String getNameEventRegistrationAccepted()

Returns:

The name of the event when the registration is accepted.

Since:

5.9.3

getNameEventRegistrationRejected

String getNameEventRegistrationRejected()

Returns:

The name of the event when the registration is rejected.

Since:

5.9.3

getNameEventRegistrationValidated

String getNameEventRegistrationValidated()

Returns:

The name of the event when the registration is validated.

Since:

5.9.3