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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2018 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
  21 package org.sonar.server.authentication;
  22
  23 import org.sonar.api.server.authentication.IdentityProvider;
  24 import org.sonar.api.server.authentication.UserIdentity;
  25 import org.sonar.server.authentication.event.AuthenticationEvent;
  26
  27 import static java.util.Objects.requireNonNull;
  28
  29 class UserIdentityAuthenticatorParameters {
  30
  31   /**
  32    * Strategy to be executed when the email of the user is already used by another user
  33    */
  34   enum ExistingEmailStrategy {
  35     /**
  36      * Authentication is allowed, the email is moved from other user to current user
  37      */
  38     ALLOW,
  39     /**
  40      * Authentication process is stopped, the user is redirected to a page explaining that the email is already used
  41      */
  42     WARN,
  43     /**
  44      * Forbid authentication of the user
  45      */
  46     FORBID
  47   }
  48
  49   /**
  50    * Strategy to be executed when the login of the user is updated
  51    */
  52   enum UpdateLoginStrategy {
  53     /**
  54      * Authentication is allowed, the login of the user updated
  55      */
  56     ALLOW,
  57     /**
  58      * Authentication process is stopped, the user is redirected to a page explaining that the login will be updated.
  59      * It only happens when personal organizations are activated
  60      */
  61     WARN
  62   }
  63
  64   private final UserIdentity userIdentity;
  65   private final IdentityProvider provider;
  66   private final AuthenticationEvent.Source source;
  67   private final ExistingEmailStrategy existingEmailStrategy;
  68   private final UpdateLoginStrategy updateLoginStrategy;
  69
  70   UserIdentityAuthenticatorParameters(Builder builder) {
  71     this.userIdentity = builder.userIdentity;
  72     this.provider = builder.provider;
  73     this.source = builder.source;
  74     this.existingEmailStrategy = builder.existingEmailStrategy;
  75     this.updateLoginStrategy = builder.updateLoginStrategy;
  76   }
  77
  78   public UserIdentity getUserIdentity() {
  79     return userIdentity;
  80   }
  81
  82   public IdentityProvider getProvider() {
  83     return provider;
  84   }
  85
  86   public AuthenticationEvent.Source getSource() {
  87     return source;
  88   }
  89
  90   public ExistingEmailStrategy getExistingEmailStrategy() {
  91     return existingEmailStrategy;
  92   }
  93
  94   public UpdateLoginStrategy getUpdateLoginStrategy() {
  95     return updateLoginStrategy;
  96   }
  97
  98   static UserIdentityAuthenticatorParameters.Builder builder() {
  99     return new Builder();
 100   }
 101
 102   public static class Builder {
 103     private UserIdentity userIdentity;
 104     private IdentityProvider provider;
 105     private AuthenticationEvent.Source source;
 106     private ExistingEmailStrategy existingEmailStrategy;
 107     private UpdateLoginStrategy updateLoginStrategy;
 108
 109     public Builder setUserIdentity(UserIdentity userIdentity) {
 110       this.userIdentity = userIdentity;
 111       return this;
 112     }
 113
 114     public Builder setProvider(IdentityProvider provider) {
 115       this.provider = provider;
 116       return this;
 117     }
 118
 119     public Builder setSource(AuthenticationEvent.Source source) {
 120       this.source = source;
 121       return this;
 122     }
 123
 124     /**
 125      * Strategy to be executed when the email of the user is already used by another user
 126      */
 127     public Builder setExistingEmailStrategy(ExistingEmailStrategy existingEmailStrategy) {
 128       this.existingEmailStrategy = existingEmailStrategy;
 129       return this;
 130     }
 131
 132     /**
 133      * Strategy to be executed when the login of the user has changed
 134      */
 135     public Builder setUpdateLoginStrategy(UpdateLoginStrategy updateLoginStrategy) {
 136       this.updateLoginStrategy = updateLoginStrategy;
 137       return this;
 138     }
 139
 140     public UserIdentityAuthenticatorParameters build() {
 141       requireNonNull(userIdentity, "userIdentity must be set");
 142       requireNonNull(provider, "identityProvider must be set");
 143       requireNonNull(source, "Source must be set");
 144       requireNonNull(existingEmailStrategy, "existingEmailStrategy must be set ");
 145       requireNonNull(updateLoginStrategy, "updateLoginStrategy must be set");
 146       return new UserIdentityAuthenticatorParameters(this);
 147     }
 148   }
 149 }