Class InternalUser

  • Direct Known Subclasses:
    PluginUser

    public class InternalUser
    extends CurrentUser
    User identity for plugin code that needs an identity.

    An InternalUser has no real identity, it acts as the server and can access anything it wants, anytime it wants, given the JVM's own direct access to data. Plugins may use this when they need to have a CurrentUser with read permission on anything.

    See Also:
    PluginUser
    • Constructor Detail

      • InternalUser

        public InternalUser()
    • Method Detail

      • getEffectiveGroups

        public GroupMembership getEffectiveGroups()
        Description copied from class: CurrentUser
        Get the set of groups the user is currently a member of.

        The returned set may be a subset of the user's actual groups; if the user's account is currently deemed to be untrusted then the effective group set is only the anonymous and registered user groups. To enable additional groups (and gain their granted permissions) the user must update their account to use only trusted authentication providers.

        Specified by:
        getEffectiveGroups in class CurrentUser
        Returns:
        active groups for this user.
      • getCacheKey

        public String getCacheKey()
        Description copied from class: CurrentUser
        Returns a unique identifier for this user that is intended to be used as a cache key. Returned object should to implement equals() and hashCode() for effective caching.
        Specified by:
        getCacheKey in class CurrentUser
      • isInternalUser

        public boolean isInternalUser()
        Description copied from class: CurrentUser
        Check if the CurrentUser is an InternalUser.
        Overrides:
        isInternalUser in class CurrentUser