Package com.atlassian.confluence.security.access

Interface ConfluenceAccessManager

All Known Implementing Classes:

CachingConfluenceAccessManager, DefaultConfluenceAccessManager

public interface ConfluenceAccessManager

Determines the access status of a user, which grants them a level of access to Confluence. See AccessStatus for more information.

Note: this should be used instead of checking if a given user has SpacePermission.USE_CONFLUENCE_PERMISSION or SpacePermission.LIMITED_USE_CONFLUENCE_PERMISSION permission.

Method Summary

Modifier and Type	Method	Description
@NonNull AccessStatus	getUserAccessStatus(@Nullable ConfluenceUser user)	Returns the AccessStatus that grants a user a level of access to Confluence.
default @NonNull AccessStatus	getUserAccessStatus(@Nullable com.atlassian.user.User user)	Deprecated. since 8.8 use getUserAccessStatus(ConfluenceUser)
@NonNull AccessStatus	getUserAccessStatusNoExemptions(@Nullable ConfluenceUser user)	Returns the AccessStatus that grants a user a level of access to Confluence.
default @NonNull AccessStatus	getUserAccessStatusNoExemptions(@Nullable com.atlassian.user.User user)	Deprecated. since 8.8 use getUserAccessStatusNoExemptions(ConfluenceUser)

Method Details

getUserAccessStatus

@NonNull AccessStatus getUserAccessStatus(@Nullable ConfluenceUser user)

Returns the AccessStatus that grants a user a level of access to Confluence.

Parameters:

user - the user to retrieve the access status for, or null for anonymous

Returns:

AccessStatus

Since:

8.8

getUserAccessStatus

@Deprecated
default @NonNull AccessStatus getUserAccessStatus(@Nullable com.atlassian.user.User user)

Deprecated.

since 8.8 use getUserAccessStatus(ConfluenceUser)

Returns the AccessStatus that grants a user a level of access to Confluence.

Parameters:

user - the user to retrieve the access status for, or null for anonymous

Returns:

AccessStatus

getUserAccessStatusNoExemptions

@NonNull AccessStatus getUserAccessStatusNoExemptions(@Nullable ConfluenceUser user)

Returns the AccessStatus that grants a user a level of access to Confluence. The same as getUserAccessStatus(com.atlassian.confluence.user.ConfluenceUser) but does not allow exemptions for super-users or other permission exemptions.

Parameters:

user - the user to retrieve the access status for, or null for anonymous

Returns:

AccessStatus

Since:

8.8

getUserAccessStatusNoExemptions

@Deprecated
default @NonNull AccessStatus getUserAccessStatusNoExemptions(@Nullable com.atlassian.user.User user)

Deprecated.

since 8.8 use getUserAccessStatusNoExemptions(ConfluenceUser)

Returns the AccessStatus that grants a user a level of access to Confluence. The same as getUserAccessStatus(com.atlassian.confluence.user.ConfluenceUser) but does not allow exemptions for super-users or other permission exemptions.

Parameters:

user - the user to retrieve the access status for, or null for anonymous

Returns:

AccessStatus