java.lang.Object | |||
↳ | com.atlassian.core.bean.EntityObject | ||
↳ | com.atlassian.confluence.core.ConfluenceEntityObject | ||
↳ | com.atlassian.confluence.security.SpacePermission |
A SpacePermission restricts access to different functions on a space. A a SpacePermission is defined for a permissionType then that permissionType is not permitted, otherwise if it's not it's permitted.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GENERIC_SPACE_PERMISSIONS | represents all permissions which can be used to build SpacePermissions. | ||||||||||
GLOBAL_PERMISSIONS | A list of all global permissions | ||||||||||
INVALID_ANONYMOUS_PERMISSIONS | A list of all permissions that can not be assigned to the anonymous user | ||||||||||
PERMISSION_TYPES | A list of all possible permissions |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This constructor is deprecated.
since 3.0, as passing both group and userName leads to an invalid permission
| |||||||||||
Creates a new SpacePermission with the attributes of another.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
For CONF-9469 the equals implementation will ignore the case of the permission user name and group name.
| |||||||||||
Convert a form parameter name into a space permission.
| |||||||||||
Returns the default global permissions that are created when Confluence is set up.
| |||||||||||
This method is deprecated.
since 3.0, why do we even need a getter
| |||||||||||
The space of this permission.
| |||||||||||
This method is deprecated.
since Confluence 2.7. Not used in Confluence core at the moment.
| |||||||||||
One permission is dependent on another if the other permission is a guard permission that applies to the same
space/global scope, and to the same group or user as this permission.
| |||||||||||
Is this a guard permission, either globally or at the space level? Guard permissions are required
before any more permissions can be added for a particular user/group in a particular scope.
| |||||||||||
Some permissions are not valid as they can not be assigned to the anonymous user.
| |||||||||||
This method is deprecated.
As of 2.7.2, use
buildParameterName(String, String) .
| |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.atlassian.confluence.core.ConfluenceEntityObject
| |||||||||||
From class
com.atlassian.core.bean.EntityObject
| |||||||||||
From class
java.lang.Object
|
Permission type to do anything in Confluence that can't affect the system on which it runs. Users with this permission should be allowed to perform most administration tasks but not install plugins or write macros.
Permission type to do anything at all in Confluence. Users with this permission should be allowed to do virtually anything in Confluence. All actions should check for this permission.
A permission type to control whether a user can update their user status.
View content within the space, including pages, blogposts etc.
A permission type to control whether a user can view user profiles within the system. This only applies to the anonymous user.
represents all permissions which can be used to build SpacePermissions.
A list of all permissions that can not be assigned to the anonymous user
This constructor is deprecated.
since 3.0, as passing both group and userName leads to an invalid permission
Creates a new SpacePermission with the attributes of another. Does not copy the
id, or other ConfluenceEntityObject
state.
spacePermission | a spacePermission to replicate. |
---|
For CONF-9469 the equals implementation will ignore the case of the permission user name and group name. Confluence is supposed to be case insensitive with regard to username and group names.
Convert a form parameter name into a space permission. The form parameter name should have been generated
from toFormParameterName(String)
.
formParameterName | the form parameter name to convert to a space permission |
---|---|
space | the space the permission applies to, or null if it is a global permission |
parameterType | distinguishes the parameter from other parameters created with the same permission. Makes little difference to this method. |
ParseException | if the form parameter name can not be converted to a permission type |
---|
Returns the default global permissions that are created when Confluence is set up. These will exist in a newly set up system but may be removed afterwards. Note that the returned objects are freshly created and therefore do not have IDs or other persistence data.
SpacePermission
s.
This method is deprecated.
since 3.0, why do we even need a getter
This method is deprecated.
since Confluence 2.7. Not used in Confluence core at the moment.
Is this an administrative permission either globally or at a space level? The previous use of this method
was to list the top level permission either globally or at space level. At least one top level permission is
required globally and for each space to ensure that somebody can administer it. That method could no longer be
called isAdministrativePermission
because CONFLUENCE_ADMINISTRATOR_PERMISSION
is
clearly an administrative permission, but not one that is required.
One permission is dependent on another if the other permission is a guard permission that applies to the same space/global scope, and to the same group or user as this permission. It is used when determining which permissions should be removed as the result of removing a guard permission.
otherPermission | - permission to check against |
---|
Is this a guard permission, either globally or at the space level? Guard permissions are required before any more permissions can be added for a particular user/group in a particular scope. Globally, USE_CONFLUENCE is a guard permission, at the space level, VIEWSPACE is theguard.
Some permissions are not valid as they can not be assigned to the anonymous user. Really, we should just refuse to create such permissions from the outset, but for now we've just got this check.
This method is deprecated.
As of 2.7.2, use buildParameterName(String, String)
.
Convert the space permission into a form parameter name that can be used for form checkboxes. The reverse
of this method is fromFormParameterName(String, Space, String)
The format of the parameter name is:
confluence_[parameterType]_[permissionType]_[user/group/anonymous]_[user/group name]
Note: the space is NOT encoded in the form parameter name, and must be kept separately.
parameterType | distinguishes the parameter from other parameters created with the same permission. |
---|