Package jetbrains.buildServer.users

Interface SUser

All Superinterfaces:

AuthorityHolder, Loggable, NotificationRulesHolder, PropertyHolder, RolesHolder, User

All Known Subinterfaces:

UserEx

All Known Implementing Classes:

AssociatedUser, BaseUser, InMemoryUser, RestrictedUserImpl, SecuredUser, TestUser, UserImpl

public interface SUser
extends AuthorityHolder, RolesHolder, User, NotificationRulesHolder

Presents TeamCity user data.

Field Summary

Fields

Modifier and Type	Field	Description
static int	GUEST_USER_ID	Special user ids, moved from UserFactoryImpl
static int	SUPER_USER_ID
static int	UKNOWN_USER_ID

Method Summary

Modifier and Type	Method	Description
void	deleteUserProperty(PropertyKey propertyKey)	Deletes a property with specified key from the user profile.
List<SVcsModification>	getAllModifications()	Returns the list of all (personal and non-personal) user modifications sorted by VCS date.
List<UserGroup>	getAllUserGroups()	Returns the list of all user groups that include this user, directly or through intermediate subgroups.
String	getBlockState(String blockType)	Retrieves state of a block stored for this user
Collection<SBuildType>	getBuildTypesOrder(SProject project)
List<SBuildType>	getOrderedBuildTypes(SProject project)	Returns the list of build configurations (in a project, or globally) sorted according to user settings.
List<String>	getProjectsOrder()
List<UserGroup>	getUserGroups()	Returns the list of groups which this user belongs to.
List<SVcsModification>	getVcsModifications(int numberOfActiveDays)	Returns the list of changes made by this user filtered according to the caller's permissions.
List<VcsUsernamePropertyKey>	getVcsUsernameProperties()	Returns list of VCS username properties associated with this user.
void	hideProject(String projectId)	Marks a project with specified id as invisible
void	hideProjects(Collection<String> projectIds)	Marks the specified projects as invisible
boolean	isGuest()	Returns true if the user is guest
boolean	isHighlightRelatedDataInUI()	Returns true if highlighting of user changes, investigations, and other related data in web UI is enabled.
void	setBlockState(String blockType, String blockState)	Stores collapsable block state for this user
void	setBuildTypesOrder(SProject project, List<SBuildType> visible, List<SBuildType> invisible)	Sets visible and invisible build types for the given project in the specified order.
void	setLastLoginTimestamp(Date timestamp)	Updates last login timestamp
void	setPassword(String password)	Changes password of this user
void	setProjectsOrder(List<String> projectsOrder)	Sets order of the projects.
void	setUserProperties(Map<? extends PropertyKey,String> properties)	Updates properties of the user specified by user id.
void	setUserProperty(PropertyKey propertyKey, String value)	Sets a property with specified key and value in user profile
void	setVisibleProjects(Collection<String> visibleProjects)	Sets projects visible for specified user
void	updateUserAccount(String username, String name, String email)	Updates user fields: username, name and email.

Methods inherited from interface jetbrains.buildServer.serverSide.auth.AuthorityHolder

getAllPermissions, getAssociatedUser, getGlobalPermissions, getPermissionsGrantedForAllProjects, getPermissionsGrantedForAnyOfProjects, getPermissionsGrantedForProject, getProjectsPermissions, hasAllPermissionsOf, isPermissionGrantedForAllProjects, isPermissionGrantedForAnyOfProjects, isPermissionGrantedForAnyProject, isPermissionGrantedForProject, isPermissionGrantedGlobally

Methods inherited from interface jetbrains.buildServer.log.Loggable

describe

Methods inherited from interface jetbrains.buildServer.notification.NotificationRulesHolder

addNewRule, applyOrder, findConflictingRules, findRuleById, getAllParentRulesHolders, getNotificationRules, getParentRulesHolders, removeRule, removeRule, setNotificationRules

Methods inherited from interface jetbrains.buildServer.users.PropertyHolder

getBooleanProperty, getProperties, getPropertyValue

Methods inherited from interface jetbrains.buildServer.serverSide.auth.RolesHolder

addRole, getAllParentHolders, getParentHolders, getRoles, getRolesWithScope, getScopes, isSystemAdministratorRoleGranted, isSystemAdministratorRoleGrantedDirectly, isSystemAdministratorRoleInherited, removeRole, removeRole, removeRoles

Methods inherited from interface jetbrains.buildServer.users.User

getAllProjects, getDescriptiveName, getEmail, getExtendedName, getId, getLastLoginTimestamp, getName, getRealm, getUsername, getVisibleProjects

Field Detail

GUEST_USER_ID

static final int GUEST_USER_ID

Special user ids, moved from UserFactoryImpl

Since:

2023.03

See Also:

Constant Field Values

SUPER_USER_ID

static final int SUPER_USER_ID

See Also:

Constant Field Values

UKNOWN_USER_ID

static final int UKNOWN_USER_ID

See Also:

Constant Field Values

Method Detail

getVcsModifications

@NotNull
List<SVcsModification> getVcsModifications(int numberOfActiveDays)

Returns the list of changes made by this user filtered according to the caller's permissions.

Parameters:

numberOfActiveDays - number of last active days of changing

Returns:

unmodifiable list of user changes

Since:

5.0

getAllModifications

@NotNull
List<SVcsModification> getAllModifications()

Returns the list of all (personal and non-personal) user modifications sorted by VCS date. Returns only modifications which have at least one related configuration.

Returns:

see above

Since:

6.0

updateUserAccount

void updateUserAccount(@NotNull
                       String username,
                       String name,
                       String email)
                throws UserNotFoundException,
                       DuplicateUserAccountException,
                       EmptyUsernameException

