com.atlassian.confluence.security

Interface PermissionDelegate<TARGET>

All Known Implementing Classes:

AbstractPermissionsDelegate, ApplicationPermissionsDelegate, AttachmentPermissionsDelegate, BlogPostPermissionsDelegate, CommentPermissionsDelegate, DraftPermissionsDelegate, DummyPermissionDelegate, GlobalDescriptionPermissionsDelegate, GroupPermissionsDelegate, JsonPropertyPermissionDelegate, LabellingPermissionsDelegate, LinkPermissionsDelegate, MailPermissionsDelegate, PagePermissionsDelegate, PageTemplatePermissionsDelegate, PeopleDirectoryPermissionsDelegate, PersonalInformationPermissionsDelegate, SharedAccessInterceptor, SpaceDescriptionPermissionsDelegate, SpacePermissionsDelegate, StatusPermissionDelegate, SystemPermissionsDelegate, TargetToLatestVersionDecorator, UserPermissionsDelegate

public interface PermissionDelegate<TARGET>

Each type of target that can have permissions checked against it will have a delegate. The delegate's job is to separate out the different permissions checks in a cleaner, more maintainable fashion.

These delegates on check content access according to the permissions set. If you need to verify other restrictions that are context dependant like ContentEntityObject.SHARE_ID make sure you put them in the corresponding places.

Method Summary

Modifier and Type	Method and Description
boolean	canAdminister(com.atlassian.user.User user, TARGET target)
boolean	canCreate(com.atlassian.user.User user, Object container)
boolean	canCreateInTarget(com.atlassian.user.User user, Class typeToCreate)
boolean	canEdit(com.atlassian.user.User user, TARGET target)
boolean	canExport(com.atlassian.user.User user, TARGET target)
default boolean	canMove(com.atlassian.user.User user, TARGET source, Object target, String movePoint)
boolean	canRemove(com.atlassian.user.User user, TARGET target)
default boolean	canRemoveHierarchy(com.atlassian.user.User user, TARGET target)
boolean	canSetPermissions(com.atlassian.user.User user, TARGET target)
boolean	canView(com.atlassian.user.User user)
boolean	canView(com.atlassian.user.User user, TARGET target)

Method Detail

canView

boolean canView(com.atlassian.user.User user,
                TARGET target)

Returns:

true if user can view the specified target.

canView

boolean canView(com.atlassian.user.User user)

Returns:

true if the user can view all instances of targets handled by this permission delegate

canEdit

boolean canEdit(com.atlassian.user.User user,
                TARGET target)

canSetPermissions

boolean canSetPermissions(com.atlassian.user.User user,
                          TARGET target)

canRemove

boolean canRemove(com.atlassian.user.User user,
                  TARGET target)

canMove

default boolean canMove(com.atlassian.user.User user,
                        TARGET source,
                        Object target,
                        String movePoint)

canRemoveHierarchy

default boolean canRemoveHierarchy(com.atlassian.user.User user,
                                   TARGET target)

canExport

boolean canExport(com.atlassian.user.User user,
                  TARGET target)

canAdminister

boolean canAdminister(com.atlassian.user.User user,
                      TARGET target)

canCreate

boolean canCreate(com.atlassian.user.User user,
                  Object container)

Returns:

true if the specified user can create new instances of the target type in the specified container.

canCreateInTarget

boolean canCreateInTarget(com.atlassian.user.User user,
                          Class typeToCreate)

Parameters:

user - the user performing the create

typeToCreate - the class of the entity to create

Returns:

true if the specified user can create new instances of the specified typeToCreate within instances of target handled by this PermissionDelegate.