Package com.atlassian.confluence.security

Class ContentPermission

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.AnnotatedEntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.security.ContentPermission

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ContentPermission>

Direct Known Subclasses:

NeverPermittedContentPermission

public class ContentPermission
extends ConfluenceEntityObject
implements Comparable<ContentPermission>

Allows a user to lock content against editing and/or viewing by other users. This is a DB-level entity (see com/atlassian/confluence/security/ContentPermission.hbm.xml). Directly corresponding equivalent for ServiceLayer would be ContentRestriction

Each Content has as many ContentPermissionSets linked as there are operations restricted for the content. Each ContentPermissionSet has as many ContentPermissions as there are specific users and/or groups to whom corresponding operations are restricted.

See Also:

• ContentRestriction
• ContentRestrictionFactory
• ContentPermissionSet
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDIT_PERMISSION
static final String	EXPORT_PERMISSION
static final String	SHARED_PERMISSION
static final String	VIEW_PERMISSION

Constructor Summary

Constructors

Modifier	Constructor	Description
	ContentPermission()	This has to be public because the ReflectiveObjectPersister requires public default constructors.
	ContentPermission(ContentPermission other)	Copy constructor.
protected	ContentPermission(String type, String groupName, ConfluenceUser user)
protected	ContentPermission(String type, String groupName, String userName)	Deprecated. Since 5.3 Use ContentPermission(String, String, com.atlassian.confluence.user.ConfluenceUser)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ContentPermission that)
static ContentPermission	createGroupPermission(String type, String groupName)
static ContentPermission	createUserPermission(String type, ConfluenceUser user)
static ContentPermission	createUserPermission(String type, String userName)	Deprecated. since 5.2.
boolean	equals(Object o)
String	getGroupName()
ContentPermissionSet	getOwningSet()
String	getType()
String	getUserName()	Deprecated. since 5.2.
ConfluenceUser	getUserSubject()	When isUserPermission() is true, returns the user who is explicitly permitted by this permission.
int	hashCode()
boolean	isGroupPermission()
boolean	isPermitted(com.atlassian.user.User user)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3 use ContentPermissionManager
boolean	isUserPermission()
boolean	isValid()
void	setOwningSet(ContentPermissionSet owningSet)
void	setSubject(ConfluenceUser subject)
String	toString()

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setLastModifier

Methods inherited from class com.atlassian.confluence.core.AnnotatedEntityObject

getCreationDate, getLastModificationDate

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, getCurrentDate, getId, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VIEW_PERMISSION

public static final String VIEW_PERMISSION

See Also:

• Constant Field Values

EDIT_PERMISSION

public static final String EDIT_PERMISSION

See Also:

• Constant Field Values

SHARED_PERMISSION

public static final String SHARED_PERMISSION

See Also:

• Constant Field Values

EXPORT_PERMISSION

public static final String EXPORT_PERMISSION

See Also:

• Constant Field Values

Constructor Details

ContentPermission

public ContentPermission()

This has to be public because the ReflectiveObjectPersister requires public default constructors.

ContentPermission

public ContentPermission(ContentPermission other)

Copy constructor. Does not copy the owning set.

Since:

4.0

ContentPermission

protected ContentPermission(String type,
 String groupName,
 String userName)

Deprecated.

Since 5.3 Use ContentPermission(String, String, com.atlassian.confluence.user.ConfluenceUser)

Parameters:

type -

groupName -

userName -

ContentPermission

protected ContentPermission(String type,
 String groupName,
 ConfluenceUser user)

Method Details

createUserPermission

@Deprecated
public static ContentPermission createUserPermission(String type,
 String userName)

Deprecated.

since 5.2. Use createUserPermission(String, com.atlassian.confluence.user.ConfluenceUser)

createUserPermission

public static ContentPermission createUserPermission(String type,
 ConfluenceUser user)

createGroupPermission

public static ContentPermission createGroupPermission(String type,
 String groupName)

isPermitted

@Deprecated(since="9.3",
            forRemoval=true)
public boolean isPermitted(com.atlassian.user.User user)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.3 use ContentPermissionManager

Determine if a user is locked out by the permission. Note, this does not take into account if the user has a general ability to override a lock (say if they are a global or space-level administrator), lock overrides must be dealt with at a higher level.

content level permissions cannot be granted to anonymous users

Parameters:

user - the user to test against

Returns:

true if the lock would prevent the user from editing content, false otherwise.

isValid

public boolean isValid()

Since:

9.2.6

isGroupPermission

public boolean isGroupPermission()

isUserPermission

public boolean isUserPermission()

getType

public String getType()

getUserName

@Deprecated
public String getUserName()

Deprecated.

since 5.2. Use getUserSubject() instead.

setSubject

public void setSubject(ConfluenceUser subject)

Since:

5.2

getUserSubject

public ConfluenceUser getUserSubject()

When isUserPermission() is true, returns the user who is explicitly permitted by this permission.

Since:

5.2

getGroupName

public String getGroupName()

getOwningSet

public ContentPermissionSet getOwningSet()

setOwningSet

public void setOwningSet(ContentPermissionSet owningSet)

compareTo

public int compareTo(ContentPermission that)

Specified by:

compareTo in interface Comparable<ContentPermission>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class com.atlassian.core.bean.EntityObject