Updates user fields: username, name and email.

Parameters:

username - username, cannot be null

name - full name of a user

email - email address

Throws:

UserNotFoundException - if specified user no longer exists in the model

DuplicateUserAccountException - if a new username name already assigned to another user

EmptyUsernameException - if username is an empty string

setUserProperties

void setUserProperties(@NotNull
                       Map<? extends PropertyKey,String> properties)
                throws UserNotFoundException

Updates properties of the user specified by user id. Only those properties will be updated which keys are specified in the properties map. All other properties will be left intact.

Parameters:

properties - properties

Throws:

UserNotFoundException - if specified user no longer exists

setUserProperty

void setUserProperty(@NotNull
                     PropertyKey propertyKey,
                     String value)
              throws UserNotFoundException

Sets a property with specified key and value in user profile

Parameters:

propertyKey - property key

value - value of the property

Throws:

UserNotFoundException - if specified user no longer exists

deleteUserProperty

void deleteUserProperty(@NotNull
                        PropertyKey propertyKey)
                 throws UserNotFoundException

Deletes a property with specified key from the user profile.

Parameters:

propertyKey - property key

Throws:

UserNotFoundException - if specified user no longer exists

setPassword

void setPassword(String password)
          throws UserNotFoundException

Changes password of this user

Parameters:

password - new password

Throws:

UserNotFoundException - if specified user no longer exists

getProjectsOrder

@NotNull
List<String> getProjectsOrder()
                       throws UserNotFoundException

Returns:

List of project internal IDs in configured order. Empty list will be returned in case user didn't configure any order.

Throws:

UserNotFoundException - if specified user no longer exists

Since:

10.0

setProjectsOrder

void setProjectsOrder(@NotNull
                      List<String> projectsOrder)
               throws UserNotFoundException

Sets order of the projects.

Parameters:

projectsOrder - identificators of all projects in the order specified by user

Throws:

UserNotFoundException - if specified user no longer exists

setVisibleProjects

void setVisibleProjects(@NotNull
                        Collection<String> visibleProjects)
                 throws UserNotFoundException

Sets projects visible for specified user

Parameters:

visibleProjects - collection of identifiers of visible projects

Throws:

UserNotFoundException - if specified user no longer exists

hideProject

void hideProject(@NotNull
                 String projectId)
          throws UserNotFoundException

Marks a project with specified id as invisible

Parameters:

projectId - id of the project

Throws:

UserNotFoundException - if this user does not exist anymore

hideProjects

void hideProjects(@NotNull
                  Collection<String> projectIds)
           throws UserNotFoundException

Marks the specified projects as invisible

Parameters:

projectIds - ids of the project to hide

Throws:

UserNotFoundException - if this user does not exist anymore

Since:

2024.12

setLastLoginTimestamp

void setLastLoginTimestamp(@NotNull
                           Date timestamp)
                    throws UserNotFoundException

Updates last login timestamp

Parameters:

timestamp - last login timestamp

Throws:

UserNotFoundException - if this user does not exist anymore

setBlockState

void setBlockState(String blockType,
                   String blockState)

Stores collapsable block state for this user

Parameters:

blockType - type of block

blockState - state

getBlockState

@Nullable
String getBlockState(String blockType)

Retrieves state of a block stored for this user

Parameters:

blockType - type of block

Returns:

block state or null

getUserGroups

@NotNull
List<UserGroup> getUserGroups()

Returns the list of groups which this user belongs to. Only groups which contain this user directly are considered. If you need all user groups use getAllUserGroups().

No specific order of the groups is guaranteed.

Returns:

list of groups containing this user

Since:

4.5

See Also:

getAllUserGroups()

getAllUserGroups

@NotNull
List<UserGroup> getAllUserGroups()

Returns the list of all user groups that include this user, directly or through intermediate subgroups.

No specific order of the groups is guaranteed.

Returns:

list of all groups containing this user

Since:

4.5

See Also:

getUserGroups()

getVcsUsernameProperties

@NotNull
List<VcsUsernamePropertyKey> getVcsUsernameProperties()

Returns list of VCS username properties associated with this user. VCS username property defines username of this user in a concrete VCS root or VCS repository type (Subversion, Perforce, etc).

Returns:

list of VCS usernames

getOrderedBuildTypes

@NotNull
List<SBuildType> getOrderedBuildTypes(@Nullable
                                      SProject project)

Returns the list of build configurations (in a project, or globally) sorted according to user settings. The configurations invisible for the user are omitted.

Parameters:

project - the project (can be null)

Returns:

the list of build configurations

Since:

5.1

getBuildTypesOrder

@NotNull
Collection<SBuildType> getBuildTypesOrder(@NotNull
                                          SProject project)

Parameters:

project - the project

Returns:

List of build configurations in configured order. Empty list will be returned in case user didn't configure any order.

Since:

10.0

setBuildTypesOrder

void setBuildTypesOrder(@NotNull
                        SProject project,
                        @NotNull
                        List<SBuildType> visible,
                        @NotNull
                        List<SBuildType> invisible)

Sets visible and invisible build types for the given project in the specified order.

Parameters:

project - the project

visible - the list of visible build types

invisible - the list of invisible build types

Since:

5.1

isHighlightRelatedDataInUI

boolean isHighlightRelatedDataInUI()

Returns true if highlighting of user changes, investigations, and other related data in web UI is enabled. The value is controlled by the StandardProperties.HIGHLIGHT_MY_CHANGES property.

Returns:

true if highlighting of user changes, investigations, and other related data in web UI is enabled.

Since:

7.1

isGuest

boolean isGuest()

Returns true if the user is guest

Since:

2017.2