com.google.gerrit.reviewdb.client

Class Account

java.lang.Object

com.google.gerrit.reviewdb.client.Account

public final class Account
extends java.lang.Object

Information about a single user.

A user may have multiple identities they can use to login to Gerrit (see ExternalId), but in such cases they always map back to a single Account entity.

Entities "owned" by an Account (that is, their primary key contains the Account.Id key as part of their key structure):

• ExternalId: OpenID identities and email addresses known to be registered to this user. Multiple records can exist when the user has more than one public identity, such as a work and a personal email address.
• AccountGroupMember: membership of the user in a specific human managed AccountGroup. Multiple records can exist when the user is a member of more than one group.
• AccountSshKey: user's public SSH keys, for authentication through the internal SSH daemon. One record per SSH key uploaded by the user, keys are checked in random order until a match is found.
• DiffPreferencesInfo: user's preferences for rendering side-to-side and unified diff

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Account.Id Key local to Gerrit to identify a user.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Account()
	Account(Account.Id newId, java.sql.Timestamp registeredOn) Create a new account.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getFullName() Get the full name of the user ("Given-name Surname" style).
Account.Id	getId() Get local id of this account, to link with in other entities
java.lang.String	getMetaId()
java.lang.String	getName() Formats an account name.
static java.lang.String	getName(Account.Id accountId)
java.lang.String	getNameEmail(java.lang.String anonymousCowardName) Get the name and email address.
java.lang.String	getPreferredEmail() Email address the user prefers to be contacted through.
java.sql.Timestamp	getRegisteredOn() Get the date and time the user first registered.
java.lang.String	getStatus()
int	hashCode()
static Account.Id	id(int id)
boolean	isActive()
void	setActive(boolean active)
void	setFullName(java.lang.String name) Set the full name of the user ("Given-name Surname" style).
void	setMetaId(java.lang.String metaId)
void	setPreferredEmail(java.lang.String addr) Set the email address the user prefers to be contacted through.
void	setStatus(java.lang.String status)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Account

protected Account()

Account

public Account(Account.Id newId,
               java.sql.Timestamp registeredOn)

Create a new account.

Parameters:

newId - unique id, see Sequences.nextAccountId().

registeredOn - when the account was registered.

Method Detail

id

public static Account.Id id(int id)

getId

public Account.Id getId()

Get local id of this account, to link with in other entities

getFullName

public java.lang.String getFullName()

Get the full name of the user ("Given-name Surname" style).

setFullName

public void setFullName(java.lang.String name)

Set the full name of the user ("Given-name Surname" style).

getPreferredEmail

public java.lang.String getPreferredEmail()

Email address the user prefers to be contacted through.

setPreferredEmail

public void setPreferredEmail(java.lang.String addr)

Set the email address the user prefers to be contacted through.

getName

public java.lang.String getName()

Formats an account name.

The return value goes into NoteDb commits and audit logs, so it should not be changed.

This method deliberately does not use Anonymous Coward because it can be changed using a gerrit.config option which is a problem for NoteDb commits that still refer to a previously defined value.

Returns:

the fullname, if present, otherwise the preferred email, if present, as a last resort a generic string containing the accountId.

getName

public static java.lang.String getName(Account.Id accountId)

getNameEmail

public java.lang.String getNameEmail(java.lang.String anonymousCowardName)

Get the name and email address.

Example output:

• A U. Thor <[email protected]>: full populated
• A U. Thor (12): missing email address
• Anonymous Coward <[email protected]>: missing name
• Anonymous Coward (12): missing name and email address

getRegisteredOn

public java.sql.Timestamp getRegisteredOn()

Get the date and time the user first registered.

getMetaId

public java.lang.String getMetaId()

setMetaId

public void setMetaId(java.lang.String metaId)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getStatus

public java.lang.String getStatus()

setStatus

public void setStatus(java.lang.String status)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object