Package org.apache.guacamole.net.auth

Interface AuthenticatedUser

All Superinterfaces:
Identifiable
All Known Implementing Classes:
AbstractAuthenticatedUser
public interface AuthenticatedUser extends Identifiable
A user of the Guacamole web application who has been authenticated by an AuthenticationProvider.

  • Field Details

    • ANONYMOUS_IDENTIFIER

      static final String ANONYMOUS_IDENTIFIER
      The identifier reserved for representing a user that has authenticated anonymously.
      See Also:

  • Method Details

    • getAuthenticationProvider

      AuthenticationProvider getAuthenticationProvider()
      Returns the AuthenticationProvider that authenticated this user.
      Returns:
      The AuthenticationProvider that authenticated this user.

    • getCredentials

      Credentials getCredentials()
      Returns the credentials that the user provided when they successfully authenticated.
      Returns:
      The credentials provided by the user when they authenticated.

    • getEffectiveUserGroups

      Set<String> getEffectiveUserGroups()
      Returns a read-only set of the identifiers of all user groups which apply to this authenticated user. The exact semantics of what user groups apply are up to the implementation, and the user groups within this set may be implied, derived dynamically, inherited through multiple levels of group membership, etc. Note that, as with user identifiers, user group identifiers form the basis of identity which applies across authentication providers. It is expected that any two user groups having the same identifier represent the same group, even if defined by different authentication providers.
      Returns:
      A read-only set of the identifiers of all user groups which apply to this authenticated user.

    • invalidate

      void invalidate()
      Invalidates this authenticated user and their associated token such that they are no longer logged in. This function will be automatically invoked when the user logs out, or when their session expires.