com.atlassian.jira.security.roles.ProjectRoleManager |
Known Indirect Subclasses |
This class allows us to CRUD ProjectRoles. A Project Role is way of grouping the users associated with a project (eg 'Testers', 'Developers').
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ProjectRoleManager.ProjectIdToProjectRoleIdsMap | This class implements is backed by the map with project ID as a key and a collection of project role IDs as the mapped value of the map. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method will insert all the default roles into the role associations for the provided project.
| |||||||||||
This method is deprecated.
Use
createProjectIdToProjectRolesMap(com.atlassian.jira.user.ApplicationUser, java.util.Collection) instead. Since v6.0.
| |||||||||||
Creates a project role object
| |||||||||||
Deletes a project role object
| |||||||||||
This method will return the default role actors for a
ProjectRole | |||||||||||
Returns the project id's which contain a role actor of the specified name and type within any role.
| |||||||||||
Returns a Map of Lists.
| |||||||||||
Retrieves a project role object
| |||||||||||
Retrieves a project role object by name
| |||||||||||
This method will retrieve the object that represents the actors associate with the given
projectRole
and project context | |||||||||||
This method is deprecated.
Use this.getProjectRoles instead. Since v6.0.
| |||||||||||
Get all the ProjectRoles available in JIRA.
| |||||||||||
This will return all the
ProjectRole s that the user is currently a member of for the given project. | |||||||||||
Will tell you if a role name exists or not.
| |||||||||||
This method is deprecated.
Use
isUserInProjectRole(com.atlassian.jira.user.ApplicationUser, ProjectRole, com.atlassian.jira.project.Project) instead. Since v6.0.
| |||||||||||
Returns true only if the given user is in the given project role for the
given project.
| |||||||||||
This will remove all role actors with the specified name and the specified type.
| |||||||||||
Will remove all role actors associated with the specified project.
| |||||||||||
Returns a list of projectId's for which the role actor of the specified type exists in the project for the
provided projectRole.
| |||||||||||
This method will update the associations of actors for the default projectRole, specified by the given
defaultRoleActors object.
| |||||||||||
Commits the given ProjectRoleActors to permanent store, saving any updates made.
| |||||||||||
Updates a project role object
|
This method will insert all the default roles into the role associations for the provided project. If one of the default actors is already associated with the project, we will leave that association. NOTE: This method is meant to only be called immediatly after a project is created.
project | the project to associate the role defaults with |
---|
IllegalArgumentException | if project
|
---|
This method is deprecated.
Use createProjectIdToProjectRolesMap(com.atlassian.jira.user.ApplicationUser, java.util.Collection)
instead. Since v6.0.
Creates a project role object
projectRole | the project role to create, if the id field is non-null then this will be ignored. Only the roles name and description are used by this method. |
---|
IllegalArgumentException | is thrown if projectRole or projectRole.getName are null
|
---|
Deletes a project role object
IllegalArgumentException | is thrown if the projectRole is null
|
---|
This method will return the default role actors for a ProjectRole
IllegalArgumentException | will be thrown if ProjectRole is null
|
---|
Returns the project id's which contain a role actor of the specified name and type within any role. This is a method that is provided so that you can efficiently tell which users or groups have been associated with any role within projects.
name | this is the name that the role actor is stored under (ex. username of 'admin', group name of 'jira-users') |
---|---|
type | this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE) |
Returns a Map of Lists. The key of the map is a Long, project id and the value of the map is a list of group names that the user is a member of for the project. This method is meant to provide an efficient means to discover which groups that are associated with a project role implicitly include the specified user in that project role. We allow you to specify a range of projectsToLimitBy so that you can perform only one query to find this information for many projects for a single projectRole.
projectsToLimitBy | this will limit the range of projects the method queries. This is a list of Long, project id's. The returned list will be either the same as this list or a subset. |
---|---|
projectRole | the project role to find out if an actor is a member of. |
projectRoleType | the type of role actor you want to query for, in most cases this will be UserRoleActor.TYPE. |
userName | the username to find out if the user is in the role because of a group |
Retrieves a project role object
IllegalArgumentException | is thrown if the id is null
|
---|
Retrieves a project role object by name
IllegalArgumentException | is thrown if the name is null, or an empty String
|
---|
This method will retrieve the object that represents the actors associate with the given projectRole
and project
context
IllegalArgumentException | if the given projectRole or project is null
|
---|
This method is deprecated.
Use this.getProjectRoles instead. Since v6.0.
This will return all the ProjectRole
s that the user is currently a member of for the given project.
user | the user |
---|---|
project | the project |
IllegalArgumentException | is thrown if the project is null |
---|
Get all the ProjectRoles available in JIRA. Currently this list is global.
This will return all the ProjectRole
s that the user is currently a member of for the given project.
user | the user |
---|---|
project | the project |
IllegalArgumentException | is thrown if the project is null
|
---|
Will tell you if a role name exists or not.
name | the name of the project role to check |
---|
This method is deprecated.
Use isUserInProjectRole(com.atlassian.jira.user.ApplicationUser, ProjectRole, com.atlassian.jira.project.Project)
instead. Since v6.0.
Returns true only if the given user is in the given project role for the given project. This could be because they are a member of a particular group (groups can be in roles) as well as being a user in a role.
user | The user to check. If user is null, this will implicitly return false. |
---|---|
projectRole | The role. |
project | The project. |
IllegalArgumentException | if ProjectRole or Project is null. |
---|
Returns true only if the given user is in the given project role for the given project. This could be because they are a member of a particular group (groups can be in roles) as well as being a user in a role.
user | The user to check. If user is null, this will implicitly return false. |
---|---|
projectRole | The role. |
project | The project. |
IllegalArgumentException | if ProjectRole or Project is null.
|
---|
This will remove all role actors with the specified name and the specified type. This method should be used to clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system).
type | this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE) |
---|
IllegalArgumentException | if name or type is null
|
---|
Will remove all role actors associated with the specified project. This method should be used to clean up just before the actual project has been deleted (ex. deleting a project from the system).
project | this is the project that the role actors are associated with |
---|
IllegalArgumentException | if the project is null
|
---|
Returns a list of projectId's for which the role actor of the specified type exists in the project for the provided projectRole. This is a method that is meant to efficiently allow discovery of whether a UserRoleActor exists in a project role for a subset of projects.
projectsToLimitBy | this will limit the range of projects the method queries. This is a list of Long, project id's. The returned list will be either the same as this list or a subset. |
---|---|
projectRole | the project role to find out if an actor is a member of. |
projectRoleType | the type of role actor you want to query for, in most cases this will be UserRoleActor.TYPE. |
projectRoleParameter | the parameter describing the role actor, in the case of a UserRoleActor this will be the username. |
This method will update the associations of actors for the default projectRole, specified by the given defaultRoleActors object. The actors will be updated to reflect the state of the roleActors set contained within the given defaultRoleActors object.
IllegalArgumentException | if the given defaultRoleActors is null or the projectRole
or roleActors is null.
|
---|
Commits the given ProjectRoleActors to permanent store, saving any updates made.
IllegalArgumentException | if the given projectRoleActors is null or the projectRoleActors
project, projectRole or roleActors is null.
|
---|
Updates a project role object
IllegalArgumentException | is thrown if the projectRole or projectRole.getName() is null
|
---|