com.google.gerrit.server.account

Class AccountResolver

java.lang.Object

com.google.gerrit.server.account.AccountResolver

public class AccountResolver
extends Object

Method Summary

Modifier and Type	Method and Description
Account	find(String input) Locate exactly one account matching the input string.
Set<Account.Id>	findAll(String input) Find all accounts matching the input string.
Set<Account.Id>	findAllByNameOrEmail(String nameOrEmail) Locate exactly one account matching the name or name/email string.
Account	findByNameOrEmail(String nameOrEmail) Locate exactly one account matching the name or name/email string.
IdentifiedUser	parse(String id) Parses a account ID from a request body and returns the user.
IdentifiedUser	parseId(String id) Parses an account ID and returns the user without making any permission check whether the current user can see the account.
IdentifiedUser	parseOnBehalfOf(CurrentUser caller, String id) Like parse(String), but also sets the CurrentUser.getRealUser() on the result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

find

public Account find(String input)
             throws com.google.gwtorm.server.OrmException,
                    IOException,
                    org.eclipse.jgit.errors.ConfigInvalidException

Locate exactly one account matching the input string.

Parameters:

input - a string of the format "Full Name <email@example>", just the email address ("email@example"), a full name ("Full Name"), an account ID ("18419") or a user name ("username").

Returns:

the single account that matches; null if no account matches or there are multiple candidates. If input is a numeric string, returns an account if and only if that number corresponds to an actual account ID.

Throws:

com.google.gwtorm.server.OrmException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

findAll

public Set<Account.Id> findAll(String input)
                        throws com.google.gwtorm.server.OrmException,
                               IOException,
                               org.eclipse.jgit.errors.ConfigInvalidException

Find all accounts matching the input string.

Parameters:

input - a string of the format "Full Name <email@example>", just the email address ("email@example"), a full name ("Full Name"), an account ID ("18419") or a user name ("username").

Returns:

the accounts that match, empty set if none. Never null. If input is a numeric string, returns a singleton set if that number corresponds to a real account ID, and an empty set otherwise if it does not.

Throws:

com.google.gwtorm.server.OrmException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

findByNameOrEmail

public Account findByNameOrEmail(String nameOrEmail)
                          throws com.google.gwtorm.server.OrmException,
                                 IOException

Locate exactly one account matching the name or name/email string.

Parameters:

nameOrEmail - a string of the format "Full Name <email@example>", just the email address ("email@example"), a full name ("Full Name").

Returns:

the single account that matches; null if no account matches or there are multiple candidates.

Throws:

com.google.gwtorm.server.OrmException

IOException

findAllByNameOrEmail

public Set<Account.Id> findAllByNameOrEmail(String nameOrEmail)
                                     throws com.google.gwtorm.server.OrmException,
                                            IOException

Locate exactly one account matching the name or name/email string.

Parameters:

nameOrEmail - a string of the format "Full Name <email@example>", just the email address ("email@example"), a full name ("Full Name").

Returns:

the accounts that match, empty collection if none. Never null.

Throws:

com.google.gwtorm.server.OrmException

IOException

parse

public IdentifiedUser parse(String id)
                     throws AuthException,
                            UnprocessableEntityException,
                            com.google.gwtorm.server.OrmException,
                            IOException,
                            org.eclipse.jgit.errors.ConfigInvalidException

Parses a account ID from a request body and returns the user.

Parameters:

id - ID of the account, can be a string of the format "Full Name <[email protected]>", just the email address, a full name if it is unique, an account ID, a user name or "self" for the calling user

Returns:

the user, never null.

Throws:

UnprocessableEntityException - thrown if the account ID cannot be resolved or if the account is not visible to the calling user

AuthException

com.google.gwtorm.server.OrmException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

parseId

public IdentifiedUser parseId(String id)
                       throws AuthException,
                              com.google.gwtorm.server.OrmException,
                              IOException,
                              org.eclipse.jgit.errors.ConfigInvalidException

Parses an account ID and returns the user without making any permission check whether the current user can see the account.

Parameters:

id - ID of the account, can be a string of the format "Full Name <[email protected]>", just the email address, a full name if it is unique, an account ID, a user name or "self" for the calling user

Returns:

the user, null if no user is found for the given account ID

Throws:

AuthException - thrown if 'self' is used as account ID and the current user is not authenticated

com.google.gwtorm.server.OrmException

org.eclipse.jgit.errors.ConfigInvalidException

IOException

parseOnBehalfOf

public IdentifiedUser parseOnBehalfOf(CurrentUser caller,
                                      String id)
                               throws AuthException,
                                      UnprocessableEntityException,
                                      com.google.gwtorm.server.OrmException,
                                      IOException,
                                      org.eclipse.jgit.errors.ConfigInvalidException

Like parse(String), but also sets the CurrentUser.getRealUser() on the result.

Throws:

AuthException

UnprocessableEntityException

com.google.gwtorm.server.OrmException

IOException

org.eclipse.jgit.errors.ConfigInvalidException