aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api
diff options
context:
space:
mode:
Diffstat (limited to 'sonar-plugin-api')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/BaseIdentityProvider.java6
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/OAuth2IdentityProvider.java3
2 files changed, 7 insertions, 2 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/BaseIdentityProvider.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/BaseIdentityProvider.java
index 6f17ee506fd..1d5c2ce47c6 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/BaseIdentityProvider.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/BaseIdentityProvider.java
@@ -59,7 +59,11 @@ public interface BaseIdentityProvider extends IdentityProvider {
* The first time a user is authenticated (and if {@link #allowsUsersToSignUp()} is true), a new user will be registered.
* Then, only user's name and email are updated.
*
- * @throws NotAllowUserToSignUpException when {@link #allowsUsersToSignUp()} is false and a new user try to authenticate
+ * If @link #allowsUsersToSignUp()} is set to false and a new user try to authenticate,
+ * then the user is not authenticated and he's redirected to a dedicated page.
+ *
+ * If the email of the user is already used by an existing user of the platform,
+ * then the user is not authenticated and he's redirected to a dedicated page.
*/
void authenticate(UserIdentity userIdentity);
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/OAuth2IdentityProvider.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/OAuth2IdentityProvider.java
index 4409803ac10..b453e0b846f 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/OAuth2IdentityProvider.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/authentication/OAuth2IdentityProvider.java
@@ -87,7 +87,8 @@ public interface OAuth2IdentityProvider extends IdentityProvider {
void redirectToRequestedPage();
/**
- * Authenticate and register the user into the platform
+ * Authenticate and register the user into the platform.
+ * @see org.sonar.api.server.authentication.BaseIdentityProvider.Context#authenticate(UserIdentity)
*/
void authenticate(UserIdentity userIdentity);
}