public class UserRegistrationComponent extends DefaultComponent implements UserRegistrationService
UserRegistrationService.ValidationMethod
Modifier and Type | Field and Description |
---|---|
static String |
NUXEO_URL_KEY |
REGISTRATION_ACCEPTED_EVENT, REGISTRATION_DATA_DOC, REGISTRATION_DATA_USER, REGISTRATION_REJECTED_EVENT, REGISTRATION_SUBMITTED_EVENT, REGISTRATION_VALIDATED_EVENT
Constructor and Description |
---|
UserRegistrationComponent() |
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> registrationDocs)
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
|
String |
getTestedRendering() |
void |
registerContribution(Object contribution,
String extensionPoint,
ComponentInstance contributor) |
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
|
activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterContribution, unregisterExtension
public static final String NUXEO_URL_KEY
public String getTestedRendering()
public DocumentModel getRegistrationRulesDocument(CoreSession session, String configurationName) throws ClientException
UserRegistrationService
getRegistrationRulesDocument
in interface UserRegistrationService
ClientException
public String submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String,Serializable> additionnalInfo, UserRegistrationService.ValidationMethod validationMethod, boolean autoAccept) throws ClientException
UserRegistrationService
submitRegistrationRequest
in interface UserRegistrationService
ClientException
public String submitRegistrationRequest(String configurationName, UserRegistrationInfo userInfo, DocumentRegistrationInfo docInfo, Map<String,Serializable> additionnalInfo, UserRegistrationService.ValidationMethod validationMethod, boolean autoAccept) throws ClientException, UserRegistrationException
UserRegistrationService
submitRegistrationRequest
in interface UserRegistrationService
ClientException
UserRegistrationException
public void acceptRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
UserRegistrationService
acceptRegistrationRequest
in interface UserRegistrationService
ClientException
UserRegistrationException
public void rejectRegistrationRequest(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
UserRegistrationService
rejectRegistrationRequest
in interface UserRegistrationService
ClientException
UserRegistrationException
public Map<String,Serializable> validateRegistration(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
UserRegistrationService
validateRegistration
in interface UserRegistrationService
ClientException
UserRegistrationException
public Map<String,Serializable> validateRegistrationAndSendEmail(String requestId, Map<String,Serializable> additionnalInfo) throws ClientException, UserRegistrationException
UserRegistrationService
validateRegistrationAndSendEmail
in interface UserRegistrationService
ClientException
UserRegistrationException
public void registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor) throws Exception
registerContribution
in class DefaultComponent
Exception
public NuxeoPrincipal createUser(CoreSession session, DocumentModel registrationDoc) throws ClientException, UserRegistrationException
createUser
in interface UserRegistrationService
ClientException
UserRegistrationException
public void addRightsOnDoc(CoreSession session, DocumentModel registrationDoc) throws ClientException
UserRegistrationService
addRightsOnDoc
in interface UserRegistrationService
registrationDoc
- containing all registration infoClientException
public UserRegistrationConfiguration getConfiguration()
getConfiguration
in interface UserRegistrationService
public UserRegistrationConfiguration getConfiguration(DocumentModel requestDoc)
getConfiguration
in interface UserRegistrationService
public UserRegistrationConfiguration getConfiguration(String name)
UserRegistrationService
getConfiguration
in interface UserRegistrationService
name
- configuration namepublic RegistrationRules getRegistrationRules(String configurationName) throws ClientException
UserRegistrationService
getRegistrationRules
in interface UserRegistrationService
ClientException
public void reviveRegistrationRequests(CoreSession session, List<DocumentModel> registrationDocs) throws ClientException
UserRegistrationService
reviveRegistrationRequests
in interface UserRegistrationService
ClientException
public void deleteRegistrationRequests(CoreSession session, List<DocumentModel> registrationDocs) throws ClientException
UserRegistrationService
deleteRegistrationRequests
in interface UserRegistrationService
ClientException
public Set<String> getConfigurationsName()
UserRegistrationService
getConfigurationsName
in interface UserRegistrationService
public DocumentModelList getRegistrationsForUser(String docId, String username) throws ClientException
UserRegistrationService
getRegistrationsForUser
in interface UserRegistrationService
ClientException
Copyright © 2013 Nuxeo SA. All Rights Reserved.