Interface AnonymousUserPermissionsService

All Known Implementing Classes:
DefaultAnonymousUserPermissionsService

public interface AnonymousUserPermissionsService
A service for managing permissions for the anonymous Confluence user.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setUsePermission(boolean enabled)
    Set the 'use confluence' permission for the anonymous Confluence user.
    void
    Set the 'view user profiles' permission for the anonymous Confluence user.
  • Method Details

    • setUsePermission

      void setUsePermission(boolean enabled)

      Set the 'use confluence' permission for the anonymous Confluence user.

      Note: This is the guard permission for any other anonymous user permissions. If this one is removed then any others will be too.

      Parameters:
      enabled - if true then allow the anonymous user 'use' permission; otherwise disallow.
      Throws:
      NotAuthorizedException - if the current user does not have the authority to change the anonymous user permissions.
    • setViewUserProfilesPermission

      void setViewUserProfilesPermission(boolean enabled)
      Set the 'view user profiles' permission for the anonymous Confluence user.
      Parameters:
      enabled - if true then assign the permission; otherwise remove it.
      Throws:
      NotAuthorizedException - if the current user does not have the authority to change the anonymous user permissions.
      IllegalPermissionStateException - if the guard permission (Use) has not first been set for the anonymous user.