|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.core.bean.EntityObject com.atlassian.confluence.core.ConfluenceEntityObject com.atlassian.confluence.security.SpacePermission
public class 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.
Field Summary | |
---|---|
static java.lang.String |
ADMINISTER_SPACE_PERMISSION
|
static java.lang.String |
COMMENT_PERMISSION
|
static java.lang.String |
CONFLUENCE_ADMINISTRATOR_PERMISSION
Permission type to do anything in Confluence that can't affect the system on which it runs. |
static java.lang.String |
CREATE_ATTACHMENT_PERMISSION
|
static java.lang.String |
CREATE_SPACE_PERMISSION
|
static java.lang.String |
CREATEEDIT_PAGE_PERMISSION
|
static java.lang.String |
EDITBLOG_PERMISSION
|
static java.lang.String |
EXPORT_PAGE_PERMISSION
Deprecated. to be removed. Use VIEWSPACE_PERMISSION instead |
static java.lang.String |
EXPORT_SPACE_PERMISSION
|
static java.lang.String |
FORM_PARAMETER_PREFIX
Deprecated. Since 5.3 Use PermissionsFormHandler.FORM_PARAMETER_PREFIX |
static java.lang.String |
FORM_PARAMETER_SEPARATOR
Deprecated. Since 5.3 Use PermissionsFormHandler.FORM_PARAMETER_SEPARATOR |
static java.lang.String |
FULL_FORM_PARAMETER_PREFIX
Deprecated. Since 5.3 Use PermissionsFormHandler.FULL_FORM_PARAMETER_PREFIX |
static java.util.Collection<java.lang.String> |
GENERIC_SPACE_PERMISSIONS
represents all permissions which can be used to build SpacePermissions. |
static java.util.Collection<java.lang.String> |
GLOBAL_PERMISSIONS
A list of all global permissions |
static java.util.Collection<java.lang.String> |
INVALID_ANONYMOUS_PERMISSIONS
A list of all permissions that can not be assigned to the anonymous user |
static java.util.Collection<java.lang.String> |
PERMISSION_TYPES
A list of all possible permissions |
static java.lang.String |
PERSONAL_SPACE_PERMISSION
|
static java.lang.String |
PROFILE_ATTACHMENT_PERMISSION
|
static java.lang.String |
REMOVE_ATTACHMENT_PERMISSION
|
static java.lang.String |
REMOVE_BLOG_PERMISSION
|
static java.lang.String |
REMOVE_COMMENT_PERMISSION
|
static java.lang.String |
REMOVE_MAIL_PERMISSION
|
static java.lang.String |
REMOVE_PAGE_PERMISSION
|
static java.lang.String |
SET_PAGE_PERMISSIONS_PERMISSION
|
static java.lang.String |
SYSTEM_ADMINISTRATOR_PERMISSION
Permission type to do anything at all in Confluence. |
static java.lang.String |
UPDATE_USER_STATUS_PERMISSION
A permission type to control whether a user can update their user status. |
static java.lang.String |
USE_CONFLUENCE_PERMISSION
|
static java.lang.String |
VIEW_USER_PROFILES_PERMISSION
A permission type to control whether a user can view user profiles within the system. |
static java.lang.String |
VIEWSPACE_PERMISSION
View content within the space, including pages, blogposts etc. |
Constructor Summary | |
---|---|
SpacePermission()
|
|
SpacePermission(SpacePermission spacePermission)
Creates a new SpacePermission with the attributes of another. |
|
SpacePermission(java.lang.String type)
|
|
SpacePermission(java.lang.String type,
Space space)
|
|
SpacePermission(java.lang.String type,
Space space,
java.lang.String group)
|
|
SpacePermission(java.lang.String type,
Space space,
java.lang.String group,
ConfluenceUser subject)
|
|
SpacePermission(java.lang.String type,
Space space,
java.lang.String group,
java.lang.String userName)
Deprecated. since 3.0, as passing both group and userName leads to an invalid permission |
Method Summary | |
---|---|
static SpacePermission |
createAnonymousSpacePermission(java.lang.String type,
Space space)
Deprecated. |
static SpacePermission |
createGroupSpacePermission(java.lang.String type,
Space space,
java.lang.String group)
|
static SpacePermission |
createUserSpacePermission(java.lang.String type,
Space space,
ConfluenceUser subject)
|
static SpacePermission |
createUserSpacePermission(java.lang.String type,
Space space,
java.lang.String userName)
Deprecated. since 5.2. Use createUserSpacePermission(String, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.user.ConfluenceUser)
instead. |
boolean |
equals(java.lang.Object obj)
For CONF-9469 the equals implementation will ignore the case of the permission user name and group name. |
static SpacePermission |
fromFormParameterName(java.lang.String formParameterName,
Space space,
java.lang.String parameterType)
Deprecated. Since 5.3. Use PermissionsFormHandler.fromFormParameterName(String, com.atlassian.confluence.spaces.Space, String) |
static java.util.Collection<SpacePermission> |
getDefaultGlobalPermissions()
Deprecated. since 5.2. Use SpacePermissionManager.getDefaultGlobalPermissions() instead.
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.
By default, confluence-administrators group has admin access, the default users group can view the system
and anonymous access is disabled. |
static java.util.Collection<java.lang.String> |
getGenericSpacePermissions()
Deprecated. since 3.0, why do we even need a getter |
java.lang.String |
getGroup()
|
Space |
getSpace()
The space of this permission. |
long |
getSpaceId()
|
java.lang.String |
getType()
|
java.lang.String |
getUserName()
Deprecated. since 5.2. Use getUserSubject() instead. |
ConfluenceUser |
getUserSubject()
|
int |
hashCode()
|
boolean |
isAnonymousPermission()
|
boolean |
isDependentOn(SpacePermission otherPermission)
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. |
boolean |
isGlobalPermission()
|
boolean |
isGroupPermission()
|
boolean |
isGuardPermission()
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. |
boolean |
isInvalidAnonymousPermission()
Some permissions are not valid as they can not be assigned to the anonymous user. |
boolean |
isSpacePermission()
|
boolean |
isUserPermission()
|
void |
setGroup(java.lang.String group)
|
void |
setSpace(Space space)
|
void |
setType(java.lang.String type)
|
void |
setUserName(java.lang.String userName)
Deprecated. since 5.2. See setUserSubject(ConfluenceUser) instead. |
void |
setUserSubject(ConfluenceUser user)
|
java.lang.String |
toFormParameterName(java.lang.String parameterType)
Deprecated. As of 2.7.2, use PermissionRow.buildParameterName(String, String) . |
java.lang.String |
toString()
|
Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject |
---|
getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName |
Methods inherited from class com.atlassian.core.bean.EntityObject |
---|
clone, getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
@Deprecated public static final java.lang.String FORM_PARAMETER_PREFIX
PermissionsFormHandler.FORM_PARAMETER_PREFIX
@Deprecated public static final java.lang.String FORM_PARAMETER_SEPARATOR
PermissionsFormHandler.FORM_PARAMETER_SEPARATOR
@Deprecated public static final java.lang.String FULL_FORM_PARAMETER_PREFIX
PermissionsFormHandler.FULL_FORM_PARAMETER_PREFIX
public static final java.lang.String USE_CONFLUENCE_PERMISSION
public static final java.lang.String UPDATE_USER_STATUS_PERMISSION
public static final java.lang.String VIEW_USER_PROFILES_PERMISSION
public static final java.lang.String SYSTEM_ADMINISTRATOR_PERMISSION
public static final java.lang.String CONFLUENCE_ADMINISTRATOR_PERMISSION
public static final java.lang.String PERSONAL_SPACE_PERMISSION
public static final java.lang.String CREATE_SPACE_PERMISSION
public static final java.lang.String PROFILE_ATTACHMENT_PERMISSION
public static final java.lang.String VIEWSPACE_PERMISSION
public static final java.lang.String COMMENT_PERMISSION
public static final java.lang.String CREATEEDIT_PAGE_PERMISSION
public static final java.lang.String ADMINISTER_SPACE_PERMISSION
public static final java.lang.String REMOVE_PAGE_PERMISSION
public static final java.lang.String REMOVE_COMMENT_PERMISSION
public static final java.lang.String REMOVE_BLOG_PERMISSION
public static final java.lang.String CREATE_ATTACHMENT_PERMISSION
public static final java.lang.String REMOVE_ATTACHMENT_PERMISSION
public static final java.lang.String EDITBLOG_PERMISSION
@Deprecated public static final java.lang.String EXPORT_PAGE_PERMISSION
public static final java.lang.String EXPORT_SPACE_PERMISSION
public static final java.lang.String REMOVE_MAIL_PERMISSION
public static final java.lang.String SET_PAGE_PERMISSIONS_PERMISSION
public static final java.util.Collection<java.lang.String> PERMISSION_TYPES
public static final java.util.Collection<java.lang.String> GENERIC_SPACE_PERMISSIONS
public static final java.util.Collection<java.lang.String> GLOBAL_PERMISSIONS
public static final java.util.Collection<java.lang.String> INVALID_ANONYMOUS_PERMISSIONS
Constructor Detail |
---|
public SpacePermission()
public SpacePermission(java.lang.String type)
public SpacePermission(java.lang.String type, Space space)
public SpacePermission(java.lang.String type, Space space, java.lang.String group)
@Deprecated public SpacePermission(java.lang.String type, Space space, java.lang.String group, java.lang.String userName)
createUserSpacePermission(String, Space, String)
,
createGroupSpacePermission(String, Space, String)
public SpacePermission(java.lang.String type, Space space, java.lang.String group, ConfluenceUser subject)
public SpacePermission(SpacePermission spacePermission)
ConfluenceEntityObject
state.
spacePermission
- a spacePermission to replicate.Method Detail |
---|
@Deprecated public static SpacePermission fromFormParameterName(java.lang.String formParameterName, Space space, java.lang.String parameterType) throws java.text.ParseException
PermissionsFormHandler.fromFormParameterName(String, com.atlassian.confluence.spaces.Space, String)
java.text.ParseException
public Space getSpace()
public void setSpace(Space space)
public long getSpaceId()
public java.lang.String getType()
public void setType(java.lang.String type)
public java.lang.String getGroup()
public void setGroup(java.lang.String group)
@Deprecated public java.lang.String getUserName()
getUserSubject()
instead.
@Deprecated public void setUserName(java.lang.String userName)
setUserSubject(ConfluenceUser)
instead.
userName
- public ConfluenceUser getUserSubject()
public void setUserSubject(ConfluenceUser user)
public boolean isUserPermission()
public boolean isGroupPermission()
public boolean isAnonymousPermission()
public boolean isGlobalPermission()
public boolean isSpacePermission()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class com.atlassian.core.bean.EntityObject
public int hashCode()
hashCode
in class com.atlassian.core.bean.EntityObject
@Deprecated public static java.util.Collection<java.lang.String> getGenericSpacePermissions()
@Deprecated public static java.util.Collection<SpacePermission> getDefaultGlobalPermissions()
SpacePermissionManager.getDefaultGlobalPermissions()
instead.
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.
By default, confluence-administrators group has admin access, the default users group can view the system
and anonymous access is disabled.
SpacePermission
s.@Deprecated public java.lang.String toFormParameterName(java.lang.String parameterType)
PermissionRow.buildParameterName(String, String)
.
PermissionsFormHandler.fromFormParameterName(java.lang.String, com.atlassian.confluence.spaces.Space, java.lang.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.
public boolean isGuardPermission()
public boolean isDependentOn(SpacePermission otherPermission)
otherPermission
- - permission to check against
public boolean isInvalidAnonymousPermission()
@Deprecated public static SpacePermission createAnonymousSpacePermission(java.lang.String type, Space space)
@Deprecated public static SpacePermission createUserSpacePermission(java.lang.String type, Space space, java.lang.String userName)
createUserSpacePermission(String, com.atlassian.confluence.spaces.Space, com.atlassian.confluence.user.ConfluenceUser)
instead.
public static SpacePermission createUserSpacePermission(java.lang.String type, Space space, ConfluenceUser subject)
public static SpacePermission createGroupSpacePermission(java.lang.String type, Space space, java.lang.String group)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |