WorkflowBasedPermissionSchemeManager

Class Overview

Custom permission scheme manager that allows the list of assignable users to be restricted by workflow state. In jira-workflow.xml, every step can have a meta attribute stating which groups are assignable:

<step id="23" name="Pending Biz User Approval"> .... <meta name="jira.permission.assignable.group">${pkey}-bizusers</meta>

When getUsers(Long, PermissionContext) is called to discover assignable users, this permission scheme manager first does the regular "Assignable" check, and then filters returned users for membership of the 'jira.permission.assignable.group' (in this example). If jira.permission.assignable.* isn't specified for a step, all permission-derived users are returned.

Summary

[Expand] Inherited Constants
From interface com.atlassian.jira.scheme.SchemeManager String PROJECT_ASSOCIATION The one and only "association type".

[Expand] Inherited Fields
From class com.atlassian.jira.scheme.AbstractSchemeManager protected final EventPublisher eventPublisher protected final GroupManager groupManager protected final ProjectManager projectManager protected final SchemeFactory schemeFactory protected final SecurityTypeManager securityTypeManager

[Expand] Inherited Methods
From class com.atlassian.jira.permission.DefaultPermissionSchemeManager AbstractSchemeAddedToProjectEvent createSchemeAddedToProjectEvent(Scheme scheme, Project project) @Nonnull AbstractSchemeCopiedEvent createSchemeCopiedEvent(Scheme oldScheme, Scheme newScheme) AbstractSchemeEvent createSchemeCreatedEvent(Scheme scheme) GenericValue createSchemeEntity(GenericValue scheme, SchemeEntity schemeEntity) Create a new permission record in the database AbstractSchemeEntityEvent createSchemeEntityDeletedEvent(GenericValue entity) GenericValue createSchemeEntityNoEvent(GenericValue scheme, SchemeEntity schemeEntity) AbstractSchemeRemovedFromProjectEvent createSchemeRemovedFromProjectEvent(Scheme scheme, Project project) AbstractSchemeUpdatedEvent createSchemeUpdatedEvent(Scheme scheme, Scheme originalScheme) void deleteEntity(Long id) Deletes a permission from the database void deleteScheme(Long id) Deletes a scheme from the database void flushSchemeEntities() String getDefaultDescriptionKey() String getDefaultNameKey() List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey, String type, String parameter) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntities(GenericValue scheme) Get all Scheme entity records for a particular scheme List<GenericValue> getEntities(GenericValue scheme, String permissionKey) List<GenericValue> getEntities(GenericValue scheme, Long permissionId, String type, String parameter) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntities(GenericValue scheme, Long permissionId, String parameter) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey) List<GenericValue> getEntities(GenericValue scheme, String type, Long permissionId) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey, String parameter) List<GenericValue> getEntities(GenericValue scheme, Long permissionId) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntitiesByType(GenericValue scheme, ProjectPermissionKey permissionKey, String type) String getEntityName() Collection<Group> getGroups(Long entityTypeId, Project project) Collection<Group> getGroups(Long entityTypeId, GenericValue project) Collection<Group> getGroups(ProjectPermissionKey permissionKey, Project project) String getSchemeDesc() String getSchemeEntityName() Collection<GenericValue> getSchemesContainingEntity(String type, String parameter) This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter. Collection<User> getUsers(ProjectPermissionKey permissionKey, PermissionContext ctx) boolean hasSchemeAuthority(Long permissionId, GenericValue project, User user, boolean issueCreation) Checks to see if the user has any specific permissions for that permission type. boolean hasSchemeAuthority(ProjectPermissionKey permissionKey, GenericValue project) Checks to see if there is an anyone permission for that permission type. boolean hasSchemeAuthority(Long permissionId, GenericValue project) Checks to see if there is an anyone permission for that permission type. boolean hasSchemeAuthority(ProjectPermissionKey permissionKey, GenericValue project, User user, boolean issueCreation) Checks the given user's permission of the given permission type for the given entity. SchemeEntity makeSchemeEntity(GenericValue entity) void onClearCache(ClearCacheEvent event) boolean removeEntities(GenericValue scheme, Long permissionId) Retrieves all the entites for this permission and then removes them. boolean removeEntities(String type, String parameter) Removes all scheme entities with this parameter void start() Registers this CachingFieldConfigContextPersister's cache in the JIRA instrumentation.
From class com.atlassian.jira.scheme.AbstractSchemeManager void addDefaultSchemeToProject(GenericValue project) Adds the default scheme to a particular project void addDefaultSchemeToProject(Project project) Adds the default scheme to a particular project void addSchemeToProject(Project project, Scheme scheme) Adds a scheme to a particular project @Deprecated void addSchemeToProject(GenericValue project, GenericValue scheme) Adds a scheme to a particular project GenericValue copyScheme(GenericValue oldScheme) Copys a scheme, giving the new scheme the same entities as the original one Scheme copyScheme(Scheme oldScheme) Copys a scheme, giving the new scheme the same entities as the original one GenericValue createDefaultScheme() Creates a default scheme, with an id of 0 GenericValue createScheme(String name, String description) Creates a new scheme @Nonnull abstract AbstractSchemeAddedToProjectEvent createSchemeAddedToProjectEvent(Scheme scheme, Project project) Scheme createSchemeAndEntities(Scheme scheme) @Nonnull abstract AbstractSchemeCopiedEvent createSchemeCopiedEvent(Scheme oldScheme, Scheme newScheme) abstract AbstractSchemeEvent createSchemeCreatedEvent(Scheme scheme) @Nullable abstract Object createSchemeEntityDeletedEvent(GenericValue entity) abstract GenericValue createSchemeEntityNoEvent(GenericValue scheme, SchemeEntity schemeEntity) GenericValue createSchemeGenericValue(Map<String, Object> values) GenericValue createSchemeNoEvent(String name, String description) Scheme createSchemeObject(String name, String description) Creates a new scheme @Nonnull abstract AbstractSchemeRemovedFromProjectEvent createSchemeRemovedFromProjectEvent(Scheme scheme, Project project) abstract AbstractSchemeUpdatedEvent createSchemeUpdatedEvent(Scheme scheme, Scheme originalScheme) void deleteEntity(Long id) Deletes an entity with the given id from the database. void deleteScheme(Long id) Deletes a scheme from the database void flushProjectSchemes() I18nHelper getApplicationI18n() List<Scheme> getAssociatedSchemes(boolean withEntitiesComparable) Gets all schemes of this type in the database taht are associated with at least one project. @Deprecated String getAssociationType() This method is deprecated. Just assume all schemes are project association schemes. abstract String getDefaultDescriptionKey() abstract String getDefaultNameKey() GenericValue getDefaultScheme() Gets the default scheme. Scheme getDefaultSchemeObject() Gets the default scheme. List<GenericValue> getEntities(GenericValue scheme) Get all Scheme entity records for a particular scheme List<GenericValue> getEntities(String type, String parameter) Get all entity records with a particular parameter GenericValue getEntity(Long id) Gets a scheme entity based on the id of the entity abstract String getEntityName() Collection<Group> getGroups(Long entityTypeId, Project project) Collection<Group> getGroups(Long entityTypeId, GenericValue project) String getNameForCopy(String originalName, Integer abbreviateTo) @Deprecated List<GenericValue> getProjects(GenericValue scheme) Gets all projects that are associated with that scheme List<Project> getProjects(Scheme scheme) Gets all projects that are associated with that scheme GenericValue getScheme(Long id) Gets a scheme based on the Id of the scheme GenericValue getScheme(String name) Gets a scheme by name from the database. abstract String getSchemeDesc() abstract String getSchemeEntityName() Scheme getSchemeFor(Project project) Get the scheme of this type attached to the given project. @Nullable Scheme getSchemeObject(String name) Gets a scheme by name from the database. @Nullable Scheme getSchemeObject(Long id) Gets a scheme by id from the database. List<Scheme> getSchemeObjects() Gets all scheme objects in the database. List<GenericValue> getSchemes(GenericValue project) Get all schemes of this type attached to the given project. List<GenericValue> getSchemes() Gets all the Schemes (of the type defined by the subclass) from the database. List<Scheme> getUnassociatedSchemes() Will return all @link Scheme objects that are not currently associated with any projects. Collection<User> getUsers(Long permissionId, Issue issue) Collection<User> getUsers(Long permissionId, GenericValue projectOrIssue) Collection<User> getUsers(Long permissionId, Project project) Collection<User> getUsers(Long permissionId, PermissionContext ctx) abstract SchemeEntity makeSchemeEntity(GenericValue schemeEntityGV) void onClearCache(ClearCacheEvent event) boolean removeEntities(GenericValue scheme, Long entityTypeId) Retrieves all the entites for this permission and then removes them. boolean removeEntities(String type, String parameter) Removes all scheme entities with this parameter and type void removeSchemesFromProject(Project project) Removes all schemes from a project @Deprecated void removeSchemesFromProject(GenericValue project) Removes all schemes from a project boolean schemeExists(String name) Determine if the given scheme name exists. void updateScheme(Scheme scheme) Updates any changes to the scheme object. void updateScheme(GenericValue entity) Updates any changes to the given scheme
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.atlassian.jira.extension.Startable void start() This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework.
From interface com.atlassian.jira.permission.PermissionSchemeManager void flushSchemeEntities() String getAssociationType() @Deprecated List<GenericValue> getEntities(GenericValue scheme, Long permissionId, String type, String parameter) This method is deprecated. Use getEntities(GenericValue, ProjectPermissionKey, String, String). Since v6.3. List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey) List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey, String parameter) List<GenericValue> getEntities(GenericValue scheme, ProjectPermissionKey permissionKey, String type, String parameter) Get all Generic Value permission records for a particular scheme and permission Id List<GenericValue> getEntities(GenericValue scheme, String permissionKey) List<GenericValue> getEntitiesByType(GenericValue scheme, ProjectPermissionKey permissionKey, String type) String getEntityName() @Deprecated Collection<Group> getGroups(Long permissionId, Project project) This method is deprecated. Use getGroups(ProjectPermissionKey, Project). Since v6.3. Collection<Group> getGroups(ProjectPermissionKey permissionKey, Project project) String getSchemeDesc() String getSchemeEntityName() Collection<GenericValue> getSchemesContainingEntity(String type, String parameter) This is a method that is meant to quickly get you all the schemes that contain an entity of the specified type and parameter. Collection<User> getUsers(ProjectPermissionKey permissionKey, PermissionContext ctx) @Deprecated Collection<User> getUsers(Long permissionId, PermissionContext ctx) This method is deprecated. Use getUsers(ProjectPermissionKey, PermissionContext). Since v6.3. @Deprecated boolean hasSchemeAuthority(Long entityType, GenericValue entity) This method is deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue). Since v6.3. @Deprecated boolean hasSchemeAuthority(Long entityType, GenericValue entity, User user, boolean issueCreation) This method is deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue, User, boolean). Since v6.3. boolean hasSchemeAuthority(ProjectPermissionKey permissionKey, GenericValue entity, User user, boolean issueCreation) Checks the given user's permission of the given permission type for the given entity. boolean hasSchemeAuthority(ProjectPermissionKey permissionKey, GenericValue entity) Checks anonymous permission of the given permission type for the given entity.
From interface com.atlassian.jira.scheme.SchemeManager void addDefaultSchemeToProject(GenericValue project) This method is deprecated. Use addDefaultSchemeToProject(com.atlassian.jira.project.Project) instead. Since v5.0. void addDefaultSchemeToProject(Project project) Adds the default scheme to a particular project void addSchemeToProject(Project project, Scheme scheme) Adds a scheme to a particular project void addSchemeToProject(GenericValue project, GenericValue scheme) This method is deprecated. Use addSchemeToProject(com.atlassian.jira.project.Project, Scheme) instead. Since v5.0. GenericValue copyScheme(GenericValue scheme) This method is deprecated. Use copyScheme(Scheme) instead. Since v5.0. Scheme copyScheme(Scheme scheme) Copys a scheme, giving the new scheme the same entities as the original one GenericValue createDefaultScheme() Creates a default scheme, with an id of 0 GenericValue createScheme(String name, String description) This method is deprecated. Use createSchemeObject(String, String) instead. Since v5.0. Scheme createSchemeAndEntities(Scheme scheme) GenericValue createSchemeEntity(GenericValue scheme, SchemeEntity entity) Scheme createSchemeObject(String name, String description) Creates a new scheme void deleteEntity(Long id) Deletes an entity with the given id from the database. void deleteScheme(Long id) Deletes a scheme from the database List<Scheme> getAssociatedSchemes(boolean withEntitiesComparable) Gets all schemes of this type in the database taht are associated with at least one project. GenericValue getDefaultScheme() This method is deprecated. Use getDefaultSchemeObject() instead. Since v5.0. Scheme getDefaultSchemeObject() Gets the default scheme. List<GenericValue> getEntities(GenericValue scheme, String type, Long entityTypeId) List<GenericValue> getEntities(GenericValue scheme) Get all Scheme entity records for a particular scheme List<GenericValue> getEntities(GenericValue scheme, String entityTypeId) List<GenericValue> getEntities(String type, String parameter) Get all entity records with a particular parameter List<GenericValue> getEntities(GenericValue scheme, Long entityTypeId, String parameter) List<GenericValue> getEntities(GenericValue scheme, Long entityTypeId) GenericValue getEntity(Long id) Gets a scheme entity based on the id of the entity Collection<Group> getGroups(Long permissionId, Project project) Collection<Group> getGroups(Long permissionId, GenericValue project) This method is deprecated. Use getGroups(Long, com.atlassian.jira.project.Project) instead. Since v5.0. @Deprecated List<GenericValue> getProjects(GenericValue scheme) This method is deprecated. Use getProjects(Scheme) instead. Since 2009. List<Project> getProjects(Scheme scheme) Gets all projects that are associated with that scheme GenericValue getScheme(Long id) This method is deprecated. Use getSchemeObject(Long) instead. Since v5.0. GenericValue getScheme(String name) This method is deprecated. use getSchemeObject(String) instead. Since 2010. Scheme getSchemeFor(Project project) Get the scheme of this type attached to the given project. Scheme getSchemeObject(String name) Gets a scheme by name from the database. Scheme getSchemeObject(Long id) Gets a scheme by id from the database. List<Scheme> getSchemeObjects() Gets all scheme objects in the database. List<GenericValue> getSchemes(GenericValue project) This method is deprecated. Use getSchemeFor(com.atlassian.jira.project.Project) instead. Since v5.0. List<GenericValue> getSchemes() This method is deprecated. use getSchemeObjects(). Since 2010. List<Scheme> getUnassociatedSchemes() Will return all @link Scheme objects that are not currently associated with any projects. Collection<User> getUsers(Long permissionId, Issue issue) @Deprecated Collection<User> getUsers(Long permissionId, GenericValue issueOrProject) This method is deprecated. Use getUsers(Long, com.atlassian.jira.permission.PermissionContext) instead. Since 2006. Collection<User> getUsers(Long permissionId, Project project) Collection<User> getUsers(Long permissionId, PermissionContext ctx) boolean hasSchemeAuthority(Long entityType, GenericValue entity, User user, boolean issueCreation) Checks the given user's permission of the given permission type for the given entity. boolean hasSchemeAuthority(Long entityType, GenericValue entity) Checks anonymous permission of the given permission type for the given entity. boolean removeEntities(GenericValue scheme, Long entityTypeId) This method is deprecated. Use getEntities(org.ofbiz.core.entity.GenericValue, Long) and deleteEntity(Long) instead. Since v5.0. boolean removeEntities(String type, String parameter) Removes all scheme entities with this parameter and type void removeSchemesFromProject(Project project) Removes all schemes from a project void removeSchemesFromProject(GenericValue project) This method is deprecated. Use removeSchemesFromProject(com.atlassian.jira.project.Project) instead. Since v4.4. boolean schemeExists(String name) Determine if the given scheme name exists. void updateScheme(Scheme scheme) Updates any changes to the scheme object. void updateScheme(GenericValue entity) This method is deprecated. Use updateScheme(Scheme) instead. Since v5.0.