com.atlassian.jira.permission
Interface PermissionSchemeManager

All Superinterfaces:

SchemeManager

All Known Implementing Classes:

DefaultPermissionSchemeManager, WorkflowBasedPermissionSchemeManager

public interface PermissionSchemeManager
extends SchemeManager

This class is used to handle Permission Schemes. Permission Schemes are created, removed and edited through this class

Field Summary

Fields inherited from interface com.atlassian.jira.scheme.SchemeManager

PROJECT_ASSOCIATION

Method Summary

void	flushSchemeEntities()
String	getAssociationType()
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long permissionId, String type, String parameter) Deprecated. Use getEntities(GenericValue, ProjectPermissionKey, String, String). Since v6.3.
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, ProjectPermissionKey permissionKey)
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, ProjectPermissionKey permissionKey, String parameter)
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, ProjectPermissionKey permissionKey, String type, String parameter) Get all Generic Value permission records for a particular scheme and permission Id
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, String permissionKey)
List<org.ofbiz.core.entity.GenericValue>	getEntitiesByType(org.ofbiz.core.entity.GenericValue scheme, ProjectPermissionKey permissionKey, String type)
String	getEntityName()
Collection<com.atlassian.crowd.embedded.api.Group>	getGroups(Long permissionId, Project project) Deprecated. Use getGroups(ProjectPermissionKey, Project). Since v6.3.
Collection<com.atlassian.crowd.embedded.api.Group>	getGroups(ProjectPermissionKey permissionKey, Project project)
String	getSchemeDesc()
String	getSchemeEntityName()
Collection<org.ofbiz.core.entity.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<com.atlassian.crowd.embedded.api.User>	getUsers(Long permissionId, PermissionContext ctx) Deprecated. Use getUsers(ProjectPermissionKey, PermissionContext). Since v6.3.
Collection<com.atlassian.crowd.embedded.api.User>	getUsers(ProjectPermissionKey permissionKey, PermissionContext ctx)
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity) Deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue). Since v6.3.
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity, com.atlassian.crowd.embedded.api.User user, boolean issueCreation) Deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue, User, boolean). Since v6.3.
boolean	hasSchemeAuthority(ProjectPermissionKey permissionKey, org.ofbiz.core.entity.GenericValue entity) Checks anonymous permission of the given permission type for the given entity.
boolean	hasSchemeAuthority(ProjectPermissionKey permissionKey, org.ofbiz.core.entity.GenericValue entity, com.atlassian.crowd.embedded.api.User user, boolean issueCreation) Checks the given user's permission of the given permission type for the given entity.

Methods inherited from interface com.atlassian.jira.scheme.SchemeManager

addDefaultSchemeToProject, addDefaultSchemeToProject, addSchemeToProject, addSchemeToProject, copyScheme, copyScheme, createDefaultScheme, createScheme, createSchemeAndEntities, createSchemeEntity, createSchemeObject, deleteEntity, deleteScheme, getAssociatedSchemes, getDefaultScheme, getDefaultSchemeObject, getEntities, getEntities, getEntities, getEntities, getEntities, getEntity, getGroups, getProjects, getProjects, getScheme, getScheme, getSchemeFor, getSchemeObject, getSchemeObject, getSchemeObjects, getSchemes, getSchemes, getUnassociatedSchemes, getUsers, getUsers, getUsers, removeEntities, removeEntities, removeSchemesFromProject, removeSchemesFromProject, schemeExists, updateScheme, updateScheme

Method Detail

getSchemeEntityName

String getSchemeEntityName()

getEntityName

String getEntityName()

getAssociationType

String getAssociationType()

getSchemeDesc

String getSchemeDesc()

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                     String permissionKey)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Specified by:

getEntities in interface SchemeManager

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

@ExperimentalApi
List<org.ofbiz.core.entity.GenericValue> getEntities(@NotNull
                                                                     org.ofbiz.core.entity.GenericValue scheme,
                                                                     @NotNull
                                                                     ProjectPermissionKey permissionKey)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

Since:

v6.3

getEntities

@Deprecated
List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                                Long permissionId,
                                                                String type,
                                                                String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getEntities(GenericValue, ProjectPermissionKey, String, String). Since v6.3.

Get all Generic Value permission records for a particular scheme and permission Id

Parameters:

scheme - The scheme that the permissions belong to

permissionId - The Id of the permission

parameter - The permission parameter (group name etc)

type - The type of the permission(Group, Current Reporter etc)

Returns:

List of (GenericValue) permissions

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

