Package jetbrains.buildServer.users

Class UserData

java.lang.Object

jetbrains.buildServer.users.SimpleUserData

jetbrains.buildServer.users.UserData

All Implemented Interfaces:

Loggable, AuthorityHolder, PropertyHolder, User

public class UserData
extends SimpleUserData
implements AuthorityHolder

This class contains all necessary information to be sent via XmlRpc to remote client about TeamCity user

Constructor Summary

Constructors

Constructor	Description
UserData(long id, String realm, String username, String name, Date lastLoginTimestamp)

Method Summary

Modifier and Type	Method	Description
static UserData	createOn(User user)
User	getAssociatedUser()	Returns the user object associated with the principal.
Permissions	getGlobalPermissions()	Returns all granted non-project related permissions and all project-related permissions granted globally
Date	getLastLoginTimestamp()	Returns this user last login timestamp
Permissions	getPermissionsGrantedForAllProjects(Collection<String> projectIds)	Returns all permissions granted for all projects from the collection.
Permissions	getPermissionsGrantedForAnyOfProjects(Collection<String> projectIds)	Returns union of permissions granted for projects from the collection.
Permissions	getPermissionsGrantedForProject(String projectId)	Returns all permissions granted for particular project.
Map<String,Permissions>	getProjectsPermissions()	Returns map of project-related permissions that were granted for a particular project.
String	getRealm()	Returns realm of the user.
boolean	isPermissionGrantedForAllProjects(Collection<String> projectIds, Permission permission)	Returns true if permission is granted for all projects from the given list.
boolean	isPermissionGrantedForAnyOfProjects(Collection<String> projectIds, Permission permission)	Returns true if specified permission is granted for at least one project from the given collection
boolean	isPermissionGrantedForAnyProject(Permission permission)	Returns true if specified permission is granted for at least one project
boolean	isPermissionGrantedForProject(String projectId, Permission permission)	Returns true if permission is granted for a project, i.e.
boolean	isPermissionGrantedGlobally(Permission permission)	Returns true if specified permission granted globally (i.e.
void	setPermissions(PermissionsHolder permissionsHolder)	Sets authority holder in this user.

Methods inherited from class jetbrains.buildServer.users.SimpleUserData

createSimpleUserDataOn, describe, equals, getAllProjects, getBooleanProperty, getDescriptiveName, getEmail, getExtendedName, getId, getName, getProperties, getPropertyValue, getUsername, getVisibleProjects, hasAllPermissionsOf, hashCode

Methods inherited from class java.lang.Object

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

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

getAllPermissions, hasAllPermissionsOf

Constructor Detail

UserData

public UserData(long id,
                String realm,
                String username,
                String name,
                Date lastLoginTimestamp)

Method Detail

setPermissions

public void setPermissions(@NotNull
                           PermissionsHolder permissionsHolder)

Sets authority holder in this user. AuthorityHolder contains permissions of the user.

Parameters:

permissionsHolder - authority holder

getRealm

public String getRealm()

Description copied from interface: User

Returns realm of the user.

Specified by:

getRealm in interface User

Overrides:

getRealm in class SimpleUserData

Returns:

realm of the user

getLastLoginTimestamp

public Date getLastLoginTimestamp()

Description copied from interface: User

Returns this user last login timestamp

Specified by:

getLastLoginTimestamp in interface User

Overrides:

getLastLoginTimestamp in class SimpleUserData

Returns:

last login timestamp

createOn

@NotNull
public static UserData createOn(@NotNull
                                User user)

isPermissionGrantedGlobally

public boolean isPermissionGrantedGlobally(@NotNull
                                           Permission permission)

Description copied from interface: AuthorityHolder

Returns true if specified permission granted globally (i.e. not associated with any particular object)

Specified by:

isPermissionGrantedGlobally in interface AuthorityHolder

Overrides:

isPermissionGrantedGlobally in class SimpleUserData

Parameters:

permission - permission to check

Returns:

true or false

getGlobalPermissions

@NotNull
public Permissions getGlobalPermissions()

Description copied from interface: AuthorityHolder

Returns all granted non-project related permissions and all project-related permissions granted globally

Specified by:

getGlobalPermissions in interface AuthorityHolder

Overrides:

getGlobalPermissions in class SimpleUserData

Returns:

see above

getProjectsPermissions

@NotNull
public Map<String,Permissions> getProjectsPermissions()

Description copied from interface: AuthorityHolder

Returns map of project-related permissions that were granted for a particular project. Project internal id is used as the key.

Specified by:

getProjectsPermissions in interface AuthorityHolder

Overrides:

getProjectsPermissions in class SimpleUserData

Returns:

map of project permissions

isPermissionGrantedForProject

public boolean isPermissionGrantedForProject(@NotNull
                                             String projectId,
                                             @NotNull
                                             Permission permission)

Description copied from interface: AuthorityHolder

Returns true if permission is granted for a project, i.e. the result is true if there is a project related permission granted globally or for specified project

Specified by:

isPermissionGrantedForProject in interface AuthorityHolder

Overrides:

isPermissionGrantedForProject in class SimpleUserData

Parameters:

projectId - project internal id

permission - permission to check

Returns:

see above

isPermissionGrantedForAllProjects

public boolean isPermissionGrantedForAllProjects(@NotNull
                                                 Collection<String> projectIds,
                                                 @NotNull
                                                 Permission permission)

Description copied from interface: AuthorityHolder

Returns true if permission is granted for all projects from the given list. Returns false if projectIds is empty.

Specified by:

isPermissionGrantedForAllProjects in interface AuthorityHolder

Overrides:

isPermissionGrantedForAllProjects in class SimpleUserData

Parameters:

projectIds - collection of project ids

permission - permission to check @return see above

See Also:

AuthorityHolder.isPermissionGrantedForProject(java.lang.String, jetbrains.buildServer.serverSide.auth.Permission)

isPermissionGrantedForAnyProject

public boolean isPermissionGrantedForAnyProject(@NotNull
                                                Permission permission)

Description copied from interface: AuthorityHolder

Returns true if specified permission is granted for at least one project

Specified by:

isPermissionGrantedForAnyProject in interface AuthorityHolder

Overrides:

isPermissionGrantedForAnyProject in class SimpleUserData

Parameters:

permission - permission to check

Returns:

see above

isPermissionGrantedForAnyOfProjects

public boolean isPermissionGrantedForAnyOfProjects(@NotNull
                                                   Collection<String> projectIds,
                                                   @NotNull
                                                   Permission permission)

Description copied from interface: AuthorityHolder

Returns true if specified permission is granted for at least one project from the given collection

Specified by:

isPermissionGrantedForAnyOfProjects in interface AuthorityHolder

Overrides:

isPermissionGrantedForAnyOfProjects in class SimpleUserData

permission - permission to check

Returns:

see above

getPermissionsGrantedForProject

@NotNull
public Permissions getPermissionsGrantedForProject(@NotNull
                                                   String projectId)

Description copied from interface: AuthorityHolder

Returns all permissions granted for particular project. These include permissions granted specifically for the specified project and granted global project-related permissions (i.e. permissions supporting project association Permission.isProjectAssociationSupported()).

Specified by:

getPermissionsGrantedForProject in interface AuthorityHolder

Overrides:

getPermissionsGrantedForProject in class SimpleUserData

Parameters:

projectId - project internal id

Returns:

all granted permissions for particular project

getPermissionsGrantedForAllProjects

@NotNull
public Permissions getPermissionsGrantedForAllProjects(@NotNull
                                                       Collection<String> projectIds)

Description copied from interface: AuthorityHolder

Returns all permissions granted for all projects from the collection. These include permissions granted specifically for the specified projects and granted global project-related permissions (i.e. permissions supporting project association Permission.isProjectAssociationSupported()).

Specified by:

getPermissionsGrantedForAllProjects in interface AuthorityHolder

Overrides:

getPermissionsGrantedForAllProjects in class SimpleUserData

Parameters:

projectIds - collection of project internal ids

Returns:

all granted permissions for all projects

getPermissionsGrantedForAnyOfProjects

@NotNull
public Permissions getPermissionsGrantedForAnyOfProjects(@NotNull
                                                         Collection<String> projectIds)

Description copied from interface: AuthorityHolder

Returns union of permissions granted for projects from the collection. These include permissions granted specifically for the specified projects and granted global project-related permissions (i.e. permissions supporting project association Permission.isProjectAssociationSupported()).

Specified by:

getPermissionsGrantedForAnyOfProjects in interface AuthorityHolder

Overrides:

getPermissionsGrantedForAnyOfProjects in class SimpleUserData

Parameters:

projectIds - collection of project internal ids

Returns:

all granted permissions for all projects

getAssociatedUser

@Nullable
public User getAssociatedUser()

Description copied from interface: AuthorityHolder

Returns the user object associated with the principal.

Specified by:

getAssociatedUser in interface AuthorityHolder

Overrides:

getAssociatedUser in class SimpleUserData

Returns:

may be null if the authority holder is not a user.