com.atlassian.confluence.security.administrators
Class EditSpacePermissionsAdministrator

java.lang.Object
  com.atlassian.confluence.security.administrators.DefaultPermissionsAdministrator
      com.atlassian.confluence.security.administrators.AbstractEditPermissionsAdministrator
          com.atlassian.confluence.security.administrators.EditSpacePermissionsAdministrator

All Implemented Interfaces:

EditPermissionsAdministrator, PermissionsAdministrator

public class EditSpacePermissionsAdministrator
extends AbstractEditPermissionsAdministrator

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.security.administrators.DefaultPermissionsAdministrator

DefaultPermissionsAdministrator.AnonymousPermissionRow, DefaultPermissionsAdministrator.GroupPermissionRow, DefaultPermissionsAdministrator.UserPermissionRow

Field Summary

Fields inherited from class com.atlassian.confluence.security.administrators.AbstractEditPermissionsAdministrator

PARAMETER_PREFIX, remoteUser, searchEntitiesManager, setSpacePermissionChecker, userAccessor

Fields inherited from class com.atlassian.confluence.security.administrators.DefaultPermissionsAdministrator

permissions, spacePermissionManager

Fields inherited from interface com.atlassian.confluence.security.administrators.EditPermissionsAdministrator

MAX_ENTRIES

Constructor Summary

protected	EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager, PermissionResolver permissionResolver, SetSpacePermissionChecker setSpacePermissionChecker, SearchEntitiesManager searchEntitiesManager) Deprecated. since 5.3. Use EditSpacePermissionsAdministrator(com.atlassian.confluence.security.SpacePermissionManager, PermissionResolver, com.atlassian.confluence.security.SetSpacePermissionChecker, com.atlassian.confluence.user.SearchEntitiesManager, com.atlassian.confluence.user.UserAccessor)
protected	EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager, PermissionResolver permissionResolver, SetSpacePermissionChecker setSpacePermissionChecker, SearchEntitiesManager searchEntitiesManager, SettingsManager settingsManager) Deprecated. since 5.1. Use EditSpacePermissionsAdministrator(com.atlassian.confluence.security.SpacePermissionManager, PermissionResolver, com.atlassian.confluence.security.SetSpacePermissionChecker, com.atlassian.confluence.user.SearchEntitiesManager, com.atlassian.confluence.user.UserAccessor)
protected	EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager, PermissionResolver permissionResolver, SetSpacePermissionChecker setSpacePermissionChecker, SearchEntitiesManager searchEntitiesManager, UserAccessor userAccessor)

Method Summary

void	addPermission(SpacePermission permissionToAdd) Adds the given permission if the current user has permission to do so, otherwise does nothing silently.
java.util.Collection<SpacePermission>	buildPermissionsFromWebForm(java.util.Map formParameters, java.lang.String parameterQualifier) Given a map containing the web form parameters from a permissions edit, return the list of global permissions that are represented by the form
SpacePermission	createGroupGuardPermission(java.lang.String guardPermission, java.lang.String groupName) Creates the relevant guard permission for the group
SpacePermission	createUserGuardPermission(java.lang.String guardPermission, ConfluenceUser user) Creates the relevant guard permission for the user
SpacePermission	createUserGuardPermission(java.lang.String guardPermission, java.lang.String userName) Deprecated.
java.lang.String	getAdministrativePermissionType() Returns the top level permission type applicable to the current scope.
java.util.Collection<SpacePermission>	getInitialPermissionsFromForm(java.util.Map requestParams) Retrieve the permissions initial state
java.util.Collection<SpacePermission>	getRequestedPermissionsFromForm(java.util.Map requestParams) Retrieve the state of the permissions requested by the user
void	removeAllPermissions(java.util.Set<SpacePermission> permissionsToRemove) Removes the given set of permissions if the current user has permission to do so, otherwise does nothing silently.
void	setSpace(Space space)

Methods inherited from class com.atlassian.confluence.security.administrators.AbstractEditPermissionsAdministrator

addAllPermissions, addGuardPermissionToGroups, addGuardPermissionToUsers, applyPermissionChanges, buildPermissionsFromWebForm, canAddPermission, denyAnonymousPermissions, getNumOfGroupEntries, getNumOfUserEntries, isGroupsToAddEmpty, isGroupsToAddTooLarge, isRemoveAllAdminPermissions, isUsersToAddEmpty, isUsersToAddTooLarge, removePermission, setGroupsToAdd, setRemoteUser, setUsersToAdd, splitPermissions

Methods inherited from class com.atlassian.confluence.security.administrators.DefaultPermissionsAdministrator

buildAnonymousPermissionRow, buildGroupPermissionTable, buildUserPermissionTable, getPermissions, resetPermissions

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.security.administrators.PermissionsAdministrator

buildAnonymousPermissionRow, buildGroupPermissionTable, buildUserPermissionTable, getPermissions

