Interface AccessStatus
public interface AccessStatus
Represents the type of access to Confluence a user has. A user can either be:
- A licensed user (full Confluence access)
- A logged in unlicensed user (limited Confluence access)
- An anonymous user with anonymous access enabled
- Not permitted (everything else)
Note: if a user has one type of access, it does not necessarily imply they have others, for example, hasLicensedAccess()
and hasUnlicensedAuthenticatedAccess()
cannot both be true.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
A user (logged in or anonymous) may have access to Confluence if they have been grantedSpacePermission.USE_CONFLUENCE_PERMISSION
orSpacePermission.LIMITED_USE_CONFLUENCE_PERMISSION
permission.boolean
boolean
boolean
-
Method Details
-
hasLicensedAccess
boolean hasLicensedAccess()- Returns:
- true if the user is logged in and has licensed access to Confluence (has
SpacePermission.USE_CONFLUENCE_PERMISSION
).
-
hasUnlicensedAuthenticatedAccess
boolean hasUnlicensedAuthenticatedAccess()- Returns:
- true if the user is logged in and has been granted unlicensed access to Confluence.
-
hasAnonymousAccess
boolean hasAnonymousAccess()- Returns:
- true if the user is anonymous (or null) and has anonymous access to Confluence (not consuming a Confluence license).
-
canUseConfluence
boolean canUseConfluence()A user (logged in or anonymous) may have access to Confluence if they have been grantedSpacePermission.USE_CONFLUENCE_PERMISSION
orSpacePermission.LIMITED_USE_CONFLUENCE_PERMISSION
permission.This will be true for both users with licensed access to Confluence and for visitors (users with limited access).
To check if a user also has licensed Confluence access, use
hasLicensedAccess()
instead.- Returns:
- true if the user (or anonymous) has been granted
SpacePermission.USE_CONFLUENCE_PERMISSION
orSpacePermission.LIMITED_USE_CONFLUENCE_PERMISSION
.
-