com.atlassian.confluence.security
Class ContentPermission

java.lang.Object
  extended by com.atlassian.core.bean.EntityObject
      extended by com.atlassian.confluence.core.ConfluenceEntityObject
          extended by com.atlassian.confluence.security.ContentPermission
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ContentPermission>

public class ContentPermission
extends ConfluenceEntityObject
implements java.lang.Comparable<ContentPermission>

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

See Also:
Serialized Form

Field Summary
static java.lang.String EDIT_PERMISSION
           
static java.lang.String VIEW_PERMISSION
           
 
Constructor Summary
  ContentPermission()
          This has to be public because the ReflectiveObjectPersister requires public default constructors.
  ContentPermission(ContentPermission other)
          Copy constructor.
protected ContentPermission(java.lang.String type, java.lang.String groupName, ConfluenceUser user)
           
protected ContentPermission(java.lang.String type, java.lang.String groupName, java.lang.String userName)
          Deprecated. Since 5.3 Use ContentPermission(String, String, com.atlassian.confluence.user.ConfluenceUser)
 
Method Summary
 int compareTo(ContentPermission that)
           
static ContentPermission createGroupPermission(java.lang.String type, java.lang.String groupName)
           
static ContentPermission createUserPermission(java.lang.String type, ConfluenceUser user)
           
static ContentPermission createUserPermission(java.lang.String type, java.lang.String userName)
          Deprecated. since 5.2. Use createUserPermission(String, com.atlassian.confluence.user.ConfluenceUser)
 boolean equals(java.lang.Object o)
           
 java.lang.String getGroupName()
           
 ContentPermissionSet getOwningSet()
           
 java.lang.String getType()
           
 java.lang.String getUserName()
          Deprecated. since 5.2. Use getUserSubject() instead.
 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)
          Determine if a user is locked out by the permission.
 boolean isUserPermission()
           
 void setOwningSet(ContentPermissionSet owningSet)
           
 void setSubject(ConfluenceUser subject)
           
 void setUserAccessor(UserAccessor userAccessor)
           
 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

VIEW_PERMISSION

public static final java.lang.String VIEW_PERMISSION
See Also:
Constant Field Values

EDIT_PERMISSION

public static final java.lang.String EDIT_PERMISSION
See Also:
Constant Field Values
Constructor Detail

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(java.lang.String type,
                            java.lang.String groupName,
                            java.lang.String userName)
Deprecated. Since 5.3 Use ContentPermission(String, String, com.atlassian.confluence.user.ConfluenceUser)

Parameters:
type -
groupName -
userName -

ContentPermission

protected ContentPermission(java.lang.String type,
                            java.lang.String groupName,
                            ConfluenceUser user)
Method Detail

createUserPermission

@Deprecated
public static ContentPermission createUserPermission(java.lang.String type,
                                                                java.lang.String userName)
Deprecated. since 5.2. Use createUserPermission(String, com.atlassian.confluence.user.ConfluenceUser)


createUserPermission

public static ContentPermission createUserPermission(java.lang.String type,
                                                     ConfluenceUser user)

createGroupPermission

public static ContentPermission createGroupPermission(java.lang.String type,
                                                      java.lang.String groupName)

isPermitted

public boolean isPermitted(com.atlassian.user.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 java.lang.String getType()

getUserName

@Deprecated
public java.lang.String getUserName()
Deprecated. since 5.2. Use getUserSubject() instead.


setSubject

public void setSubject(ConfluenceUser subject)
Since:
5.2

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)

getUserSubject

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

Since:
5.2

getGroupName

public java.lang.String getGroupName()

getOwningSet

public ContentPermissionSet getOwningSet()

setOwningSet

public void setOwningSet(ContentPermissionSet owningSet)

compareTo

public int compareTo(ContentPermission that)
Specified by:
compareTo in interface java.lang.Comparable<ContentPermission>

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()
Overrides:
hashCode in class com.atlassian.core.bean.EntityObject


Copyright © 2003-2014 Atlassian. All Rights Reserved.