Package org.sonar.api.server.authentication

Class UserIdentity.Builder

java.lang.Object

org.sonar.api.server.authentication.UserIdentity.Builder

Enclosing class:

UserIdentity

public static class UserIdentity.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
UserIdentity	build()
UserIdentity.Builder	setEmail(java.lang.String email)
UserIdentity.Builder	setGroups(java.util.Set<java.lang.String> groups)	Set group membership of the user.
UserIdentity.Builder	setLogin(java.lang.String login)	Deprecated. since 8.0, has no effect as it is internal managed field
UserIdentity.Builder	setName(java.lang.String name)
UserIdentity.Builder	setProviderId(java.lang.String id)
UserIdentity.Builder	setProviderLogin(java.lang.String providerLogin)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setProviderId

public UserIdentity.Builder setProviderId(@Nullable
                                          java.lang.String id)

Since:

7.2

See Also:

UserIdentity.getProviderId()

setProviderLogin

public UserIdentity.Builder setProviderLogin(java.lang.String providerLogin)

See Also:

UserIdentity.getProviderLogin()

setLogin

@Deprecated
public UserIdentity.Builder setLogin(@Nullable
                                     java.lang.String login)

Deprecated.

since 8.0, has no effect as it is internal managed field

See Also:

UserIdentity.getLogin()

setName

public UserIdentity.Builder setName(java.lang.String name)

See Also:

UserIdentity.getName()

setEmail

public UserIdentity.Builder setEmail(@Nullable
                                     java.lang.String email)

See Also:

UserIdentity.getEmail()

setGroups

public UserIdentity.Builder setGroups(java.util.Set<java.lang.String> groups)

Set group membership of the user. This method should only be used when synchronization of groups should be done.

• When groups are not empty, group membership is synchronized when user logs in :
  • User won't belong anymore to a group that is not in the list (even the default group defined in 'sonar-users')
  • User will belong only to groups that exist in SonarQube
  • Groups that don't exist in SonarQube are silently ignored
• When groups are empty, user won't belong to any group

Throws:

java.lang.NullPointerException - when groups is null

Since:

5.5

build

public UserIdentity build()