com.atlassian.crucible.spi.services

Interface PermissionSchemeService

public interface PermissionSchemeService

Provides an API for working with permission schemes

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PERMISSION_SCHEME_NAME_PATTERN

Method Summary

Modifier and Type	Method and Description
boolean	addPermissionSchemeAnonymousUsers(java.lang.String permissionSchemeName, PrincipalAssociationData principalAssociationData) Add anonymous-users principal association
boolean	addPermissionSchemeGroup(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Add group principal association
boolean	addPermissionSchemeLoggedUsers(java.lang.String permissionSchemeName, PrincipalAssociationData principalAssociationData) Add logged-in-users principal association
boolean	addPermissionSchemeReviewRole(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Add role principal association
boolean	addPermissionSchemeUser(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Add user principal association
int	countPermissionSchemes(PermissionSchemeSearchCriteria permissionSchemeSearchCriteria) Returns the number of permission schemes filtered by permission search criteria
void	create(PermissionSchemeData permissionSchemeData) Create permission scheme
void	createFrom(java.lang.String copyFromPermissionSchemeName, java.lang.String newPermissionSchemeName) Creates a permission scheme from an existing permission scheme
void	delete(java.lang.String name) Delete permisison scheme.
boolean	deletePermissionSchemeAnonymousUsersLoggedUsers(java.lang.String permissionSchemeName, PrincipalAssociationData principalAssociationData) Delete anonymous-users principal association
boolean	deletePermissionSchemeGroup(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Delete group principal association
boolean	deletePermissionSchemeLoggedUsers(java.lang.String permissionSchemeName, PrincipalAssociationData principalAssociationData) Delete logged-in-users principal association
boolean	deletePermissionSchemeRole(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Delete role principal association
boolean	deletePermissionSchemeUser(java.lang.String permissionSchemeName, NamedPrincipalAssociationData principalAssociationData) Delete user principal association
PermissionSchemeData	findByName(java.lang.String permissionSchemeName) Finds a permission scheme based on permission scheme name
java.lang.Integer	getId(java.lang.String name) Return permission scheme name
java.lang.String	getName(int id) Returns the permission scheme name
void	rename(java.lang.String oldName, java.lang.String newName) Rename permission scheme
Page<PrincipalAssociationData>	searchAnonymousUsersPrincipalAssociation(java.lang.String permissionSchemeName, PrincipalAssociationSearchCriteria principalAssociationSearchCriteria, PageRequest pageRequest) Page of anonymous-users principal associations (action name)specified in this permission scheme
Page<NamedPrincipalAssociationData>	searchGroupsPrincipalAssociation(java.lang.String permissionSchemeName, NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria, PageRequest pageRequest) Page of groups principal associations (group name, action name)specified in this permission scheme
Page<PrincipalAssociationData>	searchLoggedUsersPrincipalAssociation(java.lang.String permissionSchemeName, PrincipalAssociationSearchCriteria principalAssociationSearchCriteria, PageRequest pageRequest) Page of logged-in-users principal associations (action name)specified in this permission scheme
Page<PermissionSchemeData>	searchPermissionSchemes(PermissionSchemeSearchCriteria permissionSchemeSearchCriteria, PageRequest pageRequest) Returns a paged list of permission schemes.
Page<NamedPrincipalAssociationData>	searchRolesPrincipalAssociation(java.lang.String permissionSchemeName, NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria, PageRequest pageRequest) Page of roles principal associations (role name, action name)specified in this permission scheme
Page<NamedPrincipalAssociationData>	searchUsersPrincipalAssociation(java.lang.String permissionSchemeName, NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria, PageRequest pageRequest) Page of users principal associations (username, action name)specified in this permission scheme

Field Detail

PERMISSION_SCHEME_NAME_PATTERN

static final java.lang.String PERMISSION_SCHEME_NAME_PATTERN

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName(int id)

Returns the permission scheme name

Parameters:

id - permission scheme id

Returns:

name of permission scheme

getId

java.lang.Integer getId(java.lang.String name)

Return permission scheme name

Parameters:

name - permission scheme name

Returns:

permission scheme id

countPermissionSchemes

int countPermissionSchemes(PermissionSchemeSearchCriteria permissionSchemeSearchCriteria)

Returns the number of permission schemes filtered by permission search criteria

Returns:

number of permission schemes

searchPermissionSchemes

Page<PermissionSchemeData> searchPermissionSchemes(PermissionSchemeSearchCriteria permissionSchemeSearchCriteria,
                                                   PageRequest pageRequest)

Returns a paged list of permission schemes.

Parameters:

permissionSchemeSearchCriteria - permission scheme search criteria

pageRequest -

Returns:

paged list of permission schemes

findByName

PermissionSchemeData findByName(java.lang.String permissionSchemeName)

Finds a permission scheme based on permission scheme name

Parameters:

permissionSchemeName - permission scheme name

Returns:

permission scheme

searchUsersPrincipalAssociation

Page<NamedPrincipalAssociationData> searchUsersPrincipalAssociation(java.lang.String permissionSchemeName,
                                                                    NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria,
                                                                    PageRequest pageRequest)

Page of users principal associations (username, action name)specified in this permission scheme

Parameters:

permissionSchemeName - permission scheme name

namedPrincipalAssociationSearchCriteria - user principal association search criteria

Returns:

page of users principal associations

addPermissionSchemeUser

boolean addPermissionSchemeUser(java.lang.String permissionSchemeName,
                                NamedPrincipalAssociationData principalAssociationData)

Add user principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - user principal association data (username, action name)

Returns:

true if user principal association was added and false if already in list

deletePermissionSchemeUser

boolean deletePermissionSchemeUser(java.lang.String permissionSchemeName,
                                   NamedPrincipalAssociationData principalAssociationData)

Delete user principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - user principal association data (username, action name)

Returns:

true if user principal association was deleted and false if not in list

searchGroupsPrincipalAssociation

Page<NamedPrincipalAssociationData> searchGroupsPrincipalAssociation(java.lang.String permissionSchemeName,
                                                                     NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria,
                                                                     PageRequest pageRequest)

Page of groups principal associations (group name, action name)specified in this permission scheme

Parameters:

permissionSchemeName - permission scheme name

namedPrincipalAssociationSearchCriteria - group principal association search criteria

Returns:

page of groups principal associations

addPermissionSchemeGroup

boolean addPermissionSchemeGroup(java.lang.String permissionSchemeName,
                                 NamedPrincipalAssociationData principalAssociationData)

Add group principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - group principal association data (group name, action name)

Returns:

true if group principal association was added and false if already in list

deletePermissionSchemeGroup

boolean deletePermissionSchemeGroup(java.lang.String permissionSchemeName,
                                    NamedPrincipalAssociationData principalAssociationData)

Delete group principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - group principal association data (group name, action name)

Returns:

true if user principal association was deleted and false if not in list

searchRolesPrincipalAssociation

Page<NamedPrincipalAssociationData> searchRolesPrincipalAssociation(java.lang.String permissionSchemeName,
                                                                    NamedPrincipalAssociationSearchCriteria namedPrincipalAssociationSearchCriteria,
                                                                    PageRequest pageRequest)

Page of roles principal associations (role name, action name)specified in this permission scheme

Parameters:

permissionSchemeName - permission scheme name

namedPrincipalAssociationSearchCriteria - role principal association search criteria

Returns:

page of roles principal associations

addPermissionSchemeReviewRole

boolean addPermissionSchemeReviewRole(java.lang.String permissionSchemeName,
                                      NamedPrincipalAssociationData principalAssociationData)

Add role principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - role principal association data (role name, action name)

Returns:

true if role principal association was added and false if already in list

deletePermissionSchemeRole

boolean deletePermissionSchemeRole(java.lang.String permissionSchemeName,
                                   NamedPrincipalAssociationData principalAssociationData)

Delete role principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - role principal association data (role name, action name)

Returns:

true if role principal association was deleted and false if not in list

searchLoggedUsersPrincipalAssociation

Page<PrincipalAssociationData> searchLoggedUsersPrincipalAssociation(java.lang.String permissionSchemeName,
                                                                     PrincipalAssociationSearchCriteria principalAssociationSearchCriteria,
                                                                     PageRequest pageRequest)

Page of logged-in-users principal associations (action name)specified in this permission scheme

Parameters:

permissionSchemeName - permission scheme name

principalAssociationSearchCriteria - logged-in-users principal association search criteria

Returns:

page of logged-in-users principal associations

addPermissionSchemeLoggedUsers

boolean addPermissionSchemeLoggedUsers(java.lang.String permissionSchemeName,
                                       PrincipalAssociationData principalAssociationData)

Add logged-in-users principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - logged-in-users principal association data (action name)

Returns:

true if logged-in-users principal association was added and false if already in list

deletePermissionSchemeLoggedUsers

boolean deletePermissionSchemeLoggedUsers(java.lang.String permissionSchemeName,
                                          PrincipalAssociationData principalAssociationData)

Delete logged-in-users principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - logged-in-users principal association data (action name)

Returns:

true if logged-in-users principal association was deleted and false if not in list

searchAnonymousUsersPrincipalAssociation

Page<PrincipalAssociationData> searchAnonymousUsersPrincipalAssociation(java.lang.String permissionSchemeName,
                                                                        PrincipalAssociationSearchCriteria principalAssociationSearchCriteria,
                                                                        PageRequest pageRequest)

Page of anonymous-users principal associations (action name)specified in this permission scheme

Parameters:

permissionSchemeName - permission scheme name

principalAssociationSearchCriteria - anonymous-users principal association search criteria

Returns:

page of logged-in-users principal associations

addPermissionSchemeAnonymousUsers

boolean addPermissionSchemeAnonymousUsers(java.lang.String permissionSchemeName,
                                          PrincipalAssociationData principalAssociationData)

Add anonymous-users principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - anonymous-users principal association data (action name)

Returns:

true if anonymous-users principal association was added and false if already in list

deletePermissionSchemeAnonymousUsersLoggedUsers

boolean deletePermissionSchemeAnonymousUsersLoggedUsers(java.lang.String permissionSchemeName,
                                                        PrincipalAssociationData principalAssociationData)

Delete anonymous-users principal association

Parameters:

permissionSchemeName - permission scheme name

principalAssociationData - anonymous-users principal association data (action name)

Returns:

true if anonymous-users principal association was deleted and false if not in list

create

void create(PermissionSchemeData permissionSchemeData)

Create permission scheme

Parameters:

permissionSchemeData - permission scheme data

rename

void rename(java.lang.String oldName,
            java.lang.String newName)

Rename permission scheme

Parameters:

oldName - permission scheme old name

newName - permission scheme new name

delete

void delete(java.lang.String name)

Delete permisison scheme. Note: fails if permission scheme used by any project

Parameters:

name - permission scheme name

createFrom

void createFrom(java.lang.String copyFromPermissionSchemeName,
                java.lang.String newPermissionSchemeName)

Creates a permission scheme from an existing permission scheme

Parameters:

copyFromPermissionSchemeName - existing permission scheme name

newPermissionSchemeName - new permission scheme name