001/* 002 * (C) Copyright 2011 Nuxeo SAS (http://nuxeo.com/) and contributors. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * Contributors: 014 * Nuxeo - initial API and implementation 015 */ 016 017package org.nuxeo.ecm.user.registration; 018 019import java.io.Serializable; 020import java.util.Map; 021 022import org.nuxeo.ecm.core.api.CoreSession; 023import org.nuxeo.ecm.core.api.DocumentModel; 024import org.nuxeo.ecm.user.invite.UserInvitationService; 025import org.nuxeo.ecm.user.invite.UserRegistrationConfiguration; 026import org.nuxeo.ecm.user.invite.UserRegistrationException; 027import org.nuxeo.ecm.user.invite.UserRegistrationInfo; 028 029public interface UserRegistrationService extends UserInvitationService { 030 031 public static final String CONFIGURATION_NAME = UserRegistrationConfiguration.DEFAULT_CONFIGURATION_NAME; 032 033 /** 034 * Stores a registration request and return a unique ID for it 035 * 036 * @return 037 */ 038 String submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String, Serializable> additionnalInfo, 039 ValidationMethod validationMethod, boolean autoAccept, String principalName) throws 040 UserRegistrationException; 041 042 /** 043 * Validate a registration request and generate the target User 044 * 045 * @param requestId 046 */ 047 Map<String, Serializable> validateRegistrationAndSendEmail(String requestId, 048 Map<String, Serializable> additionnalInfo) throws UserRegistrationException; 049 050 /** 051 * Add an ACL with the right specified in the registration Doc or nothing, if no rights needed. 052 * 053 * @param registrationDoc containing all registration info 054 * @since 5.6 055 */ 056 void addRightsOnDoc(CoreSession session, DocumentModel registrationDoc); 057 058 /** 059 * Stores a registration request like submitRegistrationRequest with Document information 060 * 061 * @return a unique ID for it` 062 * @since 5.6 063 */ 064 String submitRegistrationRequest(String configurationName, UserRegistrationInfo userInfo, 065 DocumentRegistrationInfo docInfo, Map<String, Serializable> additionnalInfo, 066 ValidationMethod validationMethod, boolean autoAccept, String principalName) throws 067 UserRegistrationException; 068}