Package jetbrains.buildServer.groups.impl

Class AllUsersGroup

java.lang.Object

jetbrains.buildServer.serverSide.impl.Proxyfied<UserGroupEx>

jetbrains.buildServer.groups.impl.UserGroupImpl

jetbrains.buildServer.groups.impl.AllUsersGroup

All Implemented Interfaces:

Comparable<UserGroup>, SUserGroup, UserGroup, UserGroupEx, Loggable, NotificationRulesHolder, AuthorityHolder, RolesHolder, RolesHolderEx, PropertyHolder, SPropertyHolder

public class AllUsersGroup
extends UserGroupImpl

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
void	addUser(User user)	Users.
void	cleanupGroup()	Removes from the group users, which were removed on the server
boolean	containsUserDirectly(User user)
List<User>	getAllUsers()	Returns the set of all users included into this group, directly or through subgroups.
List<User>	getDirectUsers()	Returns the collection of users included into this group.
int	getUsersNumber()	Returns the number of (direct) users in this group.
boolean	isAllUsersGroup()	Returns true, if the specified group is the all-users group.
void	removeUser(User user)	Removes a user from this group.
void	setDescription(String description)	Sets the group description.
void	setName(String name)	Sets the group name.
void	updateInfo()	Reload main group info (name and description) from the database
void	updateUsers()	Reload group users from the database

Methods inherited from class jetbrains.buildServer.groups.impl.UserGroupImpl

addNewRule, addParent, addRole, addSubgroup, addSubgroups, applyOrder, calculatePermissions, compareTo, deleteGroupProperty, deleteProperty, describe, dispose, equals, findConflictingRules, findRuleById, getAllParentHolders, getAllParentRulesHolders, getAllPermissions, getAllSubgroups, getAssociatedUser, getBooleanProperty, getDescription, getDirectSubgroups, getGlobalPermissions, getKey, getName, getNotificationRules, getParentGroups, getParentHolders, getParentRulesHolders, getPermissionsGrantedForAllProjects, getPermissionsGrantedForAnyOfProjects, getPermissionsGrantedForProject, getProjectsPermissions, getProperties, getPropertyValue, getRoles, getRolesWithScope, getScopes, getUnfilteredRoles, getUnfilteredScopes, hasAllPermissionsOf, hashCode, hasParents, isPermissionGrantedForAllProjects, isPermissionGrantedForAnyOfProjects, isPermissionGrantedForAnyProject, isPermissionGrantedForProject, isPermissionGrantedGlobally, isSystemAdministratorRoleGranted, isSystemAdministratorRoleGrantedDirectly, isSystemAdministratorRoleInherited, removeParent, removeRole, removeRole, removeRoles, removeRule, removeRule, removeSubgroup, resetRoles, setGroupProperties, setGroupProperty, setNotificationRules, setProperties, setProperty, toString, updateProperties, updateRoles, updateSubgroups

Methods inherited from class jetbrains.buildServer.serverSide.impl.Proxyfied

getProxy, setProxy

Methods inherited from class java.lang.Object

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

Method Detail

setName

public void setName(@NotNull
                    String name)
             throws UserGroupException

Description copied from interface: SUserGroup

Sets the group name.

Note: group name must be unique among all user groups. If name already exists, an exception is thrown.

The name cannot be empty and cannot exceed 255 characters.

Specified by:

setName in interface SUserGroup

Overrides:

setName in class UserGroupImpl

Parameters:

name - the new group name

Throws:

UserGroupException - if name already exists, or is empty, or is too long

See Also:

UserGroup.getName()

setDescription

public void setDescription(@NotNull
                           String description)
                    throws UserGroupException

Description copied from interface: SUserGroup

Sets the group description.

The description cannot exceed 2000 characters.

Specified by:

setDescription in interface SUserGroup

Overrides:

setDescription in class UserGroupImpl

Parameters:

description - the new description

Throws:

UserGroupException - if description is too long

See Also:

UserGroup.getDescription()

getDirectUsers

@NotNull
public List<User> getDirectUsers()

Description copied from interface: UserGroup

Returns the collection of users included into this group. This method ignores the subgroups.

Specified by:

getDirectUsers in interface UserGroup

Overrides:

getDirectUsers in class UserGroupImpl

Returns:

list of users

See Also:

UserGroup.getAllUsers()

getAllUsers

@NotNull
public List<User> getAllUsers()

Description copied from interface: UserGroup

Returns the set of all users included into this group, directly or through subgroups.

Specified by:

getAllUsers in interface UserGroup

Overrides:

getAllUsers in class UserGroupImpl

Returns:

list of all users

See Also:

UserGroup.getDirectUsers()

containsUserDirectly

public boolean containsUserDirectly(@NotNull
                                    User user)

Specified by:

containsUserDirectly in interface UserGroup

Overrides:

containsUserDirectly in class UserGroupImpl

Parameters:

user - user to check

Returns:

true if this group contains user directly (user is returned by getDirectUsers)

getUsersNumber

public int getUsersNumber()

Description copied from interface: UserGroupEx

Returns the number of (direct) users in this group. Much more effective than getDirectUsers().size().

Specified by:

getUsersNumber in interface UserGroupEx

Overrides:

getUsersNumber in class UserGroupImpl

Returns:

the number of users in the group

addUser

public void addUser(@NotNull
                    User user)

Description copied from class: UserGroupImpl

Users.

Specified by:

addUser in interface SUserGroup

Overrides:

addUser in class UserGroupImpl

Parameters:

user - the user to add

removeUser

public void removeUser(@NotNull
                       User user)
                throws UserGroupException

Description copied from interface: SUserGroup

Removes a user from this group. Does nothing if the user is not included into this group directly.

The user isn't allowed to remove himself from any group.

Specified by:

removeUser in interface SUserGroup

Overrides:

removeUser in class UserGroupImpl

Parameters:

user - a user to remove

Throws:

UserGroupException - if user is the authority holder, trying to remove himself

isAllUsersGroup

public boolean isAllUsersGroup()

Description copied from interface: UserGroupEx

Returns true, if the specified group is the all-users group.

Specified by:

isAllUsersGroup in interface UserGroupEx

Overrides:

isAllUsersGroup in class UserGroupImpl

Returns:

true if the specified group is the all-users group, false otherwise

updateInfo

public void updateInfo()

Description copied from interface: UserGroupEx

Reload main group info (name and description) from the database

Specified by:

updateInfo in interface UserGroupEx

Overrides:

updateInfo in class UserGroupImpl

updateUsers

public void updateUsers()

Description copied from interface: UserGroupEx

Reload group users from the database

Specified by:

updateUsers in interface UserGroupEx

Overrides:

updateUsers in class UserGroupImpl

cleanupGroup

public void cleanupGroup()

Description copied from interface: UserGroupEx

Removes from the group users, which were removed on the server

Specified by:

cleanupGroup in interface UserGroupEx

Overrides:

cleanupGroup in class UserGroupImpl