Package com.google.gerrit.server

Class IdentifiedUser

  • public class IdentifiedUser
extends CurrentUser
    An authenticated user.

    • Method Detail

      • getRealUser

        public CurrentUser getRealUser()
        Description copied from class: CurrentUser
        Identity of the authenticated user.

        In the normal case where a user authenticates as themselves getRealUser() == this.

        If X-Gerrit-RunAs or suexec was used this method returns the identity of the account that has permission to act on behalf of this user.

        Overrides:
        getRealUser in class CurrentUser

      • state

        public AccountState state()
        Returns the account state of the identified user.
        Returns:
        the account state of the identified user, an empty account state if the account is missing

      • getUserName

        public Optional<String> getUserName()
        Description copied from class: CurrentUser
        Unique name of the user on this server, if one has been assigned.
        Overrides:
        getUserName in class CurrentUser
        Returns:
        the user's user name; null if one has not been selected/assigned or if the user name is empty.

      • getAccount

        public Account getAccount()
        Returns the account of the identified user.
        Returns:
        the account of the identified user, an empty account if the account is missing

      • hasEmailAddress

        public boolean hasEmailAddress​(String email)

      • getEmailAddresses

        public com.google.common.collect.ImmutableSet<String> getEmailAddresses()

      • getName

        public String getName()

      • getNameEmail

        public String getNameEmail()

      • 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 Object 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

      • newRefLogIdent

        public org.eclipse.jgit.lib.PersonIdent newRefLogIdent()

      • newRefLogIdent

        public org.eclipse.jgit.lib.PersonIdent newRefLogIdent​(Date when,
                                                       TimeZone tz)

      • newCommitterIdent

        public org.eclipse.jgit.lib.PersonIdent newCommitterIdent​(Date when,
                                                          TimeZone tz)

      • isIdentifiedUser

        public boolean isIdentifiedUser()
        Check if user is the IdentifiedUser
        Overrides:
        isIdentifiedUser in class CurrentUser

      • get

        public <T> Optional<T> get​(CurrentUser.PropertyKey<T> key)
        Description copied from class: CurrentUser
        Lookup a previously stored property.
        Overrides:
        get in class CurrentUser
        Parameters:
        key - unique property key.
        Returns:
        previously stored value, or Optional#empty().

      • put

        public <T> void put​(CurrentUser.PropertyKey<T> key,
                    T value)
        Store a property for later retrieval.
        Overrides:
        put in class CurrentUser
        Parameters:
        key - unique property key.
        value - value to store; or null to clear the value.

      • materializedCopy

        public IdentifiedUser materializedCopy()
        Returns a materialized copy of the user with all dependencies.

        Invoke all providers and factories of dependent objects and store the references to a copy of the current identified user.

        Returns:
        copy of the identified user

      • hasSameAccountId

        public boolean hasSameAccountId​(CurrentUser other)
        Description copied from class: CurrentUser
        Checks if the current user has the same account id of another.

        Provide a generic interface for allowing subclasses to define whether two accounts represent the same account id.

        Overrides:
        hasSameAccountId in class CurrentUser
        Parameters:
        other - user to compare
        Returns:
        true if the two users have the same account id