Package com.atlassian.confluence.security

Interface PermissionDelegate<TARGET>

All Known Implementing Classes:

AbstractPermissionsDelegate, ApplicationPermissionsDelegate, AttachmentPermissionsDelegate, BlogPostPermissionsDelegate, CommentPermissionsDelegate, DraftPermissionsDelegate, DummyPermissionDelegate, GlobalDescriptionPermissionsDelegate, GroupPermissionsDelegate, JsonPropertyPermissionDelegate, LabellingPermissionsDelegate, LinkPermissionsDelegate, NoPermissionDelegate, PagePermissionsDelegate, PageTemplatePermissionsDelegate, PeopleDirectoryPermissionsDelegate, PersonalInformationPermissionsDelegate, SharedAccessInterceptor, SpaceDescriptionPermissionsDelegate, SpacePermissionsDelegate, 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	Description
boolean	canAdminister(ConfluenceUser user, TARGET target)
default boolean	canAdminister(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canCreate(ConfluenceUser user, Object container)
default boolean	canCreate(com.atlassian.user.User user, Object container)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8 use canCreate(ConfluenceUser, Object)
boolean	canCreateInTarget(ConfluenceUser user, Class typeToCreate)
default boolean	canCreateInTarget(com.atlassian.user.User user, Class typeToCreate)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8 use canCreateInTarget(ConfluenceUser, Class)
boolean	canEdit(ConfluenceUser user, TARGET target)
default boolean	canEdit(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canExport(ConfluenceUser user, TARGET target)
default boolean	canExport(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
default boolean	canMove(ConfluenceUser user, TARGET source, Object target, String movePoint)
default boolean	canMove(com.atlassian.user.User user, TARGET source, Object target, String movePoint)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canRemove(ConfluenceUser user, TARGET target)
default boolean	canRemove(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
default boolean	canRemoveHierarchy(ConfluenceUser user, TARGET target)
default boolean	canRemoveHierarchy(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canSetPermissions(ConfluenceUser user, TARGET target)
default boolean	canSetPermissions(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canView(ConfluenceUser user)
boolean	canView(ConfluenceUser user, TARGET target)
default boolean	canView(com.atlassian.user.User user)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8 use canView(ConfluenceUser)
default boolean	canView(com.atlassian.user.User user, TARGET target)	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8 use canView(ConfluenceUser, Object)

Method Detail

canView

@Deprecated(forRemoval=true)
default boolean canView(com.atlassian.user.User user,
                        TARGET target)

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

since 8.8 use canView(ConfluenceUser, Object)

Returns:

true if user can view the specified target.

canView

boolean canView(ConfluenceUser user,
                TARGET target)

Returns:

true if user can view the specified target.

Since:

8.8

canView

@Deprecated(forRemoval=true)
default boolean canView(com.atlassian.user.User user)

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

since 8.8 use canView(ConfluenceUser)

Returns:

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

canView

boolean canView(ConfluenceUser user)

Returns:

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

Since:

8.8

canEdit

@Deprecated(forRemoval=true)
default boolean canEdit(com.atlassian.user.User user,
                        TARGET target)

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

Since:

8.8 use canEdit(ConfluenceUser, Object)

canEdit

boolean canEdit(ConfluenceUser user,
                TARGET target)

Since:

8.8

canSetPermissions

@Deprecated(forRemoval=true)
default boolean canSetPermissions(com.atlassian.user.User user,
                                  TARGET target)

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

Since:

8.8 use canSetPermissions(ConfluenceUser, Object)

canSetPermissions

boolean canSetPermissions(ConfluenceUser user,
                          TARGET target)

Since:

8.8

canRemove

@Deprecated(forRemoval=true)
default boolean canRemove(com.atlassian.user.User user,
                          TARGET target)

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

Since:

8.8 use canRemove(ConfluenceUser, Object)

canRemove

boolean canRemove(ConfluenceUser user,
                  TARGET target)

Since:

8.8

canMove

@Deprecated(forRemoval=true)
default boolean canMove(com.atlassian.user.User user,
                        TARGET source,
                        Object target,
                        String movePoint)

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

Since:

8.8 use canMove(ConfluenceUser, Object, Object, String)

canMove

default boolean canMove(ConfluenceUser user,
                        TARGET source,
                        Object target,
                        String movePoint)

Since:

8.8

canRemoveHierarchy

@Deprecated(forRemoval=true)
default boolean canRemoveHierarchy(com.atlassian.user.User user,
                                   TARGET target)

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

Since:

8.8 use canRemoveHierarchy(ConfluenceUser, Object)

canRemoveHierarchy

default boolean canRemoveHierarchy(ConfluenceUser user,
                                   TARGET target)

Since:

8.8

canExport

@Deprecated(forRemoval=true)
default boolean canExport(com.atlassian.user.User user,
                          TARGET target)

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

Since:

8.8 use canExport(ConfluenceUser, Object)

canExport

boolean canExport(ConfluenceUser user,
                  TARGET target)

Since:

8.8

canAdminister

@Deprecated(forRemoval=true)
default boolean canAdminister(com.atlassian.user.User user,
                              TARGET target)

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

Since:

8.8 use canAdminister(ConfluenceUser, Object)

canAdminister

boolean canAdminister(ConfluenceUser user,
                      TARGET target)

Since:

8.8

canCreate

@Deprecated(forRemoval=true)
default boolean canCreate(com.atlassian.user.User user,
                          Object container)

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

since 8.8 use canCreate(ConfluenceUser, Object)

Returns:

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

canCreate

boolean canCreate(ConfluenceUser user,
                  Object container)

Returns:

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

Since:

8.8

canCreateInTarget

@Deprecated(forRemoval=true)
default boolean canCreateInTarget(com.atlassian.user.User user,
                                  Class typeToCreate)

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

since 8.8 use canCreateInTarget(ConfluenceUser, Class)

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.

canCreateInTarget

boolean canCreateInTarget(ConfluenceUser 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.

Since:

8.8