Package jetbrains.buildServer.serverSide.impl.auth

Class RolesManagerImpl

java.lang.Object

jetbrains.buildServer.serverSide.impl.auth.RolesManagerImpl

All Implemented Interfaces:

RolesManager, RoleManipulator, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware

public class RolesManagerImpl
extends Object
implements RolesManager, RoleManipulator, org.springframework.beans.factory.BeanFactoryAware

Author:

Pavel.Sher Date: 21.09.2007

Field Summary

Fields

Modifier and Type	Field	Description
static String	TEAMCITY_ROLES_RELOAD_INTERVAL

Fields inherited from interface jetbrains.buildServer.serverSide.auth.RolesManager

SUPER_USER_ROLE_ID, SYS_ADMIN_ROLE_ID

Constructor Summary

Constructors

Constructor	Description
RolesManagerImpl(ServerPaths serverPaths, SecurityContextEx securityContext)

Method Summary

Modifier and Type	Method	Description
void	addIncludedRole(RoleImpl role, Role includedRole)	Includes includedRole to role
void	addPermissions(RoleImpl role, Permission... permissions)	Adds permissions to the role
void	addRole(RoleImpl newRole)
void	addRoleListener(RoleListener listener)	Adds listener to the manager
Role	createNewRole(String roleName)	Creates new role with given id and name
void	deleteRole(Role role)	Deletes role
void	dispose()
Role	findRoleById(String roleId)	Searches for a role with specified id
Collection<? extends Role>	getAllIncludedRoles(Role role)	Collects all roles recursively inlcuded in the role
List<Role>	getAvailableRoles()	Returns list of roles configured in the system.
Map<String,Role>	getAvailableRolesMap()	Same as RolesManager.getAvailableRoles() but returns map where id of the role is a key.
Role	getSuperUserRole()	Returns predefined non configurable role representing super user.
Role	getSystemAdministratorRole()	Returns predefined non configurable role representing system administrator.
boolean	isInitialized()
void	removeIncludedRole(RoleImpl role, Role includedRole)	Excludes includedRole from role
void	removePermission(RoleImpl role, Permission permission)	Removes permission from the role
void	removeRoleListener(RoleListener listener)	Removes listener to the manager
void	saveRoles()
void	setAuditLogFactory(AuditLogFactory auditLogFactory)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setConfigurationErrors(ConfigurationErrors configurationErrors)
void	setFileWatcherFactory(FileWatcherFactory fileWatcherFactory)
void	setGlobalPermissionsRoles(GlobalPermissionsRoles globalPermissionsRoles)
void	setRolesConfigLoader(RolesConfigLoader rolesConfigLoader)
void	setServer(SBuildServer server)
void	setServerDispatcher(EventDispatcher<BuildServerListener> serverDispatcher)
void	setServerSettings(ServerSettings serverSettings)
void	setSettingsPersister(SettingsPersister settingsPersister)

Methods inherited from class java.lang.Object

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

Field Detail

TEAMCITY_ROLES_RELOAD_INTERVAL

public static final String TEAMCITY_ROLES_RELOAD_INTERVAL

See Also:

Constant Field Values

Constructor Detail

RolesManagerImpl

@Autowired
public RolesManagerImpl(@NotNull
                        ServerPaths serverPaths,
                        @NotNull
                        SecurityContextEx securityContext)

Method Detail

setServerDispatcher

public void setServerDispatcher(EventDispatcher<BuildServerListener> serverDispatcher)

setFileWatcherFactory

public void setFileWatcherFactory(FileWatcherFactory fileWatcherFactory)

setSettingsPersister

public void setSettingsPersister(SettingsPersister settingsPersister)

setGlobalPermissionsRoles

public void setGlobalPermissionsRoles(GlobalPermissionsRoles globalPermissionsRoles)

setAuditLogFactory

public void setAuditLogFactory(AuditLogFactory auditLogFactory)

setServer

public void setServer(SBuildServer server)

setServerSettings

public void setServerSettings(ServerSettings serverSettings)

setConfigurationErrors

public void setConfigurationErrors(ConfigurationErrors configurationErrors)

setRolesConfigLoader

public void setRolesConfigLoader(RolesConfigLoader rolesConfigLoader)

dispose

public void dispose()

getAvailableRoles

@NotNull
public List<Role> getAvailableRoles()

