source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.v2.api.user.request;
  21
  22 import io.swagger.v3.oas.annotations.media.ArraySchema;
  23 import io.swagger.v3.oas.annotations.media.Schema;
  24 import java.util.List;
  25 import javax.annotation.Nullable;
  26 import javax.validation.constraints.Email;
  27 import javax.validation.constraints.Size;
  28 import org.sonar.server.v2.common.model.UpdateField;
  29
  30 public class UserUpdateRestRequest {
  31
  32   private UpdateField<String> login = UpdateField.undefined();
  33   private UpdateField<String> name = UpdateField.undefined();
  34   private UpdateField<String> email = UpdateField.undefined();
  35   private UpdateField<List<String>> scmAccounts = UpdateField.undefined();
  36   private UpdateField<String> externalProvider = UpdateField.undefined();
  37   private UpdateField<String> externalLogin = UpdateField.undefined();
  38
  39   @Size(min = 2, max = 100)
  40   @Schema(description = "User login")
  41   public UpdateField<String> getLogin() {
  42     return login;
  43   }
  44
  45   public void setLogin(String login) {
  46     this.login = UpdateField.withValue(login);
  47   }
  48
  49   @Size(max = 200)
  50   @Schema(description = "User first name and last name", implementation = String.class)
  51   public UpdateField<String> getName() {
  52     return name;
  53   }
  54
  55   public void setName(String name) {
  56     this.name = UpdateField.withValue(name);
  57   }
  58
  59   @Email
  60   @Size(min = 1, max = 100)
  61   @Schema(implementation = String.class, description = "Email")
  62   public UpdateField<String> getEmail() {
  63     return email;
  64   }
  65
  66   public void setEmail(String email) {
  67     this.email = UpdateField.withValue(email);
  68   }
  69
  70   @ArraySchema(arraySchema = @Schema(description = "List of SCM accounts."), schema = @Schema(implementation = String.class))
  71   public UpdateField<List<String>> getScmAccounts() {
  72     return scmAccounts;
  73   }
  74
  75   public void setScmAccounts(List<String> scmAccounts) {
  76     this.scmAccounts = UpdateField.withValue(scmAccounts);
  77   }
  78
  79   @Schema(implementation = String.class, description = "New external provider. Only authentication system installed are available. " +
  80     "Use 'LDAP' identity provider for single server LDAP setup. " +
  81     "Use 'LDAP_{serverKey}' identity provider for multiple LDAP servers setup. " +
  82     "Warning: when this information has been updated for a user, the user will only be able to authenticate via the new identity provider. " +
  83     "It is not possible to migrate external user to local one.")
  84   public UpdateField<String> getExternalProvider() {
  85     return externalProvider;
  86   }
  87
  88   public void setExternalProvider(@Nullable String externalProvider) {
  89     this.externalProvider = UpdateField.withValue(externalProvider);
  90   }
  91
  92   @Size(min = 1, max = 255)
  93   @Schema(implementation = String.class, description = "New external login, usually the login used in the authentication system. If not provided previous identity will be used.")
  94   public UpdateField<String> getExternalLogin() {
  95     return externalLogin;
  96   }
  97
  98   public void setExternalLogin(@Nullable String externalLogin) {
  99     this.externalLogin = UpdateField.withValue(externalLogin);
 100   }
 101 }