001/* 002 * (C) Copyright 2016 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 * 016 * Contributors: 017 * Nelson Silva <nsilva@nuxeo.com> 018 */ 019package org.nuxeo.ecm.automation.core.operations.services; 020 021import java.io.Serializable; 022import java.util.HashMap; 023import java.util.Map; 024 025import org.nuxeo.ecm.automation.core.Constants; 026import org.nuxeo.ecm.automation.core.annotations.Context; 027import org.nuxeo.ecm.automation.core.annotations.Operation; 028import org.nuxeo.ecm.automation.core.annotations.OperationMethod; 029import org.nuxeo.ecm.automation.core.annotations.Param; 030import org.nuxeo.ecm.core.api.CoreSession; 031import org.nuxeo.ecm.core.api.DocumentModel; 032import org.nuxeo.ecm.core.api.NuxeoPrincipal; 033import org.nuxeo.ecm.platform.usermanager.UserManager; 034import org.nuxeo.ecm.user.invite.UserInvitationComponent; 035import org.nuxeo.ecm.user.invite.UserInvitationService; 036import org.nuxeo.ecm.user.invite.UserInvitationService.ValidationMethod; 037import org.nuxeo.ecm.user.invite.UserRegistrationConfiguration; 038 039/** 040 * Simple operation to invite a User. 041 * 042 * @since 8.2 043 */ 044@Operation(id = UserInvite.ID, category = Constants.CAT_USERS_GROUPS, label = "Invite a user", 045 description = "Stores a registration request and returns its ID.") 046public class UserInvite { 047 048 public static final String ID = "User.Invite"; 049 050 @Context 051 protected UserManager userManager; 052 053 @Context 054 protected UserInvitationService invitationService; 055 056 @Context 057 protected CoreSession session; 058 059 @Param(name = "validationMethod", required = false) 060 protected ValidationMethod validationMethod = ValidationMethod.EMAIL; 061 062 @Param(name = "autoAccept", required = false) 063 protected boolean autoAccept = true; 064 065 @Param(name = "info", required = false) 066 protected Map<String, Serializable> info = new HashMap<>(); 067 068 @Param(name = "comment", required = false) 069 protected String comment; 070 071 @OperationMethod 072 public String run(NuxeoPrincipal user) { 073 DocumentModel invitation = invitationService.getUserRegistrationModel(null); 074 075 UserRegistrationConfiguration config = invitationService.getConfiguration(); 076 invitation.setPropertyValue(config.getUserInfoUsernameField(), user.getName()); 077 invitation.setPropertyValue(config.getUserInfoFirstnameField(), user.getFirstName()); 078 invitation.setPropertyValue(config.getUserInfoLastnameField(), user.getLastName()); 079 invitation.setPropertyValue(config.getUserInfoEmailField(), user.getEmail()); 080 invitation.setPropertyValue(config.getUserInfoGroupsField(), user.getGroups().toArray()); 081 invitation.setPropertyValue(config.getUserInfoTenantIdField(), user.getTenantId()); 082 invitation.setPropertyValue(config.getUserInfoCompanyField(), user.getCompany()); 083 invitation.setPropertyValue("registration:comment", comment); 084 085 info.put(UserInvitationComponent.PARAM_ORIGINATING_USER, session.getPrincipal().getName()); 086 087 return invitationService.submitRegistrationRequest(invitation, info, validationMethod, autoAccept); 088 } 089}