Constructor Detail

EditSpacePermissionsAdministrator

@Deprecated
protected EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager,
                                                       PermissionResolver permissionResolver,
                                                       SetSpacePermissionChecker setSpacePermissionChecker,
                                                       SearchEntitiesManager searchEntitiesManager,
                                                       SettingsManager settingsManager)

Deprecated. since 5.1. Use EditSpacePermissionsAdministrator(com.atlassian.confluence.security.SpacePermissionManager, PermissionResolver, com.atlassian.confluence.security.SetSpacePermissionChecker, com.atlassian.confluence.user.SearchEntitiesManager, com.atlassian.confluence.user.UserAccessor)

EditSpacePermissionsAdministrator

@Deprecated
protected EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager,
                                                       PermissionResolver permissionResolver,
                                                       SetSpacePermissionChecker setSpacePermissionChecker,
                                                       SearchEntitiesManager searchEntitiesManager)

Deprecated. since 5.3. Use EditSpacePermissionsAdministrator(com.atlassian.confluence.security.SpacePermissionManager, PermissionResolver, com.atlassian.confluence.security.SetSpacePermissionChecker, com.atlassian.confluence.user.SearchEntitiesManager, com.atlassian.confluence.user.UserAccessor)

EditSpacePermissionsAdministrator

protected EditSpacePermissionsAdministrator(SpacePermissionManager spacePermissionManager,
                                            PermissionResolver permissionResolver,
                                            SetSpacePermissionChecker setSpacePermissionChecker,
                                            SearchEntitiesManager searchEntitiesManager,
                                            UserAccessor userAccessor)

Method Detail

getAdministrativePermissionType

public java.lang.String getAdministrativePermissionType()

Description copied from interface: EditPermissionsAdministrator

Returns the top level permission type applicable to the current scope. That is, the permission that must exist at least once per space, or globally.

Returns:

top level permission type

removeAllPermissions

public void removeAllPermissions(java.util.Set<SpacePermission> permissionsToRemove)

Description copied from class: AbstractEditPermissionsAdministrator

Removes the given set of permissions if the current user has permission to do so, otherwise does nothing silently.

Specified by:

removeAllPermissions in interface EditPermissionsAdministrator

Overrides:

removeAllPermissions in class AbstractEditPermissionsAdministrator

Parameters:

permissionsToRemove - the permission you want rid of.

addPermission

public void addPermission(SpacePermission permissionToAdd)

Description copied from interface: EditPermissionsAdministrator

Adds the given permission if the current user has permission to do so, otherwise does nothing silently.

Parameters:

permissionToAdd - the permission you want rid of.

createUserGuardPermission

@Deprecated
public SpacePermission createUserGuardPermission(java.lang.String guardPermission,
                                                            java.lang.String userName)

Deprecated.

Description copied from interface: EditPermissionsAdministrator

Creates the relevant guard permission for the user

Parameters:

guardPermission - - the name of the guard permission to create

userName - - name of the user to add the permission to

Returns:

spacepermission object for the user

createUserGuardPermission

public SpacePermission createUserGuardPermission(java.lang.String guardPermission,
                                                 ConfluenceUser user)

Description copied from interface: EditPermissionsAdministrator

Creates the relevant guard permission for the user

Parameters:

guardPermission - - the name of the guard permission to create

user - - name of the user to add the permission to

Returns:

spacepermission object for the user

createGroupGuardPermission

public SpacePermission createGroupGuardPermission(java.lang.String guardPermission,
                                                  java.lang.String groupName)

Description copied from interface: EditPermissionsAdministrator

Creates the relevant guard permission for the group

Parameters:

guardPermission - - the name of the guard permission to create

groupName - - name of group to add the permission to

Returns:

spacepermission object for the user

getInitialPermissionsFromForm

public java.util.Collection<SpacePermission> getInitialPermissionsFromForm(java.util.Map requestParams)

Description copied from interface: EditPermissionsAdministrator

Retrieve the permissions initial state

Returns:

initial state

getRequestedPermissionsFromForm

public java.util.Collection<SpacePermission> getRequestedPermissionsFromForm(java.util.Map requestParams)

Description copied from interface: EditPermissionsAdministrator

Retrieve the state of the permissions requested by the user

Returns:

requested state

buildPermissionsFromWebForm

public java.util.Collection<SpacePermission> buildPermissionsFromWebForm(java.util.Map formParameters,
                                                                         java.lang.String parameterQualifier)

Description copied from interface: EditPermissionsAdministrator

Given a map containing the web form parameters from a permissions edit, return the list of global permissions that are represented by the form

Parameters:

formParameters - the map of form parameters

parameterQualifier - distinguishes the set of parameters from other sets of parameters used to represent permissions in the same form.

Returns:

a list of the permissions in the form

setSpace

public void setSpace(Space space)