IdentifiedUser (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.CurrentUser
- - com.google.gerrit.server.IdentifiedUser

public class IdentifiedUser
extends CurrentUser

An authenticated user.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IdentifiedUser.GenericFactory` Create an IdentifiedUser, ignoring any per-request state.
`static class`	`IdentifiedUser.RequestFactory` Create an IdentifiedUser, relying on current request state.

Nested classes/interfaces inherited from class com.google.gerrit.server.CurrentUser
CurrentUser.PropertyKey<T>

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifiedUser`	`asIdentifiedUser()` Cast to IdentifiedUser if possible.
`<T> T`	`get(CurrentUser.PropertyKey<T> key)` Lookup a previously stored property.
`com.google.gerrit.reviewdb.client.Account`	`getAccount()`
`com.google.gerrit.reviewdb.client.Account.Id`	`getAccountId()` Return account ID if `CurrentUser.isIdentifiedUser()` is true.
`GroupMembership`	`getEffectiveGroups()` Get the set of groups the user is currently a member of.
`java.util.Set<java.lang.String>`	`getEmailAddresses()`
`java.lang.String`	`getName()`
`java.lang.String`	`getNameEmail()`
`CurrentUser`	`getRealUser()` Identity of the authenticated user.
`java.lang.String`	`getUserName()` Unique name of the user on this server, if one has been assigned.
`boolean`	`hasEmailAddress(java.lang.String email)`
`boolean`	`isIdentifiedUser()` Check if user is the IdentifiedUser
`org.eclipse.jgit.lib.PersonIdent`	`newCommitterIdent(java.util.Date when, java.util.TimeZone tz)`
`org.eclipse.jgit.lib.PersonIdent`	`newRefLogIdent()`
`org.eclipse.jgit.lib.PersonIdent`	`newRefLogIdent(java.util.Date when, java.util.TimeZone tz)`
`<T> void`	`put(CurrentUser.PropertyKey<T> key, T value)` Store a property for later retrieval.
`AccountState`	`state()`
`java.lang.String`	`toString()`

Methods inherited from class com.google.gerrit.server.CurrentUser
getAccessPath, getCapabilities, isInternalUser, setAccessPath

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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()
```
  - asIdentifiedUser
```
public IdentifiedUser asIdentifiedUser()
```
    Description copied from class: CurrentUser
    
    Cast to IdentifiedUser if possible.
    
    Overrides:
    
    asIdentifiedUser in class CurrentUser
  - getAccountId
```
public com.google.gerrit.reviewdb.client.Account.Id getAccountId()
```
    Description copied from class: CurrentUser
    
    Return account ID if CurrentUser.isIdentifiedUser() is true.
    
    Overrides:
    
    getAccountId in class CurrentUser
  - getUserName
```
public java.lang.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.
  - getAccount
```
public com.google.gerrit.reviewdb.client.Account getAccount()
```
  - hasEmailAddress
```
public boolean hasEmailAddress(java.lang.String email)
```
  - getEmailAddresses
```
public java.util.Set<java.lang.String> getEmailAddresses()
```
  - getName
```
public java.lang.String getName()
```
  - getNameEmail
```
public java.lang.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.
  - newRefLogIdent
```
public org.eclipse.jgit.lib.PersonIdent newRefLogIdent()
```
  - newRefLogIdent
```
public org.eclipse.jgit.lib.PersonIdent newRefLogIdent(java.util.Date when,
                                              java.util.TimeZone tz)
```
  - newCommitterIdent
```
public org.eclipse.jgit.lib.PersonIdent newCommitterIdent(java.util.Date when,
                                                 java.util.TimeZone tz)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isIdentifiedUser
```
public boolean isIdentifiedUser()
```
    Check if user is the IdentifiedUser
    
    Overrides:
    
    isIdentifiedUser in class CurrentUser
  - get
```
public <T> 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 null.
  - 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.

Class IdentifiedUser

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.CurrentUser

Method Summary

Methods inherited from class com.google.gerrit.server.CurrentUser

Methods inherited from class java.lang.Object

Method Detail

getRealUser

state

asIdentifiedUser

getAccountId

getUserName

getAccount

hasEmailAddress

getEmailAddresses

getName

getNameEmail

getEffectiveGroups

newRefLogIdent

newRefLogIdent

newCommitterIdent

toString

isIdentifiedUser

get

put