public interface UserRegistrationService
Modifier and Type | Interface and Description |
---|---|
static class |
UserRegistrationService.ValidationMethod |
Modifier and Type | Field and Description |
---|---|
static String |
REGISTRATION_ACCEPTED_EVENT |
static String |
REGISTRATION_DATA_DOC |
static String |
REGISTRATION_DATA_USER |
static String |
REGISTRATION_REJECTED_EVENT |
static String |
REGISTRATION_SUBMITTED_EVENT |
static String |
REGISTRATION_VALIDATED_EVENT |
Modifier and Type | Method and Description |
---|---|
void |
acceptRegistrationRequest(String requestId,
Map<String,Serializable> additionnalInfo)
accept the registration request
|
void |
addRightsOnDoc(CoreSession session,
DocumentModel registrationDoc)
Add an ACL with the right specified in the registration Doc or nothing,
if no rights needed.
|
NuxeoPrincipal |
createUser(CoreSession session,
DocumentModel registrationDoc) |
void |
deleteRegistrationRequests(CoreSession session,
List<DocumentModel> registrationDoc)
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
|
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
|
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(String configurationName,
UserRegistrationInfo userInfo,
DocumentRegistrationInfo docInfo,
Map<String,Serializable> additionnalInfo,
UserRegistrationService.ValidationMethod validationMethod,
boolean autoAccept)
Stores a resgitration request like submitRegistrationRequest with
Document information
|
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,
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
|
static final String REGISTRATION_DATA_DOC
static final String REGISTRATION_DATA_USER
static final String REGISTRATION_SUBMITTED_EVENT
static final String REGISTRATION_ACCEPTED_EVENT
static final String REGISTRATION_REJECTED_EVENT
static final String REGISTRATION_VALIDATED_EVENT
String submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String,Serializable> additionnalInfo, UserRegistrationService.ValidationMethod validationMethod, boolean autoAccept) throws ClientException, UserRegistrationException
ClientException
UserRegistrationException
void acceptRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
requestId
- ClientException
UserRegistrationException
void rejectRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
requestId
- ClientException
UserRegistrationException
Map<String,Serializable> validateRegistration(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException
requestId
- ClientException
Map<String,Serializable> validateRegistrationAndSendEmail(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
requestId
- ClientException
UserRegistrationException
NuxeoPrincipal createUser(CoreSession session, DocumentModel registrationDoc) throws ClientException, UserRegistrationException
void reviveRegistrationRequests(CoreSession session, List<DocumentModel> registrationDocs) throws ClientException
ClientException
void deleteRegistrationRequests(CoreSession session, List<DocumentModel> registrationDoc) throws ClientException
ClientException
void addRightsOnDoc(CoreSession session, DocumentModel registrationDoc) throws ClientException
registrationDoc
- containing all registration infoClientException
UserRegistrationConfiguration getConfiguration()
DocumentModelList getRegistrationsForUser(String docId, String username) throws ClientException
ClientException
UserRegistrationConfiguration getConfiguration(String name)
name
- configuration nameUserRegistrationConfiguration getConfiguration(DocumentModel requestDoc)
DocumentModel getRegistrationRulesDocument(CoreSession session, String configurationName) throws ClientException
session
- ClientException
String submitRegistrationRequest(String configurationName, UserRegistrationInfo userInfo, DocumentRegistrationInfo docInfo, Map<String,Serializable> additionnalInfo, UserRegistrationService.ValidationMethod validationMethod, boolean autoAccept) throws ClientException, UserRegistrationException
ClientException
UserRegistrationException
RegistrationRules getRegistrationRules(String configurationName) throws ClientException
ClientException
Copyright © 2012 Nuxeo SA. All Rights Reserved.