001/* 002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * Contributors: 016 * Nuxeo - initial API and implementation 017 */ 018 019package org.nuxeo.ecm.user.registration; 020 021import java.io.Serializable; 022import java.util.Map; 023 024import org.nuxeo.ecm.core.api.CoreSession; 025import org.nuxeo.ecm.core.api.DocumentModel; 026import org.nuxeo.ecm.user.invite.UserInvitationService; 027import org.nuxeo.ecm.user.invite.UserRegistrationConfiguration; 028import org.nuxeo.ecm.user.invite.UserRegistrationException; 029import org.nuxeo.ecm.user.invite.UserRegistrationInfo; 030 031public interface UserRegistrationService extends UserInvitationService { 032 033 public static final String CONFIGURATION_NAME = UserRegistrationConfiguration.DEFAULT_CONFIGURATION_NAME; 034 035 /** 036 * Stores a registration request and return a unique ID for it 037 * 038 * @return 039 */ 040 String submitRegistrationRequest(UserRegistrationInfo userInfo, Map<String, Serializable> additionnalInfo, 041 ValidationMethod validationMethod, boolean autoAccept, String principalName) throws 042 UserRegistrationException; 043 044 /** 045 * Validate a registration request and generate the target User 046 * 047 * @param requestId 048 */ 049 Map<String, Serializable> validateRegistrationAndSendEmail(String requestId, 050 Map<String, Serializable> additionnalInfo) throws UserRegistrationException; 051 052 /** 053 * Add an ACL with the right specified in the registration Doc or nothing, if no rights needed. 054 * 055 * @param registrationDoc containing all registration info 056 * @since 5.6 057 */ 058 void addRightsOnDoc(CoreSession session, DocumentModel registrationDoc); 059 060 /** 061 * Stores a registration request like submitRegistrationRequest with Document information 062 * 063 * @return a unique ID for it` 064 * @since 5.6 065 */ 066 String submitRegistrationRequest(String configurationName, UserRegistrationInfo userInfo, 067 DocumentRegistrationInfo docInfo, Map<String, Serializable> additionnalInfo, 068 ValidationMethod validationMethod, boolean autoAccept, String principalName) throws 069 UserRegistrationException; 070}