public abstract class CurrentUser extends Object
This is a RequestScoped
property managed by Guice.
AnonymousUser
,
IdentifiedUser
Modifier and Type | Class and Description |
---|---|
static class |
CurrentUser.PropertyKey<T>
Unique key for plugin/extension specific data on a CurrentUser.
|
Modifier | Constructor and Description |
---|---|
protected |
CurrentUser(CapabilityControl.Factory capabilityControlFactory) |
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.
|
AccessPath |
getAccessPath()
How this user is accessing the Gerrit Code Review application.
|
com.google.gerrit.reviewdb.client.Account.Id |
getAccountId()
Return account ID if
isIdentifiedUser() is true. |
CapabilityControl |
getCapabilities()
Capabilities available to this user account.
|
abstract GroupMembership |
getEffectiveGroups()
Get the set of groups the user is currently a member of.
|
CurrentUser |
getRealUser()
Identity of the authenticated user.
|
String |
getUserName()
Unique name of the user on this server, if one has been assigned.
|
boolean |
isIdentifiedUser()
Check if user is the IdentifiedUser
|
boolean |
isInternalUser()
Check if the CurrentUser is an InternalUser.
|
<T> void |
put(CurrentUser.PropertyKey<T> key,
T value)
Store a property for later retrieval.
|
void |
setAccessPath(AccessPath path) |
protected CurrentUser(CapabilityControl.Factory capabilityControlFactory)
public final AccessPath getAccessPath()
public void setAccessPath(AccessPath path)
public CurrentUser getRealUser()
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.
public abstract GroupMembership getEffectiveGroups()
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.
public String getUserName()
public CapabilityControl getCapabilities()
public boolean isIdentifiedUser()
public IdentifiedUser asIdentifiedUser()
public com.google.gerrit.reviewdb.client.Account.Id getAccountId()
isIdentifiedUser()
is true.public boolean isInternalUser()
public <T> T get(CurrentUser.PropertyKey<T> key)
key
- unique property key.null
.public <T> void put(CurrentUser.PropertyKey<T> key, T value)
key
- unique property key.value
- value to store; or null
to clear the value.