@ExperimentalApi
List<org.ofbiz.core.entity.GenericValue> getEntities(@NotNull
                                                                     org.ofbiz.core.entity.GenericValue scheme,
                                                                     @NotNull
                                                                     ProjectPermissionKey permissionKey,
                                                                     @NotNull
                                                                     String type,
                                                                     @NotNull
                                                                     String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Get all Generic Value permission records for a particular scheme and permission Id

Parameters:

scheme - The scheme that the permissions belong to

permissionKey - The key of the permission

parameter - The permission parameter (group name etc)

type - The type of the permission(Group, Current Reporter etc)

Returns:

List of (GenericValue) permissions

Throws:

org.ofbiz.core.entity.GenericEntityException

Since:

v6.3

getEntities

@ExperimentalApi
List<org.ofbiz.core.entity.GenericValue> getEntities(@NotNull
                                                                     org.ofbiz.core.entity.GenericValue scheme,
                                                                     @NotNull
                                                                     ProjectPermissionKey permissionKey,
                                                                     @NotNull
                                                                     String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

Since:

v6.3

getEntitiesByType

@ExperimentalApi
List<org.ofbiz.core.entity.GenericValue> getEntitiesByType(@NotNull
                                                                           org.ofbiz.core.entity.GenericValue scheme,
                                                                           @NotNull
                                                                           ProjectPermissionKey permissionKey,
                                                                           @NotNull
                                                                           String type)
                                                           throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

Since:

v6.3

flushSchemeEntities

void flushSchemeEntities()

getSchemesContainingEntity

Collection<org.ofbiz.core.entity.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.

Parameters:

type - is the entity type

parameter - is the scheme entries parameter value

Returns:

Collection of GenericValues that represents a scheme

hasSchemeAuthority

@Deprecated
boolean hasSchemeAuthority(Long entityType,
                                      org.ofbiz.core.entity.GenericValue entity)

Deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue). Since v6.3.

Description copied from interface: SchemeManager

Checks anonymous permission of the given permission type for the given entity.

Specified by:

hasSchemeAuthority in interface SchemeManager

Parameters:

entityType - permission type.

entity - the entity to which permission is being checked.

Returns:

true only if the anonymous user is permitted.

hasSchemeAuthority

@ExperimentalApi
boolean hasSchemeAuthority(@NotNull
                                           ProjectPermissionKey permissionKey,
                                           @NotNull
                                           org.ofbiz.core.entity.GenericValue entity)

Checks anonymous permission of the given permission type for the given entity.

Parameters:

permissionKey - permission key.

entity - the entity to which permission is being checked.

Returns:

true only if the anonymous user is permitted.

Since:

v6.3

hasSchemeAuthority

@Deprecated
boolean hasSchemeAuthority(Long entityType,
                                      org.ofbiz.core.entity.GenericValue entity,
                                      com.atlassian.crowd.embedded.api.User user,
                                      boolean issueCreation)

Deprecated. Use hasSchemeAuthority(ProjectPermissionKey, GenericValue, User, boolean). Since v6.3.

Description copied from interface: SchemeManager

Checks the given user's permission of the given permission type for the given entity.

Specified by:

hasSchemeAuthority in interface SchemeManager

Parameters:

entityType - permission type.

entity - the entity to which permission is being checked.

user - the user.

issueCreation - whether the permission is for creating an issue.

Returns:

true only if the user is permitted.

hasSchemeAuthority

@ExperimentalApi
boolean hasSchemeAuthority(@NotNull
                                           ProjectPermissionKey permissionKey,
                                           @NotNull
                                           org.ofbiz.core.entity.GenericValue entity,
                                           @NotNull
                                           com.atlassian.crowd.embedded.api.User user,
                                           boolean issueCreation)

Checks the given user's permission of the given permission type for the given entity.

Parameters:

permissionKey - permission key.

entity - the entity to which permission is being checked.

user - the user.

issueCreation - whether the permission is for creating an issue.

Returns:

true only if the user is permitted.

Since:

v6.3

getGroups

@Deprecated
Collection<com.atlassian.crowd.embedded.api.Group> getGroups(Long permissionId,
                                                                        Project project)

Deprecated. Use getGroups(ProjectPermissionKey, Project). Since v6.3.

Specified by:

getGroups in interface SchemeManager

getGroups

@ExperimentalApi
Collection<com.atlassian.crowd.embedded.api.Group> getGroups(@NotNull
                                                                             ProjectPermissionKey permissionKey,
                                                                             @NotNull
                                                                             Project project)

Since:

v6.3

getUsers

@Deprecated
Collection<com.atlassian.crowd.embedded.api.User> getUsers(Long permissionId,
                                                                      PermissionContext ctx)

Deprecated. Use getUsers(ProjectPermissionKey, PermissionContext). Since v6.3.

Specified by:

getUsers in interface SchemeManager

getUsers

@ExperimentalApi
Collection<com.atlassian.crowd.embedded.api.User> getUsers(@NotNull
                                                                           ProjectPermissionKey permissionKey,
                                                                           @NotNull
                                                                           PermissionContext ctx)

Since:

v6.3