Description copied from interface: RolesManager

Returns list of roles configured in the system.

Specified by:

getAvailableRoles in interface RolesManager

Returns:

list of roles configured in the system.

getAvailableRolesMap

@NotNull
public Map<String,Role> getAvailableRolesMap()

Description copied from interface: RolesManager

Same as RolesManager.getAvailableRoles() but returns map where id of the role is a key.

Specified by:

getAvailableRolesMap in interface RolesManager

Returns:

map of roles

findRoleById

@Nullable
public Role findRoleById(@NotNull
                         String roleId)

Description copied from interface: RolesManager

Searches for a role with specified id

Specified by:

findRoleById in interface RolesManager

Parameters:

roleId - id of the role

Returns:

role with specified id or null

deleteRole

@Secured("MANAGE_ROLES")
public void deleteRole(@NotNull
                       Role role)

Description copied from interface: RolesManager

Deletes role

Specified by:

deleteRole in interface RolesManager

Parameters:

role - role to be deleted

createNewRole

@Secured("MANAGE_ROLES")
public Role createNewRole(@NotNull
                          String roleName)
                   throws DuplicateRoleException

Description copied from interface: RolesManager

Creates new role with given id and name

Specified by:

createNewRole in interface RolesManager

Parameters:

roleName - name

Returns:

the created role

Throws:

DuplicateRoleException - if a role roleName already exists

addPermissions

@Secured("MANAGE_ROLES")
public void addPermissions(@NotNull
                           RoleImpl role,
                           @NotNull
                           Permission... permissions)

Description copied from interface: RoleManipulator

Adds permissions to the role

Specified by:

addPermissions in interface RoleManipulator

Parameters:

role - role

permissions - permissions

removePermission

@Secured("MANAGE_ROLES")
public void removePermission(@NotNull
                             RoleImpl role,
                             @NotNull
                             Permission permission)

Description copied from interface: RoleManipulator

Removes permission from the role

Specified by:

removePermission in interface RoleManipulator

Parameters:

role - role

permission - permission

addIncludedRole

@Secured("MANAGE_ROLES")
public void addIncludedRole(@NotNull
                            RoleImpl role,
                            @NotNull
                            Role includedRole)

Description copied from interface: RoleManipulator

Includes includedRole to role

Specified by:

addIncludedRole in interface RoleManipulator

Parameters:

role - role

includedRole - role to include

removeIncludedRole

@Secured("MANAGE_ROLES")
public void removeIncludedRole(@NotNull
                               RoleImpl role,
                               @NotNull
                               Role includedRole)

Description copied from interface: RoleManipulator

Excludes includedRole from role

Specified by:

removeIncludedRole in interface RoleManipulator

Parameters:

role - role

includedRole - role to include

getSystemAdministratorRole

@NotNull
public Role getSystemAdministratorRole()

Description copied from interface: RolesManager

Returns predefined non configurable role representing system administrator. This role contains all of the permissions allowed in the server and it cannot be associated with a project.

Specified by:

getSystemAdministratorRole in interface RolesManager

Returns:

system administrator role, never null

getSuperUserRole

@NotNull
public Role getSuperUserRole()

Description copied from interface: RolesManager

Returns predefined non configurable role representing super user. This role contains all of the permissions and it cannot be associated with a project.

Specified by:

getSuperUserRole in interface RolesManager

Returns:

super user role, never null

saveRoles

public void saveRoles()

getAllIncludedRoles

public Collection<? extends Role> getAllIncludedRoles(@NotNull
                                                      Role role)

Description copied from interface: RolesManager

Collects all roles recursively inlcuded in the role

Specified by:

getAllIncludedRoles in interface RolesManager

Parameters:

role - role

Returns:

all roles included in the role

addRoleListener

public void addRoleListener(@NotNull
                            RoleListener listener)

Description copied from interface: RolesManager

Adds listener to the manager

Specified by:

addRoleListener in interface RolesManager

Parameters:

listener - listener to add

removeRoleListener

public void removeRoleListener(@NotNull
                               RoleListener listener)

Description copied from interface: RolesManager

Removes listener to the manager

Specified by:

removeRoleListener in interface RolesManager

Parameters:

listener - listener to remove

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

addRole

public void addRole(RoleImpl newRole)

isInitialized

@TestOnly
public boolean isInitialized()