com.atlassian.confluence.security
Class ContentPermission

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.security.ContentPermission

All Implemented Interfaces:

Cloneable, Comparable, Serializable

public class ContentPermission

extends ConfluenceEntityObject

implements Comparable

Allows a user to lock content against editing by other users.

Note: the expiry field is currently unused.

See Also:

Serialized Form

Field Summary

static String	EDIT_PERMISSION
static String	VIEW_PERMISSION

Constructor Summary

	ContentPermission() This has to be public because the ReverseDatabinder requires public default constructors.
protected	ContentPermission(String type, String groupName, String userName)

Method Summary

int	compareTo(Object o)
static ContentPermission	createGroupPermission(String type, String groupName)
static ContentPermission	createUserPermission(String type, String userName)
boolean	equals(Object o)
String	getCreatorName() Deprecated. as of 2.4 does not have the same implication as previously for {ContentPermission.
String	getGroup() Deprecated. as of version 2.4. Use getGroupName() instead.
String	getGroupName()
ContentPermissionSet	getOwningSet()
String	getType()
String	getUserName() When isUserPermission() is true, returns the username of the user who is explicitly permitted by this permission.
int	hashCode()
boolean	isGroupPermission()
boolean	isPermitted(User user) Determine if a user is locked out by the permission.
boolean	isUserPermission()
void	setOwningSet(ContentPermissionSet owningSet)
void	setUserAccessor(UserAccessor userAccessor)
String	toString()

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

getLastModifierName, isPersistent, setCreatorName, 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

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

Constructor Detail

ContentPermission

public ContentPermission()

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

ContentPermission

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

Method Detail

createUserPermission

public static ContentPermission createUserPermission(String type,
                                                     String userName)

createGroupPermission

public static ContentPermission createGroupPermission(String type,
                                                      String groupName)

isPermitted

public boolean isPermitted(User user)

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.

isGroupPermission

public boolean isGroupPermission()

isUserPermission

public boolean isUserPermission()

getType

public String getType()

getUserName

public String getUserName()

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

getCreatorName

public String getCreatorName()

Deprecated. as of 2.4 does not have the same implication as previously for {ContentPermission.

Gets the username of the user who created this permission. As of 2.4 this does not return the user explicitly permitted by this user. For a user permission, where isUserPermission() is true, use getUserName() to find the username of the permitted user.

Overrides:

getCreatorName in class ConfluenceEntityObject

Returns:

username of the creator, or null if created anonymously

See Also:

getUserName()

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

getGroupName

public String getGroupName()

getGroup

public String getGroup()

Deprecated. as of version 2.4. Use getGroupName() instead.

getOwningSet

public ContentPermissionSet getOwningSet()

setOwningSet

public void setOwningSet(ContentPermissionSet owningSet)

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

toString

public String toString()

equals

public boolean equals(Object o)

hashCode

public int hashCode()